Skip to content

Commit

Permalink
Docs: References correct config file name (#12885)
Browse files Browse the repository at this point in the history
From eslint/archive-website#693

According to the `configuration.md` page, the `.eslintrc` file format has been deprecated, and the `--init` option will generate either a `.yml`, `.js`, or `.json` file depending on what you pick in the initialization wizard.

This commit syncs the getting-started instructions with the configuration instructions.
  • Loading branch information
pckilgore committed Feb 25, 2020
1 parent 78182e4 commit f479f6f
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/user-guide/getting-started.md
Expand Up @@ -38,7 +38,7 @@ It is also possible to install ESLint globally rather than locally (using `npm i

**Note:** If you are coming from a version before 1.0.0 please see the [migration guide](migrating-to-1.0.0.md).

After running `eslint --init`, you'll have a `.eslintrc` file in your directory. In it, you'll see some rules configured like this:
After running `eslint --init`, you'll have a `.eslintrc.{js,yml,json}` file in your directory. In it, you'll see some rules configured like this:

```json
{
Expand All @@ -57,7 +57,7 @@ The names `"semi"` and `"quotes"` are the names of [rules](/docs/rules) in ESLin

The three error levels allow you fine-grained control over how ESLint applies rules (for more configuration options and details, see the [configuration docs](configuring.md)).

Your `.eslintrc` configuration file will also include the line:
Your `.eslintrc.{js,yml,json}` configuration file will also include the line:

```json
{
Expand Down

0 comments on commit f479f6f

Please sign in to comment.