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.

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

Docs: Reorganize Configuration Documentation #13837

Merged
merged 96 commits into from Jan 23, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
96 commits
Select commit Hold shift + click to select a range
3cc50a2
Create Configuration Files
khawarlatifkhan Nov 12, 2020
0f4fc07
Create Index File
khawarlatifkhan Nov 12, 2020
1644263
Create Configuration Files
khawarlatifkhan Nov 12, 2020
3faeb4c
Delete Configuration Files
khawarlatifkhan Nov 12, 2020
6994600
Create Configuration Files
khawarlatifkhan Nov 12, 2020
87bdf0f
Create Language Options
khawarlatifkhan Nov 12, 2020
57502e5
Create Rules
khawarlatifkhan Nov 12, 2020
2c35976
Create Plugins
khawarlatifkhan Nov 12, 2020
92ed6d1
Create Ignoring Code
khawarlatifkhan Nov 12, 2020
5a03df5
Update README.md
khawarlatifkhan Nov 12, 2020
2865483
Update README.md
khawarlatifkhan Nov 12, 2020
5725f95
Rename Language Options.md to language-options.md
khawarlatifkhan Nov 12, 2020
d81fc30
Rename Configuration Files.md to configuration-files.md
khawarlatifkhan Nov 12, 2020
33fcf7c
Rename Rules.md to rules.md
khawarlatifkhan Nov 12, 2020
ec2e327
Rename Plugins.md to plugins.md
khawarlatifkhan Nov 12, 2020
17026ef
Rename Ignoring Code.md to ignoring-code.md
khawarlatifkhan Nov 12, 2020
693897d
Rename docs/user-guide/Configuring ESLint/README.md to docs/user-guid…
khawarlatifkhan Nov 12, 2020
1df671e
Rename docs/user-guide/Configuring ESLint/configuration-files.md to d…
khawarlatifkhan Nov 12, 2020
970bf85
Rename docs/user-guide/Configuring ESLint/ignoring-code.md to docs/us…
khawarlatifkhan Nov 12, 2020
386c032
Rename docs/user-guide/Configuring ESLint/language-options.md to docs…
khawarlatifkhan Nov 12, 2020
68ed8f6
Rename docs/user-guide/Configuring ESLint/plugins.md to docs/user-gui…
khawarlatifkhan Nov 12, 2020
e180e1c
Rename docs/user-guide/Configuring ESLint/rules.md to docs/user-guide…
khawarlatifkhan Nov 12, 2020
126966b
Update README.md
khawarlatifkhan Nov 12, 2020
b7f21b5
Update README.md
khawarlatifkhan Nov 12, 2020
6f3ad18
Update README.md
khawarlatifkhan Nov 12, 2020
b7a6ffb
Update configuration-files.md
khawarlatifkhan Nov 12, 2020
f67bf8e
Update ignoring-code.md
khawarlatifkhan Nov 12, 2020
075ee4f
Update ignoring-code.md
khawarlatifkhan Nov 12, 2020
5121761
Update ignoring-code.md
khawarlatifkhan Nov 12, 2020
c85bf88
Update ignoring-code.md
khawarlatifkhan Nov 12, 2020
89d9b37
Update README.md
khawarlatifkhan Nov 12, 2020
ba70eb8
Update plugins.md
khawarlatifkhan Nov 12, 2020
f92373f
Update rules.md
khawarlatifkhan Nov 12, 2020
866372a
Update configuration-files.md
khawarlatifkhan Nov 12, 2020
7c5b472
Update language-options.md
khawarlatifkhan Nov 12, 2020
c91c896
Update rules.md
khawarlatifkhan Nov 12, 2020
6287fb6
Update plugins.md
khawarlatifkhan Nov 12, 2020
2edfd30
Update ignoring-code.md
khawarlatifkhan Nov 12, 2020
34925df
Docs: Update Configurating ESLint README.md
khawarlatifkhan Nov 14, 2020
cca0ea5
Docs: Update Plugins.md in Configuring ESLint
khawarlatifkhan Nov 14, 2020
cbf8eb9
Docs: Update README.md in Configuring ESLint
khawarlatifkhan Nov 14, 2020
46a2e5e
Docs: Renamed the directory to configuring-eslint
khawarlatifkhan Nov 14, 2020
9711bfc
Docs: Renamed the directory to configuring-eslint
khawarlatifkhan Nov 14, 2020
31b6aea
Docs: Renamed the directory to configuring-eslint
khawarlatifkhan Nov 14, 2020
c757bee
Docs: Renamed the directory to configuring-eslint
khawarlatifkhan Nov 14, 2020
8c69df9
Docs: Renamed the directory to configuring-eslint
khawarlatifkhan Nov 14, 2020
eade6b0
Docs: Renamed the directory to configuring-eslint
khawarlatifkhan Nov 14, 2020
37fef90
Docs: Update README.md for configuring ESLint
khawarlatifkhan Nov 17, 2020
9d296e1
Docs: Update configuration files
khawarlatifkhan Nov 17, 2020
7f3eec5
Docs: Update ignoring-code.md
khawarlatifkhan Nov 17, 2020
162535b
Docs: Update language-options.md
khawarlatifkhan Nov 17, 2020
2bcaac2
Docs: Update plugins.md
khawarlatifkhan Nov 17, 2020
84e409b
Docs: Update rules.md
khawarlatifkhan Nov 17, 2020
65d14a6
Docs: Update docs/user-guide/configuring/README.md
khawarlatifkhan Nov 18, 2020
6fe3488
Docs: Update docs/user-guide/configuring/README.md
khawarlatifkhan Nov 18, 2020
249f0f3
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
b1a158b
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
c00f183
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
1c2accf
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
93eca30
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
dafbde2
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
6765bfd
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
1cb80a8
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
0128ceb
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
0ced160
Docs: Update docs/user-guide/configuring/configuration-files.md
khawarlatifkhan Nov 18, 2020
5b97d15
Docs: Update configuration-files.md
khawarlatifkhan Nov 18, 2020
f0004ce
Docs: Update configuration-files.md
khawarlatifkhan Nov 19, 2020
579f48e
Docs: Update docs/user-guide/configuring/README.md
khawarlatifkhan Nov 25, 2020
ce36fc2
Docs: Update configuration-files.md
khawarlatifkhan Nov 25, 2020
dc2f769
Docs: Update configuration-files.md
khawarlatifkhan Nov 26, 2020
caabbf6
Docs: Update configuration-files.md
khawarlatifkhan Nov 28, 2020
481b51d
Docs: Update docs/user-guide/configuring/rules.md
khawarlatifkhan Nov 28, 2020
6c0667f
Docs: Update docs/user-guide/configuring/plugins.md
khawarlatifkhan Nov 28, 2020
0bd4315
Docs: Update docs/user-guide/configuring/language-options.md
khawarlatifkhan Nov 28, 2020
b876d72
Docs: Update README.md
khawarlatifkhan Nov 28, 2020
c0740ae
Docs: Update ingoring-code.md
khawarlatifkhan Nov 28, 2020
b7945c2
Docs: Update configuration-files.md
khawarlatifkhan Nov 30, 2020
99a1f1d
Docs: Update docs/user-guide/configuring/language-options.md
khawarlatifkhan Nov 30, 2020
e7d491d
Docs: Update docs/user-guide/configuring/plugins.md
khawarlatifkhan Nov 30, 2020
c968eb1
Docs: Update ignoring-code.md
khawarlatifkhan Nov 30, 2020
e06fc3c
Docs: Update configuration-files.md
khawarlatifkhan Dec 1, 2020
cb60479
Update docs/user-guide/configuring/ignoring-code.md
nzakas Dec 24, 2020
56083d0
Update docs/user-guide/configuring/ignoring-code.md
nzakas Dec 24, 2020
7488f5b
Update docs/user-guide/configuring/language-options.md
nzakas Dec 24, 2020
d6bff3f
Update docs/user-guide/configuring/language-options.md
nzakas Dec 24, 2020
af80692
Update ignoring-code.md
khawarlatifkhan Dec 25, 2020
d424049
[Docs] Update rules.md
khawarlatifkhan Dec 25, 2020
04493af
[Docs] Update README.md
khawarlatifkhan Dec 25, 2020
846e4ce
[Docs] Update rules.md
khawarlatifkhan Dec 25, 2020
e87d2a3
Update docs/user-guide/configuring/ignoring-code.md
nzakas Dec 29, 2020
7506ec1
Update docs/user-guide/configuring/ignoring-code.md
nzakas Dec 29, 2020
765d62f
Update docs/user-guide/configuring/ignoring-code.md
nzakas Dec 29, 2020
addb6c8
Update docs/user-guide/configuring/ignoring-code.md
nzakas Dec 29, 2020
4367199
Update docs/user-guide/configuring/ignoring-code.md
nzakas Dec 29, 2020
5da2759
Docs: Update configuration-files.md
khawarlatifkhan Jan 21, 2021
bfd3f0e
Docs: Update configuration-files.md
khawarlatifkhan Jan 22, 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
52 changes: 52 additions & 0 deletions docs/user-guide/configuring/README.md
@@ -0,0 +1,52 @@
# Configuring ESLint

