feat: add recommended config eslint rule (#14762)

* feat: add recommended config eslint rule * add exhaustive-deps to recommended as well
facebook · Feb 28, 2020 · 79a2512 · 79a2512
1 parent ae60caa
commit 79a2512
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/packages/eslint-plugin-react-hooks/README.md b/packages/eslint-plugin-react-hooks/README.md
@@ -34,6 +34,17 @@ Then add it to your ESLint configuration:
 }
 ```
 
+Or use the recommended config:
+
+```js
+{
+  "extends": [
+    // ...
+    "plugin:react-hooks/recommended"
+  ]
+}
+```
+
 ## Valid and Invalid Examples
 
 Please refer to the [Rules of Hooks](https://reactjs.org/docs/hooks-rules.html) documentation and the [Hooks FAQ](https://reactjs.org/docs/hooks-faq.html#what-exactly-do-the-lint-rules-enforce) to learn more about this rule.

diff --git a/packages/eslint-plugin-react-hooks/src/index.js b/packages/eslint-plugin-react-hooks/src/index.js
@@ -10,6 +10,16 @@
 import RuleOfHooks from './RulesOfHooks';
 import ExhaustiveDeps from './ExhaustiveDeps';
 
+export const configs = {
+  recommended: {
+    plugins: ['react-hooks'],
+    rules: {
+      'react-hooks/rules-of-hooks': 'error',
+      'react-hooks/exhaustive-deps': 'warn',
+    },
+  },
+};
+
 export const rules = {
   'rules-of-hooks': RuleOfHooks,
   'exhaustive-deps': ExhaustiveDeps,