Content-Length: 5734 | pFad | http://github.com/typescript-eslint/typescript-eslint/pull/177.patch

thub.com From 8fe16ae2b439ffedc797c37bb8658ecda7d8fa9d Mon Sep 17 00:00:00 2001 From: Andrew Boyton Date: Fri, 1 Feb 2019 12:25:49 +1100 Subject: [PATCH 1/4] Add instructions for using Airbnb's config Ref #147 --- packages/eslint-plugin/README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index f0c11446353e..ecbbbc3b5353 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -84,6 +84,22 @@ Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-pre **Note: Make sure you have `eslint-config-prettier@4.0.0` or newer.** +## Usage with Airbnb + +Airbnb has two configs, a base one [`eslint-config-airbnb`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb) and one that includes rules for React [`eslint-config-airbnb-base`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base). + +First you'll need to install the config acrording to the instructions in one of the links above. `npx install-peerdeps --dev eslint-config-airbnb` or `npx install-peerdeps --dev eslint-config-airbnb-base` should work if you are using **npm 5+**. + +Then you should add `airbnb` (or `airbnb-base`) to your `extends` section of `.eslintrc`. You might also want to turn on `plugin:@typescript-eslint/recommended` as well to enable all of the recommended rules. + +```json +{ + "extends": ["airbnb-base", "plugin:@typescript-eslint/recommended"] +} +``` + +**Note: You can use Airbnb's rules along side Prettier, see [Usage with Prettier](#usage-with-prettier)** + ## Supported Rules From c7c5955ef86d6d70dd4f79c96e9cbca6c4dcb4f9 Mon Sep 17 00:00:00 2001 From: Brad Zacher Date: Fri, 1 Feb 2019 15:59:03 +1100 Subject: [PATCH 2/4] Update packages/eslint-plugin/README.md Co-Authored-By: aboyton --- packages/eslint-plugin/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index ecbbbc3b5353..94ccde42b26a 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -86,7 +86,7 @@ Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-pre ## Usage with Airbnb -Airbnb has two configs, a base one [`eslint-config-airbnb`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb) and one that includes rules for React [`eslint-config-airbnb-base`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base). +Airbnb has two configs, a base one [`eslint-config-airbnb-base`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base) and one that includes rules for React [`eslint-config-airbnb`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb). First you'll need to install the config acrording to the instructions in one of the links above. `npx install-peerdeps --dev eslint-config-airbnb` or `npx install-peerdeps --dev eslint-config-airbnb-base` should work if you are using **npm 5+**. From 33aeadd688b17ddcdd1de44244491d1fa13b17b2 Mon Sep 17 00:00:00 2001 From: Jed Fox Date: Sat, 2 Feb 2019 06:19:28 -0500 Subject: [PATCH 3/4] docs: fix typo --- packages/eslint-plugin/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index 94ccde42b26a..d665b614ed18 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -98,7 +98,7 @@ Then you should add `airbnb` (or `airbnb-base`) to your `extends` section of `.e } ``` -**Note: You can use Airbnb's rules along side Prettier, see [Usage with Prettier](#usage-with-prettier)** +**Note: You can use Airbnb's rules alongside Prettier, see [Usage with Prettier](#usage-with-prettier)** ## Supported Rules From 4d97eb48a49aba596b09799ea996461c5d1ef784 Mon Sep 17 00:00:00 2001 From: Andrew Boyton Date: Mon, 4 Feb 2019 13:03:06 +1100 Subject: [PATCH 4/4] Update README.md --- packages/eslint-plugin/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/eslint-plugin/README.md b/packages/eslint-plugin/README.md index d665b614ed18..e1a1440054e4 100644 --- a/packages/eslint-plugin/README.md +++ b/packages/eslint-plugin/README.md @@ -88,7 +88,7 @@ Install [`eslint-config-prettier`](https://github.com/prettier/eslint-config-pre Airbnb has two configs, a base one [`eslint-config-airbnb-base`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb-base) and one that includes rules for React [`eslint-config-airbnb`](https://github.com/airbnb/javascript/tree/master/packages/eslint-config-airbnb). -First you'll need to install the config acrording to the instructions in one of the links above. `npx install-peerdeps --dev eslint-config-airbnb` or `npx install-peerdeps --dev eslint-config-airbnb-base` should work if you are using **npm 5+**. +First you'll need to install the config according to the instructions in one of the links above. `npx install-peerdeps --dev eslint-config-airbnb` or `npx install-peerdeps --dev eslint-config-airbnb-base` should work if you are using **npm 5+**. Then you should add `airbnb` (or `airbnb-base`) to your `extends` section of `.eslintrc`. You might also want to turn on `plugin:@typescript-eslint/recommended` as well to enable all of the recommended rules.

pFad - (p)hone/(F)rame/(a)nonymizer/(d)eclutterfier! Saves Data!