docs: Update Linter API for v9 #17937
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. |
mdjermanovic
commented
Jan 1, 2024
Comment on lines
557
to
574
| The `verify()` method returns an array of objects containing information about the linting warnings and errors. Here's an example: | ||
|
|
||
| ```js | ||
| { | ||
| fatal: false, | ||
| ruleId: "semi", | ||
| severity: 2, | ||
| line: 1, | ||
| column: 23, | ||
| message: "Expected a semicolon.", | ||
| fix: { | ||
| range: [1, 15], | ||
| text: ";" | ||
| [ | ||
| { | ||
| fatal: false, | ||
| ruleId: "semi", | ||
| severity: 2, | ||
| line: 1, | ||
| column: 23, | ||
| message: "Expected a semicolon.", | ||
| fix: { | ||
| range: [1, 15], | ||
| text: ";" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| ``` |
There was a problem hiding this comment.
This isn't a change in v9, I just wrapped the lint message example in [] because verify() always returns arrays.
mdjermanovic
commented
Jan 1, 2024
| @@ -601,8 +603,6 @@ const suppressedMessages = linter.getSuppressedMessages(); | |||
| console.log(suppressedMessages[0].suppressions); // [{ "kind": "directive", "justification": "Need to suppress" }] | |||
| ``` | |||
|
|
|||
| Linting message objects have a deprecated `source` property. This property **will be removed** from linting messages in an upcoming breaking release. If you depend on this property, you should now use the `SourceCode` instance provided by the linter. | |||
There was a problem hiding this comment.
This property was removed in ESLint v5 (27e3f24)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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:
Updates Linter API for v9.
What changes did you make? (Give an overview)
Is there anything you'd like reviewers to focus on?