eslint-config-gorgon 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 weipengzou
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,38 @@
+### Install
+
+```zsh
+pnpm i -D eslint-config-grogon-lint
+```
+
+### Start
+
+in your eslintrc file
+
+```json
+// .eslintrc
+{
+  "extends": ["gorgon-lint"]
+}
+```
+
+### Why Need
+
+- eslint
+- typescript
+- react
+- ...more lint
+
+Dont want install more deps ？
+
+Just two steps ~
+
+1. `pnpm i -D eslint-config-grogon-lint`
+2. create `.eslintrc` file and set `"extends": ["gorgon-lint"]`
+
+### How it work
+
+[using-a-shareable-configuration-package](https://eslint.org/docs/latest/use/configure/configuration-files#using-a-shareable-configuration-package)
+
+### Desc
+
+> just collect recommended eslint, no more custom rules.

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "eslint-config-gorgon",
+  "version": "0.0.0",
+  "main": "src/index.js",
+  "license": "MIT",
+  "keywords": [
+    "airbnb",
+    "eslint",
+    "config"
+  ],
+  "files": [
+    "src"
+  ],
+  "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.55.0",
+    "@typescript-eslint/parser": "^5.55.0",
+    "eslint-config-airbnb": "^19.0.4",
+    "eslint-config-airbnb-typescript": "^17.0.0",
+    "eslint-config-prettier": "^8.7.0",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-simple-import-sort": "^10.0.0"
+  },
+  "devDependencies": {
+    "eslint": "^8.36.0",
+    "typescript": "^4.9.5"
+  }
+}

package/src/index.js

@@ -0,0 +1,12 @@
+const extendsList = [
+  './rules/base.js',
+  './rules/react-hooks.js',
+  './rules/imports.js',
+  './rules/typescript.js',
+].map((item) => require.resolve(item));
+
+const config = {
+  extends: extendsList,
+};
+
+module.exports = config;

package/src/rules/base.js

@@ -0,0 +1,12 @@
+const config = {
+  extends: [
+    'airbnb',
+    'airbnb-typescript'
+  ],
+  rules: {
+    // handle console
+    'no-console': 'warn'
+  },
+};
+
+module.exports = config;

package/src/rules/imports.js

@@ -0,0 +1,9 @@
+const config = {
+  plugins: ['simple-import-sort'],
+  rules: {
+    // handle import
+    'simple-import-sort/imports': 'error',
+    'simple-import-sort/exports': 'error',
+  },
+};
+module.exports = config;

package/src/rules/prettier.js

@@ -0,0 +1,7 @@
+const config = {
+    extends: [
+        'prettier',
+    ]
+};
+
+module.exports = config;

package/src/rules/react-hooks.js

@@ -0,0 +1,17 @@
+const config = {
+  plugins: ['react-hooks'],
+  parserOptions: {
+    ecmaFeatures: {
+      jsx: true,
+    },
+  },
+  rules: {
+    // Enforce Rules of Hooks
+    // https://github.com/facebook/react/blob/c11015ff4f610ac2924d1fc6d569a17657a404fd/packages/eslint-plugin-react-hooks/src/RulesOfHooks.js
+    'react-hooks/rules-of-hooks': 'error',
+    // Verify the list of the dependencies for Hooks like useEffect and similar
+    // https://github.com/facebook/react/blob/1204c789776cb01fbaf3e9f032e7e2ba85a44137/packages/eslint-plugin-react-hooks/src/ExhaustiveDeps.js
+    'react-hooks/exhaustive-deps': 'error',
+  },
+};
+module.exports = config;

package/src/rules/typescript.js

@@ -0,0 +1,11 @@
+const config = {
+  extends: ['plugin:@typescript-eslint/recommended'],
+  parser: '@typescript-eslint/parser',
+  plugins: ['@typescript-eslint'],
+  rules: {
+    // handle unused
+    '@typescript-eslint/no-unused-vars': 'error',
+    "@typescript-eslint/no-shadow": 'off'
+  },
+};
+module.exports = config;