Skip to content

Commit

Permalink
docs: update npm init @eslint/config generated file names (#18298)
Browse files Browse the repository at this point in the history
* docs: update `eslint init @eslint/config` generated file names

Signed-off-by: 唯然 <[email protected]>

* Update getting-started.md

---------

Signed-off-by: 唯然 <[email protected]>
  • Loading branch information
aladdin-add committed Apr 11, 2024
1 parent 78e45b1 commit c537d76
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ After that, you can run ESLint on any file or directory like this:

## Configuration

After running `npm init @eslint/config`, you'll have an `eslint.config.js` or `eslint.config.mjs` file in your directory. In it, you'll see some rules configured like this:
After running `npm init @eslint/config`, you'll have an `eslint.config.js` (or `eslint.config.mjs`) file in your directory. In it, you'll see some rules configured like this:

```js
import pluginJs from "@eslint/js";
Expand Down
2 changes: 1 addition & 1 deletion docs/src/use/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ yarn run eslint yourfile.js

**Note:** If you are coming from a version before 9.0.0 please see the [migration guide](configure/migration-guide).

After running `npm init @eslint/config`, you'll have an `eslint.config.js` file in your directory. In it, you'll see some rules configured like this:
After running `npm init @eslint/config`, you'll have an `eslint.config.js` (or `eslint.config.mjs`) file in your directory. In it, you'll see some rules configured like this:

```js
// eslint.config.js
Expand Down

0 comments on commit c537d76

Please sign in to comment.