Docs: Add doc on parser services (fixes #8390) #8795
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
|
@VictorHom, thanks for your PR! By analyzing the history of the files in this pull request, we identified @nzakas, @lo1tuma and @ilyavolodin to be potential reviewers. |
|
LGTM |
|
LGTM |
ilyavolodin
reviewed
Jun 24, 2017
|
|
||
| ### Working with Custom Parsers | ||
|
|
||
| If you want to use your own parser and provide additional capabilities for your rules, you can specify your own customer parser. By default, the ESLint parser will use its parse method that takes in the source code as a first parameter and additional optional parameters as a second parameter to create an AST. You can specify a `parse` configuration to use your own custom parser. The parse configuration expects a `parseForESLint` method to be exposed. `parseForESLint` behaves like `parse` and takes in the the source code and optional ESLint configurations. When `parseForESLint` is called, the method should return an object that contains the required property `ast` and an optional `services` property. `ast` should contain the AST. The `services` property contains the parser-dependent services. The value of the service property is available to rules as `context.parserServices` |
There was a problem hiding this comment.
I'm not sure it's correct to say "parse configration expects a parseForESLint method to be exposed." If it's exposed - we'll use it, if not, we'll fall back to parse method as explained below.
There was a problem hiding this comment.
It would also be nice to provide an example of what might be in the parser services. For example, typescript parser exposes methods to get native errors (I think).
There was a problem hiding this comment.
hmmmm I looked for services in https://github.com/eslint/typescript-eslint-parser and didn't see sign of the project adding a services value. I don't have a good example elsewhere.
|
LGTM |
|
LGTM |
gyandeeps
approved these changes
Jun 25, 2017
platinumazure
requested changes
Jun 25, 2017
| @@ -221,7 +221,7 @@ Add these keywords into your `package.json` file to make it easy for others to f | |||
|
|
|||
| ### Working with Custom Parsers | |||
|
|
|||
| If you want to use your own parser and provide additional capabilities for your rules, you can specify your own customer parser. By default, the ESLint parser will use its parse method that takes in the source code as a first parameter and additional optional parameters as a second parameter to create an AST. You can specify a `parse` configuration to use your own custom parser. The parse configuration expects a `parseForESLint` method to be exposed. `parseForESLint` behaves like `parse` and takes in the the source code and optional ESLint configurations. When `parseForESLint` is called, the method should return an object that contains the required property `ast` and an optional `services` property. `ast` should contain the AST. The `services` property contains the parser-dependent services. The value of the service property is available to rules as `context.parserServices` | |||
| If you want to use your own parser and provide additional capabilities for your rules, you can specify your own customer parser. By default, the ESLint parser will use its parse method that takes in the source code as a first parameter and additional optional parameters as a second parameter to create an AST. You can specify a `parse` configuration to use your own custom parser. If a `parseForESLint` method is exposed, this method will be used to parse. Otherwise, the parser will use the parse method. `parseForESLint` behaves like `parse` and takes in the the source code and optional ESLint configurations. When `parseForESLint` is called, the method should return an object that contains the required property `ast` and an optional `services` property. `ast` should contain the AST. The `services` property contains the parser-dependent services. The value of the service property is available to rules as `context.parserServices` | |||
There was a problem hiding this comment.
Nitpick: s/customer parser/custom parser
|
LGTM |
platinumazure
approved these changes
Jun 25, 2017
This was referenced Jun 26, 2017
This was referenced Jul 7, 2017
eslint-deprecated
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.
What is the purpose of this pull request? (put an "X" next to item)
[X] Documentation update
What changes did you make? (Give an overview)
Added documentation on parser services. The associated issue can be found at #8390
Is there anything you'd like reviewers to focus on?
Any details to add