esast (and estree) utility to parse trees from JavaScript.

• What is this?
• When should I use this?
• Install
• Use
• API
  • fromJs(value[, options])
  • Options
  • Plugin
  • Value
  • Version
• Types
• Compatibility
• Contribute
• License

This package is a utility that turns a string of JavaScript into an esast (estree with some extra cleanliness) syntax tree.

You can use this utility when you want to deal with ASTs of JavaScript combined with other unist and vfile things. You can use acorn itself if you don’t care about unified.

The utility estree-util-to-js does the inverse of this utility. It turns the tree into a string of JavaScript.

This package is ESM only. In Node.js (version 14.14+ and 16.0+), install with npm:

npm install esast-util-from-js

In Deno with esm.sh:

import {fromJs} from 'https://esm.sh/esast-util-from-js@1'

In browsers with esm.sh:

<script type="module">
  import {fromJs} from 'https://esm.sh/esast-util-from-js@1?bundle'
</script>

import fs from 'node:fs/promises'
import {fromJs} from 'esast-util-from-js'

const tree = fromJs(await fs.readFile('example.js'), {module: true})

console.log(tree)

Yields:

{
  type: 'Program',
  body: [
    {
      type: 'ImportDeclaration',
      specifiers: [Array],
      source: [Object],
      position: [Object]
    },
    {
      type: 'ImportDeclaration',
      specifiers: [Array],
      source: [Object],
      position: [Object]
    },
    {
      type: 'VariableDeclaration',
      declarations: [Array],
      kind: 'const',
      position: [Object]
    },
    {
      type: 'ExpressionStatement',
      expression: [Object],
      position: [Object]
    }
  ],
  sourceType: 'module',
  comments: [],
  position: {
    start: {line: 1, column: 1, offset: 0},
    end: {line: 7, column: 1, offset: 157}
  }
}

This package exports the identifier fromJs. There is no default export.

Parse JavaScript to an esast.

• value (Value) — serialized JavaScript to parse
• options (Options, optional) — configuration

Tree (Node).

Configuration (TypeScript type).

JavaScript version (Version, default: 'latest').

When a number, must be a year in the range 2015 and 2022 (both including). 'latest' is the same as passing the latest supported year.

☢️ Danger: 'latest' is a sliding thing, you could consider it as breaking semver. Pass an actual year to lock that down.

Whether this is a module (ESM) or a script (boolean, default: false).

Whether a return statement is allowed in the top scope (boolean, default: false).

Whether import/export statements are allowed in the every scope (boolean, default: false).

Whether await is allowed in the top scope (boolean, default: depends). Defaults to version >= 2022.

Whether super is allowed outside methods (boolean, default: false).

Whether a shell hasbang is allowed (boolean, default: false).

List of acorn plugins (Array<Plugin>, default: []). Examples are acorn-jsx and acorn-stage3.

Acorn plugin (TypeScript type).

type Plugin = (Parser: ParserClass) => ParserClass

Input value (TypeScript type).

type Value = string | Buffer // `Buffer` is added when Node.js types ere used.

JavaScript version (TypeScript type).

'latest' is equivalent to the latest supported year.

type Version = 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 'latest'

This package is fully typed with TypeScript. It exports the additional types Options, Plugin, Value, and Version.

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

MIT © Titus Wormer