@stdex/presets-eslint-typescript 1.0.0 → 1.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 安坚实
+
+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,7 @@
+# 通用 ESLint 配置（针对 TypeScript 项目）
+
+General ESLint Configurations(For TypeScript Projects)
+
+详细介绍和使用方法见：[presets-eslint/README.md](../README.md)
+
+For detailed documentation and usage instructions, see [presets-eslint/README_EN.md](../README_EN.md).

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stdex/presets-eslint-typescript",
-  "version": "1.0.0",
-  "description": "公共 ESLint 配置",
+  "version": "1.0.1",
+  "description": "通用 ESLint 配置（针对 TypeScript 项目） - General ESLint Configurations(For TypeScript Projects) ",
   "homepage": "https://github.com/anjianshi/stdex-packages/presets-eslint/",
   "bugs": {
     "url": "https://github.com/anjianshi/stdex-packages/issues",
@@ -9,19 +9,23 @@
   },
   "license": "MIT",
   "author": "anjianshi <anjianshi@gmail.com>",
-  "repository": "github:anjianshi/stdex-packages",
+  "repository": {
+    "type": "git",
+    "url": "github:anjianshi/stdex-packages"
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "main": "index.mjs",
   "dependencies": {
-    "@stdex/presets-eslint-base": "workspace:*",
+    "@stdex/presets-eslint-base": "1.0.1",
     "eslint-config-prettier": "^10.1.8",
     "eslint-import-resolver-typescript": "^4.4.5",
+    "eslint-plugin-import-x": "^4.17.1",
     "typescript-eslint": "^8.64.0"
   },
   "peerDependencies": {
     "eslint": "^10.6.0"
   }
-}
+}

package/parts/import.mjs

@@ -1,7 +1,12 @@
 /**
  * import 检验配置
  * 参考自 eslint-plugin-import-x 的 flatConfigs.typescript 内容
+ *
+ * Import validation configuration.
+ * Based on the `flatConfigs.typescript` configuration from `eslint-plugin-import-x`.
  */
