Skip to content

Commit

Permalink
Docs: Add npx usage to Getting Started guide (#11249)
Browse files Browse the repository at this point in the history
* Docs: Add `npx` usage to Getting Started guide

`npx` is a shorter alternative to navigating to the executable found in `node_modules/.bin`

* Docs: Add caveats of using `npx`

* Docs: Use a suggested alternative phrasing
  • Loading branch information
eyal0803 authored and nzakas committed Jan 16, 2019
1 parent da9174e commit 7c0bf2c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/user-guide/getting-started.md
Expand Up @@ -37,6 +37,14 @@ After that, you can run ESLint in your project's root directory like this:
$ ./node_modules/.bin/eslint yourfile.js
```

Instead of navigating to `./node_modules/.bin/` you may also use `npx` to run `eslint`:

```
$ npx eslint
```

**Note:** If ESLint wasn't manually installed (via `npm`), `npx` will install `eslint` to a temporary directory and execute it.

Any plugins or shareable configs that you use must also be installed locally to work with a locally-installed ESLint.

### Global Installation and Usage
Expand Down

0 comments on commit 7c0bf2c

Please sign in to comment.