@agilebot/eslint-config 0.1.1

package/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Agilebot, Inc.
+
+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,17 @@
+# @agilebot/eslint-config
+
+### Usage
+
+```bash
+npm install --save-dev eslint \
+  @agilebot/eslint-config \
+  @agilebot/eslint-plugin \
+  @agilebot/eslint-utils
+```
+
+```js
+// .eslintrc.js
+const { agilebot } = require('@agilebot/eslint-utils');
+
+module.exports = agilebot(__dirname);
+```

package/lib/configs/agilebot.js

@@ -0,0 +1,12 @@
+module.exports = {
+  extends: ['plugin:@agilebot/recommended'],
+  rules: {
+    // 禁止使用inline style，应该使用mui的sx属性或tss或styled-component
+    '@agilebot/react/no-inline-styles': [
+      'error',
+      {
+        allowedFor: ['Grow']
+      }
+    ]
+  }
+};

package/lib/configs/cspell.js

@@ -0,0 +1,12 @@
+module.exports = {
+  plugins: ['@cspell'],
+  rules: {
+    '@cspell/spellchecker': [
+      'warn',
+      {
+        checkComments: false,
+        autoFix: false
+      }
+    ]
+  }
+};

package/lib/configs/deprecation.js

@@ -0,0 +1,7 @@
+module.exports = {
+  plugins: ['deprecation'],
+  rules: {
+    // 禁止使用带有deprecation标记的方法或属性
+    'deprecation/deprecation': 'error'
+  }
+};

package/lib/configs/env.js

@@ -0,0 +1,10 @@
+module.exports = {
+  env: {
+    browser: true,
+    node: true,
+    es6: true,
+    mocha: true,
+    jest: true,
+    jasmine: true
+  }
+};

package/lib/configs/eslint.js

@@ -0,0 +1,23 @@
+const { isCI } = require('@agilebot/eslint-utils');
+
+module.exports = {
+  plugins: ['eslint-comments', 'file-progress'],
+  rules: {
+    // 禁止未使用的eslint-disable注释
+    'eslint-comments/no-unused-disable': 'error',
+    // 禁止无限制的eslint-disable注释
+    'eslint-comments/no-unlimited-disable': 'error',
+    // 禁止重复的eslint-disable注释
+    'eslint-comments/no-duplicate-disable': 'error',
+    // 禁止聚合的eslint-enable注释
+    'eslint-comments/no-aggregating-enable': 'error',
+    // eslint-disable须说明原因
+    'eslint-comments/require-description': [
+      'error',
+      {
+        ignore: ['eslint-env', 'exported', 'global', 'globals']
+      }
+    ],
+    'file-progress/activate': isCI() ? 'off' : 'warn'
+  }
+};

package/lib/configs/godaddy.js

@@ -0,0 +1,19 @@
+// config for eslint plugins, DO NOT use for ts
+module.exports = {
+  extends: ['godaddy'],
+  rules: {
+    'quote-props': 'off',
+    'linebreak-style': 'off',
+    complexity: 'off',
+    'max-statements': 'off',
+    'id-length': 'off',
+    'default-case': 'off',
+    'valid-jsdoc': 'off',
+    'generator-star-spacing': 'off',
+    'max-params': 'off',
+    'max-depth': 'off',
+    'no-undefined': 'off',
+    'no-process-env': 'off',
+    'no-sync': 'off'
+  }
+};

package/lib/configs/import.js

@@ -0,0 +1,40 @@
+module.exports = {
+  plugins: ['import', 'no-relative-import-paths'],
+  extends: ['plugin:import/recommended', 'plugin:import/typescript'],
+  rules: {
+    'import/no-unresolved': 'error',
+    'import/no-named-as-default-member': 'off',
+    'import/no-named-as-default': 'off',
+    'import/no-useless-path-segments': [
+      'error',
+      {
+        noUselessIndex: true
+      }
+    ],
+    'import/no-cycle': 'error',
+    'import/newline-after-import': 'error',
+    'import/first': 'error',
+    'import/no-import-module-exports': 'error',
+    'import/no-anonymous-default-export': [
+      'error',
+      {
+        allowArray: true,
+        allowObject: true
+      }
+    ],
+    'no-relative-import-paths/no-relative-import-paths': [
+      'warn',
+      { allowSameFolder: true }
+    ]
+  },
+  settings: {
+    'import/parsers': {
+      '@typescript-eslint/parser': ['.ts', '.tsx']
+    },
+    'import/resolver': {
+      typescript: {
+        alwaysTryTypes: true
+      }
+    }
+  }
+};

