Interface Options

lib/options.ts:7–160

 * documented in options.js
 */
export interface Options extends DeprecatedOptions {
  /**
   * If you want to use a different branch of esprima, or any other module
   * that supports a .parse function, pass that module object to
   * recast.parse as options.parser (legacy synonym: options.esprima).
   * @default require("recast/parsers/esprima")
   */
  parser?: any;

  /**
   * Number of spaces the pretty-printer should use per tab for
   * indentation. If you do not pass this option explicitly, it will be
   * (quite reliably!) inferred from the original code.
   * @default 4
   */
  tabWidth?: number;

  /**
   * If you really want the pretty-printer to use tabs instead of spaces,
   * make this option true.
   * @default false
   */
  useTabs?: boolean;

  /**
   * The reprinting code leaves leading whitespace untouched unless it has
   * to reindent a line, or you pass false for this option.
   * @default true
   */
  reuseWhitespace?: boolean;

  /**
   * Override this option to use a different line terminator, e.g. \r\n.
   * @default require("os").EOL || "\n"
   */
  lineTerminator?: string;

  /**
   * Some of the pretty-printer code (such as that for printing function
   * parameter lists) makes a valiant attempt to prevent really long
   * lines. You can adjust the limit by changing this option; however,
   * there is no guarantee that line length will fit inside this limit.
   * @default 74
   */
  wrapColumn?: number;

  /**
   * Pass a string as options.sourceFileName to recast.parse to tell the
   * reprinter to keep track of reused code so that it can construct a
   * source map automatically.
   * @default null
   */
  sourceFileName?: string | null;

  /**
   * Pass a string as options.sourceMapName to recast.print, and (provided
   * you passed options.sourceFileName earlier) the PrintResult of
   * recast.print will have a .map property for the generated source map.