Skip to content

Commit

Permalink
Docs: Reorganize Configuration Documentation (#13837)
Browse files Browse the repository at this point in the history 
* Create Configuration Files

* Create Index File

* Create Configuration Files

* Delete Configuration Files

* Create Configuration Files

* Create Language Options

* Create Rules

* Create Plugins

* Create Ignoring Code

* Update README.md

* Update README.md

* Rename Language Options.md to language-options.md

* Rename Configuration Files.md to configuration-files.md

* Rename Rules.md to rules.md

* Rename Plugins.md to plugins.md

* Rename Ignoring Code.md to ignoring-code.md

* Rename docs/user-guide/Configuring ESLint/README.md to docs/user-guide/configuring-ESLint/README.md

* Rename docs/user-guide/Configuring ESLint/configuration-files.md to docs/user-guide/configuring-ESLint/configuration-files.md

* Rename docs/user-guide/Configuring ESLint/ignoring-code.md to docs/user-guide/configuring-ESLint/ignoring-code.md

* Rename docs/user-guide/Configuring ESLint/language-options.md to docs/user-guide/configuring-ESLint/language-options.md

* Rename docs/user-guide/Configuring ESLint/plugins.md to docs/user-guide/configuring-ESLint/plugins.md

* Rename docs/user-guide/Configuring ESLint/rules.md to docs/user-guide/configuring-ESLint/rules.md

* Update README.md

* Update README.md

* Update README.md

* Update configuration-files.md

* Update ignoring-code.md

* Update ignoring-code.md

* Update ignoring-code.md

* Update ignoring-code.md

* Update README.md

* Update plugins.md

* Update rules.md

* Update configuration-files.md

* Update language-options.md

* Update rules.md

* Update plugins.md

* Update ignoring-code.md

* Docs: Update Configurating ESLint README.md

Added space before and after the list items to remove an error.

* Docs: Update Plugins.md in Configuring ESLint

Updated the file to remove the error in line 63.

* Docs: Update README.md in Configuring ESLint

Updated the heading to remove the error in line 1.

* Docs: Renamed the directory to configuring-eslint

Renamed parent directory to remove the uppercase letters from the name.

* Docs: Renamed the directory to configuring-eslint

Renamed the parent directory to remove the uppercase letters from the name.

* Docs: Renamed the directory to configuring-eslint

Renamed the parent directory to remove the uppercase letters from the name.

* Docs: Renamed the directory to configuring-eslint

Renamed the parent directory to remove the uppercase letters from the name.

* Docs: Renamed the directory to configuring-eslint

Renamed the parent directory to remove the uppercase letters from the name.

* Docs: Renamed the directory to configuring-eslint

Renamed the parent directory to remove the uppercase letters from the name.

* Docs: Update README.md for configuring ESLint

Updated the directory name by changing it from 'configuring-eslint' to 'configuring' to use the already-available directory.

* Docs: Update configuration files

Updated the directory name by changing it from 'configuring-eslint' to 'configuring' to use the already-available directory.

* Docs: Update ignoring-code.md

Updated the directory name by changing it from 'configuring-eslint' to 'configuring' to use the already-available directory.

* Docs: Update language-options.md

Updated the directory name by changing it from 'configuring-eslint' to 'configuring' to use the already-available directory.

* Docs: Update plugins.md

Updated the directory name by changing it from 'configuring-eslint' to 'configuring' to use the already-available directory.

* Docs: Update rules.md

Updated the directory name by changing it from 'configuring-eslint' to 'configuring' to use the already-available directory.

* Docs: Update docs/user-guide/configuring/README.md

Accepted a suggestion on the README.md file.

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/README.md

Accepted a suggested change in the README.md file.

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggesetd change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/configuration-files.md

Accepted a suggested change to configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update configuration-files.md

Accepted two suggested changes to configuration-files.md

* Docs: Update configuration-files.md

Removed the names of deprecated files (.eslintrc), using '.eslintrc.json' instead.

* Docs: Update docs/user-guide/configuring/README.md

Accepted a suggestion to improve the README.md file

Co-authored-by: Kai Cataldo <kai@kaicataldo.com>

* Docs: Update configuration-files.md

Accepted suggestions made to the configuration-files.md file in ESLint Configuration documentation.

* Docs:  Update configuration-files.md

Accepted a suggestion to edit configuration-files.md

* Docs: Update configuration-files.md

Accepted suggestions made to the configuration-files. md file in ESLint COnfiguration Documentation.

* Docs: Update docs/user-guide/configuring/rules.md

Accepted a suggestion to rules. md file.

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/plugins.md

Accepted a suggestion to plugins.md file.

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update docs/user-guide/configuring/language-options.md

Accepted a suggestion to language-options.md file.

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* Docs: Update README.md

Updated the Table of Content to change the name of a heading from "eslintignore" to "The eslintignore File"

* Docs: Update ingoring-code.md

Accepted suggestions to the ignoring-code.md file.

* Docs: Update configuration-files.md

Accepted suggestions made to configuration-files.md.

* Docs: Update docs/user-guide/configuring/language-options.md

Accepted a suggestion made to language-options.md

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

* Docs: Update docs/user-guide/configuring/plugins.md

Accepted a suggestion made to plugins.md

Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>

* Docs: Update ignoring-code.md

Accepted suggestions made to ignoring-code.md

* Docs: Update configuration-files.md

Accepted suggestions to configuration-files.md

* Update docs/user-guide/configuring/ignoring-code.md

Co-authored-by: Kai Cataldo <kai@kaicataldo.com>

* Update docs/user-guide/configuring/ignoring-code.md

Co-authored-by: Kai Cataldo <kai@kaicataldo.com>

* Update docs/user-guide/configuring/language-options.md

Co-authored-by: Kai Cataldo <kai@kaicataldo.com>

* Update docs/user-guide/configuring/language-options.md

* Update ignoring-code.md

Updated ignoring-code.md by incorporating some suggested changes.

* [Docs] Update rules.md

Updated rules.md by moving`Disabling Inline Comments` to this section.

* [Docs] Update README.md

Updated the table of contents

* [Docs] Update rules.md

* Update docs/user-guide/configuring/ignoring-code.md

* Update docs/user-guide/configuring/ignoring-code.md

* Update docs/user-guide/configuring/ignoring-code.md

* Update docs/user-guide/configuring/ignoring-code.md

* Update docs/user-guide/configuring/ignoring-code.md

* Docs: Update configuration-files.md

* Docs: Update configuration-files.md

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Kai Cataldo <kai@kaicataldo.com>
Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
  • Loading branch information
@khawarlatifkhan @nzakas
@kaicataldo @btmills
4 people authored Jan 23, 2021
1 parent c753b44 commit f6602d5
Show file tree
Hide file tree
Showing 6 changed files with 1,270 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs/user-guide/configuring/README.md
View file
Original file line number Diff line number Diff line change
@@ -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)
Loading

0 comments on commit f6602d5

Please sign in to comment.