unified

Project: syntax-tree/estree-util-attach-comments

Package: estree-util-attach-comments@2.1.0

  1. Dependents: 0
  2. Attach comments to estree nodes
  1. tree 44
  2. ast 36
  3. javascript 23
  4. ecmascript 10
  5. estree 9
  6. comment 9
  7. acorn 3
  8. espree 2
  9. recast 2

estree-util-attach-comments

Build Coverage Downloads Size Sponsors Backers Chat

estree utility attach semistandard comment nodes (such as from acorn) to the nodes in that tree.

Contents

What is this?

This package is a utility that you can use to embed comment nodes inside a tree. This is useful because certain estree parsers give you an array (espree and acorn) whereas other estree tools expect comments to be embedded on nodes in the tree.

This package uses one comments array where each comment has leading and trailing fields, as applied by acorn, but does not support the slightly different non-standard comments made by espree.

When should I use this?

You can use this package when working with comments from Acorn and later working with a tool such as recast or Babel.

Install

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

npm install estree-util-attach-comments

In Deno with esm.sh:

import {attachComments} from 'https://esm.sh/estree-util-attach-comments@2'

In browsers with esm.sh:

<script type="module">
  import {attachComments} from 'https://esm.sh/estree-util-attach-comments@2?bundle'
</script>

Use

Say our document index.js contains:

/* 1 */ function /* 2 */ a /* 3 */ (/* 4 */b) /* 5 */ { /* 6 */ return /* 7 */ b + /* 8 */ 1 /* 9 */ }

…and our module example.js looks as follows:

import fs from 'node:fs/promises'
import * as acorn from 'acorn'
import recast from 'recast'
import {attachComments} from 'estree-util-attach-comments'

const code = String(await fs.readFile('index.js'))
const comments = []
const tree = acorn.parse(code, {ecmaVersion: 2020, onComment: comments})

attachComments(tree, comments)

console.log(recast.print(tree).code)

Yields:

/* 1 */
function /* 2 */
a(
    /* 3 */
    /* 4 */
    b
) /* 5 */
{
    /* 6 */
    return (
        /* 7 */
        b + /* 8 */
        1
    );
}/* 9 */

👉 Note: the lines are added by recast in this case. And, some of these weird comments are off, but they’re pretty close.

API

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

attachComments(tree, comments)

Attach semistandard estree comment nodes to the tree.

This mutates the given tree (Program). It takes comments, walks the tree, and adds comments as close as possible to where they originated.

Comment nodes are given two boolean fields: leading (true for /* a */ b) and trailing (true for a /* b */). Both fields are false for dangling comments: [/* a */]. This is what recast uses too, and is somewhat similar to Babel, which is not estree but instead uses leadingComments, trailingComments, and innerComments arrays on nodes.

The algorithm checks any node: even recent (or future) proposals or nonstandard syntax such as JSX, because it ducktypes to find nodes instead of having a list of visitor keys.

The algorithm supports loc fields (line/column), range fields (offsets), and direct start / end fields.

Returns

The given tree (Node).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

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

Contribute

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.

License

MIT © Titus Wormer