ESLint is designed to be flexible and configurable for your use case. You can turn off every rule and run only with basic syntax validation or mix and match the bundled rules and your custom rules to fit the needs of your project. There are two primary ways to configure ESLint:

1. **Configuration Comments** - use JavaScript comments to embed configuration information directly into a file.
1. **Configuration Files** - use a JavaScript, JSON, or YAML file to specify configuration information for an entire directory and all of its subdirectories. This can be in the form of an [`.eslintrc.*`](./configuring-files#configuration-file-formats) file or an `eslintConfig` field in a [`package.json`](https://docs.npmjs.com/files/package.json) file, both of which ESLint will look for and read automatically, or you can specify a configuration file on the [command line](https://eslint.org/docs/user-guide/command-line-interface).

Here are some of the options that you can configure in ESLint:

* [**Environments**](./language-options.md#specifying-environments) - which environments your script is designed to run in. Each environment brings with it a certain set of predefined global variables.
* [**Globals**](./language-options.md#specifying-globals) - the additional global variables your script accesses during execution.
* [**Rules**](rules.md) - which rules are enabled and at what error level.
* [**Plugins**](plugins.md) - which third-party plugins define additional rules, environments, configs, etc. for ESLint to use.

All of these options give you fine-grained control over how ESLint treats your code.

## Table of Contents

[**Configuration Files**](configuration-files.md)

* [Configuration File Formats](./configuration-files.md#configuration-file-formats)
* [Using Configuration Files](./configuration-files.md#using-configuration-files)
* [Adding Shared Settings](./configuration-files.md#adding-shared-settings)
* [Cascading and Hierarchy](./configuration-files.md#cascading-and-hierarchy)
* [Extending Configuration Files](./configuring-files.md#extending-configuration-files)
* [Configuration Based on Glob Patterns](./configuration-files.md#configuration-based-on-glon-patterns)
* [Personal Configuration Files](./configuration-files.md#personal-configuration-files)

[**Language Options**](language-options.md)

* [Specifying Environments](./language-options.md#specifying-environments)
* [Specifying Globals](./language-options.md#specifying-globals)
* [Specifying Parser Options](./language-options.md#specifying-parser-options)

[**Rules**](rules.md)

* [Configuring Rules](./rules.md#configuring-rules)
* [Disabling Rules](./rules.md#disabling-rules)

[**Plugins**](plugins.md)

* [Specifying Parser](./plugins.md#specifying-parser)
* [Specifying Processor](./plugins.md#specifying-processor)
* [Configuring Plugins](./plugins.md#configuring-plugins)

[**Ignoring Code**](ignoring-code.md)

* [`ignorePatterns` in Config Files](./ignoring-code.md#ignorepatterns-in-config-files)
* [The `.eslintignore` File](./ignoring-code.md#the-eslintignore-file)
* [Using an Alternate File](./ignoring-code.md#using-an-alternate-file)
* [Using eslintIgnore in package.json](./ignoring-code.md#using-eslintignore-in-package.json)
* [Ignored File Warnings](./ignoring-code.md#ignored-file-warnings)