docs: add metadata for parser/processor #17438
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
nzakas
requested changes
Jul 31, 2023
| The `meta.name` property should match the npm package name for your custom parser and the `meta.version` property should match the npm package version for your custom parser. The easiest way to accomplish this is by reading this information from your `package.json`. | ||
|
|
||
| ### Methods in Custom Parsers | ||
|
|
||
| A custom parser is a JavaScript object with either a `parse` or `parseForESLint` method. The `parse` method only returns the AST, whereas `parseForESLint` also returns additional values that let the parser customize the behavior of ESLint even more. |
There was a problem hiding this comment.
Can you rearrange this so the meta data section comes after these other sections? We'd like people to focus on the methods first and then think about meta data.
There was a problem hiding this comment.
Np. I copied the ordering from plugins.md. Also updated the ordering there.
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
harish-sethuraman
added
the
accepted
Merged
8 tasks
eslint-github-bot
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Added
metadatadescriptions tocustom-parsers.mdandcustom-processors.md. I don't know ifmetadataobject is also implemented for formatters, if so I am happy to add a section covering that, too.Is there anything you'd like reviewers to focus on?
The current
metasections are mostly copied fromplugins.md. Frankly I don't know ifmetaobject helps ESLint cache the parsers/processors. If not please correct me.