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: add example .eslintrc.json #15087

Merged
merged 4 commits into from Sep 29, 2021
Merged

Docs: add example .eslintrc.json #15087

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8da22ed
Docs: add example .eslintrc.json
nmattia Sep 21, 2021
4dd3a06
Update docs/user-guide/configuring/configuration-files.md
nmattia Sep 27, 2021
0f620c9
Update docs/user-guide/configuring/configuration-files.md
nmattia Sep 27, 2021
b8d6f11
Update docs/user-guide/configuring/configuration-files.md
nmattia Sep 27, 2021
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
26 changes: 26 additions & 0 deletions docs/user-guide/configuring/configuration-files.md
View file
Open in desktop
Expand Up @@ -39,6 +39,32 @@ The second way to use configuration files is to save the file wherever you would

If you are using one configuration file and want ESLint to ignore any `.eslintrc.*` files, make sure to use [`--no-eslintrc`](https://eslint.org/docs/user-guide/command-line-interface#--no-eslintrc) along with the [`-c`](https://eslint.org/docs/user-guide/command-line-interface#-c---config) flag.

Example configuration file:
nmattia marked this conversation as resolved.
Show resolved Hide resolved

```js
nmattia marked this conversation as resolved.
Show resolved Hide resolved
{
"root": true,
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": { "project": ["./tsconfig.json"] },
"plugins": [
"@typescript-eslint"
],
"rules": {
"@typescript-eslint/strict-boolean-expressions": [
2,
{ "allowString" : false,
nmattia marked this conversation as resolved.
Show resolved Hide resolved
"allowNumber" : false
}
]
},
"ignorePatterns": ["src/**/*.test.ts", "src/frontend/generated/*"]
}
```

### Comments in configuration files

Both the JSON and YAML configuration file formats support comments (package.json files should not include them). You can use JavaScript-style comments for JSON files and YAML-style comments for YAML files. ESLint safely ignores comments in configuration files. This allows your configuration files to be more human-friendly.
Expand Down