Skip to content

Commit

Permalink
docs: explain how to include predefined globals (#17114)
Browse files Browse the repository at this point in the history
* docs: explain how to include native globals

* docs: line break

* docs: explicitly state why `globals` is necessary

* docs: link to `globals` package

Co-authored-by: Francesco Trotta <github@fasttime.org>

---------

Co-authored-by: Francesco Trotta <github@fasttime.org>
  • Loading branch information
mlwyatt and fasttime committed Apr 24, 2023
1 parent 5ea15d9 commit 4a352a9
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/src/use/configure/configuration-files-new.md
Expand Up @@ -328,6 +328,24 @@ export default [

For historical reasons, the boolean value `false` and the string value `"readable"` are equivalent to `"readonly"`. Similarly, the boolean value `true` and the string value `"writeable"` are equivalent to `"writable"`. However, the use of older values is deprecated.

##### Predefined global variables

Apart from the ECMAScript standard built-in globals, which are automatically enabled based on the configured `languageOptions.ecmaVersion`, ESLint doesn't provide predefined sets of global variables. You can use the [`globals`](https://www.npmjs.com/package/globals) package to additionally enable all globals for a specific environment. For example, here is how you can add `console`, amongst other browser globals, into your configuration.

```js
import globals from "globals";

export default [
{
languageOptions: {
globals: {
...globals.browser
}
}
}
];
```

### Using plugins in your configuration

Plugins are used to share rules, processors, configurations, parsers, and more across ESLint projects.
Expand Down

0 comments on commit 4a352a9

Please sign in to comment.