package/lib/configs/jsdoc.js

@@ -0,0 +1,14 @@
+module.exports = {
+  plugins: ['jsdoc'],
+  extends: ['plugin:jsdoc/recommended-typescript-error'],
+  rules: {
+    // 禁止有空行
+    'jsdoc/no-blank-block-descriptions': 'error',
+    'jsdoc/no-blank-blocks': 'error',
+    'jsdoc/require-returns': 'off',
+    // @return注释不是很有必要
+    'jsdoc/require-returns-type': 'off',
+    // 每行注释都有星号
+    'jsdoc/require-asterisk-prefix': 'error'
+  }
+};

package/lib/configs/lodash.js

@@ -0,0 +1,4 @@
+module.exports = {
+  // lodash一些方法可能影响性能，如forEach等，优先使用js的原生方法
+  extends: ['plugin:you-dont-need-lodash-underscore/compatible']
+};

package/lib/configs/prettier.js

@@ -0,0 +1,12 @@
+module.exports = {
+  plugins: ['prettier'],
+  extends: ['plugin:prettier/recommended'],
+  rules: {
+    'prettier/prettier': [
+      'error',
+      {
+        endOfLine: 'auto'
+      }
+    ]
+  }
+};

package/lib/configs/promise.js

@@ -0,0 +1,10 @@
+module.exports = {
+  plugins: ['promise'],
+  rules: {
+    'promise/no-nesting': 'error',
+    'promise/no-promise-in-callback': 'error',
+    'promise/param-names': 'error',
+    'promise/no-multiple-resolved': 'error',
+    'promise/no-return-in-finally': 'error'
+  }
+};

package/lib/configs/react.js

@@ -0,0 +1,60 @@
+module.exports = {
+  plugins: ['react', 'react-hooks', 'jsx-a11y'],
+  extends: [
+    'plugin:react/recommended',
+    'plugin:react-hooks/recommended',
+    'plugin:react-prefer-function-component/recommended',
+    'plugin:jsx-a11y/recommended'
+  ],
+  rules: {
+    // 禁止没必要的Fragment，除了<>{foo}</>
+    'react/jsx-no-useless-fragment': ['error', { allowExpressions: true }],
+    // 优先使用<>而不是<Fragment>
+    'react/jsx-fragments': 'error',
+    'react/jsx-handler-names': [
+      'error',
+      {
+        eventHandlerPrefix: 'handle',
+        eventHandlerPropPrefix: 'on',
+        checkLocalVariables: true
+      }
+    ],
+    // useState必须以[example, setExample]命名
+    'react/hook-use-state': 'error',
+    // 避免使用数组的 index 来作为 key 属性的值
+    'react/no-array-index-key': 'error',
+    'react/self-closing-comp': 'error',
+    // 组件命名符合帕斯卡
+    'react/jsx-pascal-case': [
+      'error',
+      {
+        allowNamespace: true
+      }
+    ],
+    // 布尔属性如果为true，省略值
+    'react/jsx-boolean-value': 'error',
+    // 已经有ts校验，此规则没有必要，会与带静态属性的Functional Component冲突
+    'react/prop-types': 'off',
+    // <App prop={'Hello'} />没必要，使用<App prop="Hello" />
+    'react/jsx-curly-brace-presence': [
+      'error',
+      {
+        props: 'never',
+        children: 'never',
+        propElementValues: 'always'
+      }
+    ],
+    // 禁止声明未使用的props
+    'react/no-unused-prop-types': 'error',
+    // img之类的void元素不应该有children
+    'react/void-dom-elements-no-children': 'error',
+    'jsx-a11y/click-events-have-key-events': 'off',
+    'jsx-a11y/no-static-element-interactions': 'off',
+    'jsx-a11y/alt-text': 'off'
+  },
+  settings: {
+    react: {
+      version: 'detect'
+    }
+  }
+};

package/lib/configs/standard.js

