Skip to content

Commit

Permalink
Docs: Provide install commands for Yarn (#13661)
Browse files Browse the repository at this point in the history
npx doesn't work properly with plugins installed with Yarn.
  • Loading branch information
nbaksalyar committed Sep 12, 2020
1 parent 29d1cdc commit f1d07f1
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/user-guide/getting-started.md
Expand Up @@ -24,12 +24,20 @@ You should then set up a configuration file:

```
$ npx eslint --init
# or
$ yarn run eslint --init
```

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

```
$ npx eslint yourfile.js
# or
$ yarn run eslint yourfile.js
```

It is also possible to install ESLint globally rather than locally (using `npm install eslint --global`). However, this is not recommended, and any plugins or shareable configs that you use must be installed locally in either case.
Expand Down

0 comments on commit f1d07f1

Please sign in to comment.