feat: react conf

danielc92 · May 8, 2023 · 4e1ce1a · 4e1ce1a
1 parent ce848e3
commit 4e1ce1a
Show file tree

Hide file tree

Showing 8 changed files with 2,009 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -20,3 +20,26 @@ create a eslint config file `.eslintrc.js`
 ```js
 module.exports = { extends: ["eslint-config-platypus"] }
 ```
+
+The default configuration contains rules for 
+- code quality
+- formatting
+- jest
+- secrets
+- typescript
+
+If you wish to also the React configuration, which includes react hooks and react rules, install additional dependencies:
+
+```
+npm i eslint-plugin-react eslint-plugin-react-hooks --save-dev
+```
+
+Next extend the eslint config
+
+```js
+module.exports = { extends: [
+    "eslint-config-platypus",
+    "eslint-config-platypus/react-addon"
+    ] }
+```
+```
diff --git a/main.js b/main.js
@@ -3,7 +3,7 @@ const base = require('./src/configs/base');
 
 module.exports = {
 
-   ... base,
+   ...base,
    'extends': [ 'eslint:recommended', 'plugin:@typescript-eslint/recommended', 'plugin:promise/recommended' ],
    'plugins': [ '@typescript-eslint', 'no-secrets', 'sonarjs', 'promise' ],
    'parser': '@typescript-eslint/parser',