@@ -0,0 +1,21 @@
+module.exports = {
+  extends: ['love'],
+  rules: {
+    'no-alert': 'error',
+    // 避免使用同步方法
+    'n/no-sync': 'error',
+    // 尽量使用fs.promises而不是fs
+    'n/prefer-promises/fs': 'error',
+    'arrow-body-style': 'error',
+    curly: 'error',
+    // 找出TODO注释，以便后期修复
+    'no-warning-comments': [
+      'warn',
+      {
+        terms: ['todo', 'fixme']
+      }
+    ],
+    // 路径拼接使用path.join，而不是直接使用加号
+    'n/no-path-concat': 'error'
+  }
+};

package/lib/configs/ts.js

@@ -0,0 +1,76 @@
+module.exports = {
+  plugins: ['@typescript-eslint', '@stylistic'],
+  rules: {
+    // 如果没用模板字符串，避免使用反引号
+    '@stylistic/quotes': ['error', 'single', { avoidEscape: true }],
+    // 优先使用interface而不是type
+    '@typescript-eslint/consistent-type-definitions': 'error',
+    // The `@typescript-eslint/naming-convention` rule allows `leadingUnderscore` and `trailingUnderscore` settings.
+    // However, the existing `no-underscore-dangle` rule already takes care of this.
+    '@typescript-eslint/naming-convention': [
+      'error',
+      // Allow camelCase variables (23.2), PascalCase variables (23.8), and UPPER_CASE variables (23.10)
+      {
+        selector: 'variable',
+        format: ['camelCase', 'PascalCase', 'UPPER_CASE']
+      },
+      // Allow camelCase functions (23.2), and PascalCase functions (23.8)
+      {
+        selector: 'function',
+        format: ['camelCase', 'PascalCase']
+      },
+      // Airbnb recommends PascalCase for classes (23.3),
+      // and although Airbnb does not make TypeScript recommendations,
+      // we are assuming this rule would similarly apply to anything "type like",
+      // including interfaces, type aliases, and enums
+      {
+        selector: 'typeLike',
+        format: ['PascalCase']
+      },
+      {
+        selector: 'parameter',
+        format: ['camelCase'],
+        leadingUnderscore: 'allow'
+      },
+      {
+        selector: 'method',
+        format: ['camelCase', 'PascalCase']
+      },
+      {
+        selector: 'typeProperty',
+        format: ['camelCase']
+      },
+      {
+        selector: 'enumMember',
+        format: ['PascalCase', 'UPPER_CASE']
+      }
+    ],
+    // 禁止没有必要的初始化
+    '@typescript-eslint/no-inferrable-types': 'error',
+    // 函数中未使用await，函数签名不要加async
+    '@typescript-eslint/require-await': 'error',
+    // 没有必要的类型as
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    // 数组用T[]而不是Array<T>
+    '@typescript-eslint/array-type': ['error', { default: 'array' }],
+    // Promise必须加await或void
+    '@typescript-eslint/no-misused-promises': [
+      'error',
+      {
+        checksVoidReturn: false
+      }
+    ],
+    // 以下是关闭的规则
+    '@typescript-eslint/strict-boolean-expressions': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    '@typescript-eslint/restrict-template-expressions': 'off',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/method-signature-style': 'off',
+    '@typescript-eslint/consistent-type-assertions': 'off',
+    '@typescript-eslint/no-extraneous-class': 'off',
+    '@typescript-eslint/no-confusing-void-expression': 'off',
+    '@typescript-eslint/explicit-member-accessibility': 'off',
+    '@typescript-eslint/unbound-method': 'off',
+    '@typescript-eslint/no-unsafe-argument': 'off'
+  }
+};

package/lib/configs/unicorn.js

