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.

Sign up for GitHub

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

Jump to bottom

Docs: Add npx usage to Getting Started guide #11249

Merged
merged 3 commits into from Jan 16, 2019
Merged

Docs: Add npx usage to Getting Started guide #11249

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01fc36c
Docs: Add `npx` usage to Getting Started guide
Jan 7, 2019
330ab27
Docs: Add caveats of using `npx`
Jan 9, 2019
198f6c7
Docs: Use a suggested alternative phrasing
Jan 9, 2019
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
8 changes: 8 additions & 0 deletions docs/user-guide/getting-started.md
View file
Open in desktop
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 wasn't manually installed (via `npm`), `npx` will install `eslint` to a temporary directory and execute it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion: "If ESLint wasn't manually installed"

@g-plane Can you comment on the accuracy of "a temporary directory"? Is it really a temporary directory or does npx install to the global installation location? Thanks!


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