eslint/docs/user-guide/configuring/README.md

   1 # Configuring ESLint
   2
   3 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:
   4
   5 1. **Configuration Comments** - use JavaScript comments to embed configuration information directly into a file.
   6 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.*`](./configuration-files.md#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).
   7
   8 Here are some of the options that you can configure in ESLint:
   9
  10 * [**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.
  11 * [**Globals**](./language-options.md#specifying-globals) - the additional global variables your script accesses during execution.
  12 * [**Rules**](rules.md) - which rules are enabled and at what error level.
  13 * [**Plugins**](plugins.md) - which third-party plugins define additional rules, environments, configs, etc. for ESLint to use.
  14
  15 All of these options give you fine-grained control over how ESLint treats your code.
  16
  17 ## Table of Contents
  18
  19 [**Configuration Files**](configuration-files.md)
  20
  21 * [Configuration File Formats](./configuration-files.md#configuration-file-formats)
  22 * [Using Configuration Files](./configuration-files.md#using-configuration-files)
  23 * [Adding Shared Settings](./configuration-files.md#adding-shared-settings)
  24 * [Cascading and Hierarchy](./configuration-files.md#cascading-and-hierarchy)
  25 * [Extending Configuration Files](./configuration-files.md#extending-configuration-files)
  26 * [Configuration Based on Glob Patterns](./configuration-files.md#configuration-based-on-glob-patterns)
  27 * [Personal Configuration Files](./configuration-files.md#personal-configuration-files-deprecated)
  28
  29 [**Language Options**](language-options.md)
  30
  31 * [Specifying Environments](./language-options.md#specifying-environments)
  32 * [Specifying Globals](./language-options.md#specifying-globals)
  33 * [Specifying Parser Options](./language-options.md#specifying-parser-options)
  34
  35 [**Rules**](rules.md)
  36
  37 * [Configuring Rules](./rules.md#configuring-rules)
  38 * [Disabling Rules](./rules.md#disabling-rules)
  39
  40 [**Plugins**](plugins.md)
  41
  42 * [Specifying Parser](./plugins.md#specifying-parser)
  43 * [Specifying Processor](./plugins.md#specifying-processor)
  44 * [Configuring Plugins](./plugins.md#configuring-plugins)
  45
  46 [**Ignoring Code**](ignoring-code.md)
  47
  48 * [`ignorePatterns` in Config Files](./ignoring-code.md#ignorepatterns-in-config-files)
  49 * [The `.eslintignore` File](./ignoring-code.md#the-eslintignore-file)
  50 * [Using an Alternate File](./ignoring-code.md#using-an-alternate-file)
  51 * [Using eslintIgnore in package.json](./ignoring-code.md#using-eslintignore-in-packagejson)
  52 * [Ignored File Warnings](./ignoring-code.md#ignored-file-warnings)