The estree-util-attach-comments from syntax-tree

estree-util-attach-comments's People

Contributors

Stargazers

Watchers

estree-util-attach-comments's Issues

Ignores the leading/trailing properties of the comments

There is a bug in the plugin which results in generating the wrong node.

The input code

/**
 * Draws lines on the corresponding layer.
 * @param  {number} firstRow the first row to render
 */
function drawLines(
  firstRow,
) {
  console.log("x")
}

Gives the following with Espree 4's attach comment (notice the leadingComments property in body)

Node {
  type: 'Program',
  start: 0,
  end: 170,
  range: [ 108, 168 ],
  body: [
    Node {
      type: 'FunctionDeclaration',
      start: 108,
      end: 168,
      range: [Array],
      id: [Node],
      expression: false,
      generator: false,
      async: false,
      params: [Array],
      body: [Node],
      leadingComments: [Array]
    }
  ],
  sourceType: 'module',
  comments: [
    {
      type: 'Block',
      value: '*\r\n' +
        ' * Draws lines on the corresponding layer.\r\n' +
        ' * @param  {number} firstRow the first row to render\r\n' +
        ' ',
      start: 0,
      end: 106,
      range: [Array]
    }
  ]
}

But using Espree 7 and this package we get the following. estree-util-attach-comments ignores leading property

  type: 'Program',
  start: 0,
  end: 170,
  body: [
    Node {
      type: 'FunctionDeclaration',
      start: 108,
      end: 168,
      id: [Node],
      expression: false,
      generator: false,
      async: false,
      params: [Array],
      body: [Node]
    }
  ],
  sourceType: 'module',
  comments: [
    {
      type: 'Block',
      value: '*\r\n' +
        ' * Draws lines on the corresponding layer.\r\n' +
        ' * @param  {number} firstRow the first row to render\r\n' +
        ' ',
      start: 0,
      end: 106,
      range: [Array],
      leading: true,
      trailing: false
    }
  ]
}