+import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript'
+import { createNodeResolver } from 'eslint-plugin-import-x'
 import { tsExtensions, tsFiles } from './common.mjs'
 
 export default {
@@ -13,24 +18,23 @@ export default {
     'import-x/external-module-folders': ['node_modules', 'node_modules/@types'],
 
     // 指定哪些扩展名的文件需要进一步解析（以看其导出了哪些内容）
+    // Specify which file extensions require further parsing to determine their exports.
     'import-x/extensions': [...tsExtensions, 'js', 'mjs', 'cjs', 'jsx', 'mjsx', 'cjsx'],
 
     // 指定各扩展名要使用什么 parser 来解析(以看其导出了哪些内容)
     // 未指定的当做普通 JavaScript 文件处理
+    // Specify which parser to use for each file extension to determine its exports.
+    // Unspecified extensions are treated as regular JavaScript files.
     'import-x/parsers': {
       '@typescript-eslint/parser': [...tsExtensions],
     },
 
-    'import-x/resolver': {
-      node: true,
-      typescript: {
-        project: './',
-      },
-    },
+    'import-x/resolver-next': [createTypeScriptImportResolver(), createNodeResolver()],
   },
 
   rules: {
-    // TypeScript 会自行检查以下项目，禁用它们以避免冲突并提升性能.
+    // TypeScript 会自行检查以下项目，禁用它们以避免冲突并提升性能。
+    // TypeScript checks the following items itself, so disable these rules to avoid conflicts and improve performance.
     // <https://typescript-eslint.io/troubleshooting/typed-linting/performance#eslint-plugin-import>
     'import-x/default': 'off',
     'import-x/named': 'off',

package/parts/main.mjs

@@ -1,16 +1,22 @@
 /*
 【一些规则不启用的理由】
+【Reasons for disabling certain rules】
+
 @typescript-eslint/consistent-type-definitions
     未能覆盖所有情况，有些时候必须用 type，不能用 interface，但它识别不出来。
+    Does not cover all cases. In some situations, type must be used instead of interface, but the rule cannot detect them.
 
 @typescript-eslint/no-invalid-void-type
     不能很好地覆盖所有情况，例如一个类型有个 generic type，是最终用于定义函数返回值的，本应允许是 void，但这条规则不允许。
+    Does not handle all cases well. For example, if a generic type parameter is ultimately used as a function's return type, void should be allowed, but this rule rejects it.
 
 @typescript-eslint/no-meaningless-void-operator
     和 no-confusing-void-expression 的规则冲突。
+    Conflicts with the no-confusing-void-expression rule.
 
 @typescript-eslint/prefer-optional-chain
     和其他规则起冲突。
+    Conflicts with other rules.
 */
 import { tsFiles } from './common.mjs'
 
@@ -26,10 +32,14 @@ export default {
   },
 
   rules: {
-    'default-case': 'off', // 交给 @typescript-eslint/switch-exhaustiveness-check 规则来检查 switch
-    'no-void': 'off', // Typescript 里 void 符号另有用途
+    // 交给 @typescript-eslint/switch-exhaustiveness-check 规则来检查 switch
+    // Leave `switch` statement checks to the `@typescript-eslint/switch-exhaustiveness-check` rule.
+    'default-case': 'off',
+
+    // Typescript 里 void 符号另有用途
+    // `void` has other uses in TypeScript.
+    'no-void': 'off',
 
-    // Supported Rules
     '@typescript-eslint/ban-ts-comment': ['error', { 'ts-ignore': 'allow-with-description' }],
     '@typescript-eslint/consistent-type-exports': [
       'error',
@@ -37,7 +47,10 @@ export default {
     ],
     '@typescript-eslint/consistent-type-imports': ['error', { fixStyle: 'inline-type-imports' }],
     '@typescript-eslint/explicit-member-accessibility': ['error', { accessibility: 'no-public' }],
-    '@typescript-eslint/no-confusing-void-expression': ['off', { ignoreVoidOperator: true }], // 在 https://github.com/typescript-eslint/typescript-eslint/issues/8538 修复后再考虑启用
+    '@typescript-eslint/no-confusing-void-expression': [
+      'error',
+      { ignoreArrowShorthand: true, ignoreVoidOperator: true, ignoreVoidReturningFunctions: true },
+    ],
     '@typescript-eslint/no-explicit-any': ['error', { fixToUnknown: false, ignoreRestArgs: true }],
     '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'error',
     '@typescript-eslint/no-misused-promises': ['error', { checksVoidReturn: false }],
@@ -46,21 +59,33 @@ export default {
     '@typescript-eslint/no-unnecessary-condition': ['error', { allowConstantLoopConditions: true }],
     '@typescript-eslint/no-unnecessary-qualifier': 'error',
     '@typescript-eslint/prefer-enum-initializers': 'error',
+
     // 一个很常见的情况是在 Promise 中，我们得到了一个错误对象，知道它是 Error 但标注出的类型确是 unknown。
     // 如果我们选择用 reject(error as Error) 来抛出错误，@typescript-eslint/no-unnecessary-type-assertion 规则会报错，
     // 因为 reject 能接收任意类型，这个 `as Error` 被认为不必要。
     // 但不加 `as Error`，又会提示只能抛出 Error。
     // 所以这里干脆允许抛出 unknown。
+    // A common case occurs with Promises: we receive an error object that we know is an `Error`, but its declared type is `unknown`.
+    // If we use `reject(error as Error)`, the `@typescript-eslint/no-unnecessary-type-assertion` rule reports an error because `reject` accepts values of any type, making the `as Error` assertion unnecessary.
+    // However, without `as Error`, another rule complains that only `Error` objects may be thrown.
+    // Therefore, we simply allow `unknown` values to be thrown here.
     '@typescript-eslint/prefer-promise-reject-errors': ['error', { allowThrowingUnknown: true }],
+
     '@typescript-eslint/prefer-readonly': 'error',
     '@typescript-eslint/promise-function-async': 'error',
     '@typescript-eslint/require-array-sort-compare': ['error', { ignoreStringArrays: true }],
     '@typescript-eslint/restrict-template-expressions': ['error', { allowNumber: true }],
-    '@typescript-eslint/strict-boolean-expressions': 'off', // 这个规则不能正确判断 object | null | boolean 的情况
+
+    // 这个规则不能正确判断 object | null | boolean 的情况
+    // This rule does not correctly handle the `object | null | boolean` case.
+    '@typescript-eslint/strict-boolean-expressions': 'off',
+
     '@typescript-eslint/switch-exhaustiveness-check': 'error',
-    '@typescript-eslint/unbound-method': 'off', // 此规则对有些情况适配的不好
 
-    // Extension Rules
+    // 此规则对有些情况适配的不好
+    // This rule does not handle certain cases well.
+    '@typescript-eslint/unbound-method': 'off',
+
     'default-param-last': 'off',
     '@typescript-eslint/default-param-last': 'error',
     '@typescript-eslint/no-empty-function': 'off',
@@ -83,7 +108,6 @@ export default {
     'no-useless-constructor': 'off',
     '@typescript-eslint/no-useless-constructor': 'error',
     '@typescript-eslint/return-await': 'error',
-
     'import-x/no-duplicates': ['error', { 'prefer-inline': true, considerQueryString: true }],
   },
 }