From 01fc36cf0adaed396919f8c07bd4a551106a12e3 Mon Sep 17 00:00:00 2001 From: eyal0803 Date: Mon, 7 Jan 2019 21:15:04 +0200 Subject: [PATCH 1/3] Docs: Add `npx` usage to Getting Started guide `npx` is a shorter alternative to navigating to the executable found in `node_modules/.bin` --- docs/user-guide/getting-started.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/user-guide/getting-started.md b/docs/user-guide/getting-started.md index 4b98eb075f3..923e67ec2c7 100644 --- a/docs/user-guide/getting-started.md +++ b/docs/user-guide/getting-started.md @@ -37,6 +37,12 @@ After that, you can run ESLint in your project's root directory like this: $ ./node_modules/.bin/eslint yourfile.js ``` +Note that you may also use `npx` to run `eslint`: + +``` +$ npx eslint +``` + Any plugins or shareable configs that you use must also be installed locally to work with a locally-installed ESLint. ### Global Installation and Usage From 330ab27ce12f1b8b498a1ba46f5454204e8c5ffb Mon Sep 17 00:00:00 2001 From: eyal0803 Date: Wed, 9 Jan 2019 15:57:35 +0200 Subject: [PATCH 2/3] Docs: Add caveats of using `npx` --- docs/user-guide/getting-started.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/user-guide/getting-started.md b/docs/user-guide/getting-started.md index 923e67ec2c7..08a5aef2b61 100644 --- a/docs/user-guide/getting-started.md +++ b/docs/user-guide/getting-started.md @@ -37,12 +37,14 @@ After that, you can run ESLint in your project's root directory like this: $ ./node_modules/.bin/eslint yourfile.js ``` -Note that you may also use `npx` to run `eslint`: +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. + Any plugins or shareable configs that you use must also be installed locally to work with a locally-installed ESLint. ### Global Installation and Usage From 198f6c739530224bfa026e7f14ed737b28ec4ebb Mon Sep 17 00:00:00 2001 From: eyal0803 Date: Wed, 9 Jan 2019 16:14:13 +0200 Subject: [PATCH 3/3] Docs: Use a suggested alternative phrasing --- docs/user-guide/getting-started.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/getting-started.md b/docs/user-guide/getting-started.md index 08a5aef2b61..2e6e6617a51 100644 --- a/docs/user-guide/getting-started.md +++ b/docs/user-guide/getting-started.md @@ -43,7 +43,7 @@ Instead of navigating to `./node_modules/.bin/` you may also use `npx` to run `e $ npx eslint ``` -**Note:** If wasn't manually installed (via `npm`), `npx` will install `eslint` to a temporary directory and execute it. +**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.