@@ -0,0 +1,35 @@
+module.exports = {
+  plugins: ['unicorn'],
+  extends: ['plugin:unicorn/recommended'],
+  rules: {
+    // unicorn默认规则太严格，屏蔽以下
+    'unicorn/filename-case': 'off',
+    'unicorn/import-style': 'off',
+    'unicorn/prefer-at': 'off',
+    'unicorn/prevent-abbreviations': 'off',
+    'unicorn/prefer-date-now': 'off',
+    'unicorn/no-process-exit': 'off',
+    'unicorn/prefer-module': 'off',
+    'unicorn/no-null': 'off',
+    'unicorn/prefer-top-level-await': 'off',
+    'unicorn/consistent-function-scoping': 'off',
+    'unicorn/numeric-separators-style': 'off',
+    'unicorn/prefer-optional-catch-binding': 'off',
+    'unicorn/no-negated-condition': 'off',
+    'unicorn/switch-case-braces': 'off',
+    'unicorn/no-array-for-each': 'off',
+    'unicorn/prefer-ternary': 'off',
+    'unicorn/better-regex': 'off',
+    'unicorn/error-message': 'off',
+    'unicorn/no-object-as-default-parameter': 'off',
+    'unicorn/no-array-push-push': 'off',
+    'unicorn/no-useless-undefined': 'off',
+    'unicorn/prefer-blob-reading-methods': 'off',
+    'unicorn/catch-error-name': [
+      'error',
+      {
+        name: 'err'
+      }
+    ]
+  }
+};

package/lib/index.js

@@ -0,0 +1,51 @@
+module.exports = {
+  overrides: [
+    {
+      files: [
+        '*.ts',
+        '*.tsx',
+        '*.cts',
+        '*.mts',
+        '*.js',
+        '*.jsx',
+        '*.cjs',
+        '*.mjs'
+      ],
+      parser: '@typescript-eslint/parser',
+      extends: [
+        './configs/env',
+        './configs/standard',
+        './configs/ts',
+        './configs/promise',
+        './configs/import',
+        './configs/unicorn',
+        './configs/react',
+        './configs/jsdoc',
+        './configs/lodash',
+        './configs/eslint',
+        './configs/deprecation',
+        './configs/cspell',
+        './configs/agilebot',
+        // prettier始终放在最后
+        './configs/prettier'
+      ]
+    },
+    {
+      files: ['*.ts', '*.tsx'],
+      rules: {
+        '@typescript-eslint/explicit-member-accessibility': 'error'
+      }
+    },
+    {
+      files: ['*.d.ts'],
+      rules: {
+        // .d.ts中支持导入ts文件中的类型
+        '@typescript-eslint/consistent-type-imports': 'off',
+        // .d.ts中忽略属性命名规则
+        '@typescript-eslint/naming-convention': 'off',
+        // .d.ts中忽略三斜线引用
+        '@typescript-eslint/triple-slash-reference': 'off'
+      }
+    }
+  ]
+};

package/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@agilebot/eslint-config",
+  "version": "0.1.1",
+  "description": "Agilebot's ESLint config",
+  "main": "lib",
+  "license": "MIT",
+  "repository": {
+    "url": "sh-agilebot/frontend-toolkit",
+    "directory": "packages/eslint-config"
+  },
+  "homepage": "https://github.com/sh-agilebot/frontend-toolkit/tree/master/packages/eslint-config#readme",
+  "dependencies": {
+    "@cspell/eslint-plugin": "^8.6.0",
+    "@stylistic/eslint-plugin": "^1.7.0",
+    "@typescript-eslint/eslint-plugin": "^7.1.1",
+    "@typescript-eslint/parser": "^7.1.1",
+    "eslint-config-godaddy": "^6.0.0",
+    "eslint-config-love": "^43.1.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-deprecation": "^2.0.0",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-file-progress": "^1.3.0",
+    "eslint-plugin-import": "npm:eslint-plugin-i@^2.29.1",
+    "eslint-plugin-jsdoc": "^48.2.1",
+    "eslint-plugin-jsx-a11y": "^6.8.0",
+    "eslint-plugin-n": "^16.6.2",
+    "eslint-plugin-no-relative-import-paths": "^1.5.2",
+    "eslint-plugin-prettier": "^5.1.3",
+    "eslint-plugin-promise": "^6.0.0",
+    "eslint-plugin-react": "^7.34.1",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-react-prefer-function-component": "^3.3.0",
+    "eslint-plugin-unicorn": "^51.0.1",
+    "eslint-plugin-you-dont-need-lodash-underscore": "^6.13.0"
+  },
+  "devDependencies": {
+    "@agilebot/eslint-utils": "0.1.1"
+  },
+  "peerDependencies": {
+    "@agilebot/eslint-plugin": "*",
+    "@agilebot/eslint-utils": "*",
+    "eslint": "^8.0.0"
+  },
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "lint": "eslint lib --fix"
+  }
+}