Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: document languageOptions and other v9 changes for context #18074

Merged
merged 1 commit into from Feb 2, 2024
Merged

docs: document languageOptions and other v9 changes for context #18074

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
10 changes: 8 additions & 2 deletions docs/src/extend/custom-rules.md
View file
Open in desktop
Expand Up @@ -128,8 +128,14 @@ The `context` object has the following properties:
* `options`: (`array`) An array of the [configured options](../use/configure/rules) for this rule. This array does not include the rule severity (see the [dedicated section](#accessing-options-passed-to-a-rule)).
* `sourceCode`: (`object`) A `SourceCode` object that you can use to work with the source that was passed to ESLint (see [Accessing the Source Code](#accessing-the-source-code)).
* `settings`: (`object`) The [shared settings](../use/configure/configuration-files#configuring-shared-settings) from the configuration.
* `parserPath`: (`string`) The name of the `parser` from the configuration.
* `parserOptions`: The parser options configured for this run (more details [here](../use/configure/language-options#specifying-parser-options)).
* `languageOptions`: (`object`) more details for each property [here](../use/configure/language-options)
* `sourceType`: (`'script' | 'module' | 'commonjs'`) The mode for the current file.
* `ecmaVersion`: (`number`) The ECMA version used to parse the current file.
* `parser`: (`object`|`string`): Either the parser used to parse the current file for flat config or its name for legacy config.
* `parserOptions`: (`object`) The parser options configured for this file.
* `globals`: (`object`) The specified globals.
* `parserPath`: (`string`, **Removed** Use `context.languageOptions.parser` instead.) The name of the `parser` from the configuration.
* `parserOptions`: (**Deprecated** Use `context.languageOptions.parserOptions` instead.) The parser options configured for this run (more details [here](../use/configure/language-options#specifying-parser-options)).

Additionally, the `context` object has the following methods:

Expand Down