docs: add attachComment #2555
docs: add attachComment #2555
Conversation
|
✔️ Deploy Preview for babel ready! 🔨 Explore the source changes: c72d9b7 🔍 Inspect the deploy log: https://app.netlify.com/sites/babel/deploys/60ef3b4c7d624600089bb59b 😎 Browse the preview: https://deploy-preview-2555--babel.netlify.app |
docs/parser.md
Outdated
| @@ -64,6 +65,8 @@ mind. When in doubt, use `.parse()`. | |||
| to set this option to `true` to prevent the parser from prematurely | |||
| complaining about undeclared exports that will be added later. | |||
|
|
|||
| - **attachComment**: By default, Babel attaches comments to adjacent AST nodes. When this option is set to `false`, comments are not attached. It can provide up to 30% performance improvement when the input code has _many_ comments. You probably don't need to set this option, `@babel/eslint-parser` will set it for you. It is not recommended to use `attachComment: false` with Babel transform, as it removes all the comments in output code, and renders annotations such as `/* istanbul ignore next */` nonfunctional. | |||
There was a problem hiding this comment.
You probably don't need to set this option,
@babel/eslint-parserwill set it for you.
Maybe can just say @babel/eslint-parser will set it for you if it's used for linting? I guess we could mention we may add an option for specifying it babel/babel#13229 (comment) too if we wanted
There was a problem hiding this comment.
babel/babel#13229 (comment)
I think that falls perfectly to the roadmap section. I am afraid add not-yet-implemented ideas to this section may confuse our users.
Docs PR of babel/babel#13229