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: Clarify package.json requirement in Getting Started (refs #13549) #13696

Merged
merged 2 commits into from Sep 22, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 3 additions & 1 deletion docs/user-guide/getting-started.md
Expand Up @@ -20,7 +20,7 @@ npm install eslint --save-dev
yarn add eslint --dev
```

You should then set up a configuration file:
You should then set up a configuration file, and the easiest way to do that is to use the `--init` flag:

```
$ npx eslint --init
Expand All @@ -30,6 +30,8 @@ $ npx eslint --init
$ yarn run eslint --init
```

**Note:** `--init` assumes you have a `package.json` file already. If you don't, make sure to run `npm init` or `yarn init` beforehand.

After that, you can run ESLint on any file or directory like this:

```
Expand Down
Binary file added eslint-7.8.0.tgz
Binary file not shown.