@babel/parser

The Babel parser (previously Babylon) is a JavaScript parser used in Babel.

• The latest ECMAScript version enabled by default (ES2017).
• Comment attachment.
• Support for JSX, Flow, Typescript.
• Support for experimental language proposals (accepting PRs for anything at least stage-0).

Credits

Heavily based on acorn and acorn-jsx,thanks to the awesome work of @RReverser and @marijnh.

API

babelParser.parse(code, [options])

babelParser.parseExpression(code, [options])

parse() parses the provided code as an entire ECMAScript program, whileparseExpression() tries to parse a single Expression with performance inmind. When in doubt, use .parse().

Options

• allowImportExportEverywhere: By default, import and exportdeclarations can only appear at a program's top level. Setting thisoption to true allows them anywhere where a statement is allowed.

• allowAwaitOutsideFunction: By default, await use is only allowedinside of an async function or, when the topLevelAwait plugin is enabled,in the top-level scope of modules. Set this to true to also accept it in thetop-level scope of scripts.

• allowReturnOutsideFunction: By default, a return statement atthe top level raises an error. Set this to true to accept suchcode.

• allowSuperOutsideMethod: By default, super use is not allowedoutside of class and object methods. Set this to true to accept suchcode.

• allowUndeclaredExports: By default, exporting an identifier that wasnot declared in the current module scope will raise an error. While thisbehavior is required by the ECMAScript modules specification, Babel'sparser cannot anticipate transforms later in the plugin pipeline thatmight insert the appropriate declarations, so it is sometimes importantto set this option to true to prevent the parser from prematurelycomplaining about undeclared exports that will be added later.

• createParenthesizedExpressions: By default, the parser sets extra.parenthesized on the expression nodes. When this option is set to true, ParenthesizedExpression AST nodes are created instead.

• errorRecovery: By default, Babel always throws an error when it finds some invalidcode. When this option is set to true, it will store the parsing error and try to continueparsing the invalid input file.The resulting AST will have an errors property representing an array of all the parsing errors.Note that even when this option is enabled, @babel/parser could throw for unrecoverable errors.

• plugins: Array containing the plugins that you want to enable.

• sourceType: Indicate the mode the code should be parsed in. Can beone of "script", "module", or "unambiguous". Defaults to "script". "unambiguous" will make @babel/parser attempt to guess, based on the presence of ES6 import or export statements. Files with ES6 imports and exports are considered "module" and are otherwise "script".

• sourceFilename: Correlate output AST nodes with their source filename. Useful when generating code and source maps from the ASTs of multiple input files.

• startLine: By default, the first line of code parsed is treated as line 1. You can provide a line number to alternatively start with. Useful for integration with other source tools.

• strictMode: By default, ECMAScript code is parsed as strict only if a"use strict"; directive is present or if the parsed file is an ECMAScriptmodule. Set this option to true to always parse files in strict mode.

• ranges: Adds a range property to each node: [node.start, node.end]

• tokens: Adds all parsed tokens to a tokens property on the File node

Output

The Babel parser generates AST according to Babel AST format.It is based on ESTree spec with the following deviations:

There is now an estree plugin which reverts these deviations

• Literal token is replaced with StringLiteral, NumericLiteral, BooleanLiteral, NullLiteral, RegExpLiteral
• Property token is replaced with ObjectProperty and ObjectMethod
• MethodDefinition is replaced with ClassMethod
• Program and BlockStatement contain additional directives field with Directive and DirectiveLiteral
• ClassMethod, ObjectProperty, and ObjectMethod value property's properties in FunctionExpression is coerced/brought into the main method node.

AST for JSX code is based on Facebook JSX AST.

Semver

The Babel Parser follows semver in most situations. The only thing to note is that some spec-compliancy bug fixes may be released under patch versions.

For example: We push a fix to early error on something like #107 - multiple default exports per file. That would be considered a bug fix even though it would cause a build to fail.

Example

require("@babel/parser").parse("code", {
  // parse in strict mode and allow module declarations
  sourceType: "module",
  plugins: [
    // enable jsx and flow syntax
    "jsx",
    "flow"
  ]
});

Plugins

Miscellaneous

Language extensions

ECMAScript proposals

Plugins options

NOTE: When a plugin is specified multiple times, only the first options are considered.

• decorators:

  • decoratorsBeforeExport (boolean)

// decoratorsBeforeExport: true
@dec
export class C {}
// decoratorsBeforeExport: false
export @dec class C {}

• pipelineOperator:

  • proposal (required, accepted values: minimal, smart)There are different proposals for the pipeline operator. This optionallows to choose which one to use.See What's Happening With the Pipeline (|>) Proposal? for more information.

• flow:

  • all (boolean, default: false)Some code has different meaning in Flow and in vanilla JavaScript. For example, foo<T>(x) is parsed as a call expression with a type argument in Flow, but as a comparison (foo < T > x) accordingly to the ECMAScript specification. By default, babel-parser parses those ambiguous constructs as Flow types only if the file starts with a // @flow pragma.Set this option to true to always parse files as if // @flow was specified.

FAQ

Will the Babel parser support a plugin system?

Previous issues: #1351, #6694.

We currently aren't willing to commit to supporting the API for plugins or the resulting ecosystem (there is already enough work maintaining Babel's own plugin system). It's not clear how to make that API effective, and it would limit our ability to refactor and optimize the codebase.

Our current recommendation for those that want to create their own custom syntax is for users to fork the parser.

To consume your custom parser, you can add a plugin to your options to call the parser via its npm package name or require it if using JavaScript,

const parse = require("custom-fork-of-babel-parser-on-npm-here");
module.exports = {
  plugins: [{
    parserOverride(code, opts) {
      return parse(code, opts);
    },
  }]
}