From 266860b597a7b341d337f7f44195fac63b677ba2 Mon Sep 17 00:00:00 2001 From: nathanhleung Date: Fri, 6 Jan 2017 17:04:28 -0500 Subject: [PATCH] [eslint config] [*] [docs] add note about `install-peerdeps` Closes #1233. --- packages/eslint-config-airbnb-base/README.md | 13 +++++++++++++ packages/eslint-config-airbnb/README.md | 13 +++++++++++++ 2 files changed, 26 insertions(+) diff --git a/packages/eslint-config-airbnb-base/README.md b/packages/eslint-config-airbnb-base/README.md index a79376be..4350a5db 100644 --- a/packages/eslint-config-airbnb-base/README.md +++ b/packages/eslint-config-airbnb-base/README.md @@ -32,6 +32,19 @@ Our default export contains all of our ESLint rules, including ECMAScript 6+. It npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.# ``` + Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool. + + ```sh + npm install -g install-peerdeps + install-peerdeps --dev eslint-config-airbnb-base + ``` + + The cli will produce and run a command like: + + ```sh + npm install --save-dev eslint-config-airbnb-base eslint@^#.#.# eslint-plugin-import@^#.#.# + ``` + 2. Add `"extends": "airbnb-base"` to your .eslintrc ### eslint-config-airbnb-base/legacy diff --git a/packages/eslint-config-airbnb/README.md b/packages/eslint-config-airbnb/README.md index e8d66eca..122eaf2e 100644 --- a/packages/eslint-config-airbnb/README.md +++ b/packages/eslint-config-airbnb/README.md @@ -33,6 +33,19 @@ Our default export contains all of our ESLint rules, including ECMAScript 6+ and npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.# ``` + Windows users can either install all the peer dependencies manually, or use the [install-peerdeps](https://github.com/nathanhleung/install-peerdeps) cli tool. + + ```sh + npm install -g install-peerdeps + install-peerdeps --dev eslint-config-airbnb + ``` + + The cli will produce and run a command like: + + ```sh + npm install --save-dev eslint-config-airbnb eslint@^#.#.# eslint-plugin-jsx-a11y@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-react@^#.#.# + ``` + 2. Add `"extends": "airbnb"` to your .eslintrc ### eslint-config-airbnb/base