@ithinkdt/lint 4.0.0-1 → 4.0.0-10

package/README.md

@@ -2,14 +2,15 @@
 
 安装 `npm i -D @ithinkdt/lint`
 
-- 集成`@eslint/js`的`recommended`推荐规则；
-- 集成`eslint-plugin-unicorn`的`flat/recommended`推荐规则；
-- 集成`eslint-plugin-vue`的`flat/recommended`推荐规则；
-- 集成`typescript-eslint`的`recommendedTypeChecked`，启用`Type Aware Rules 类型感知规则`，检查 ts、vue 文件的类型错误；
-- 集成`eslint-plugin-tsdoc`规则；
-- 集成`eslint-plugin-deprecation`规则;
-- 等待集成`eslint-plugin-import-x`规则;
-- 支持`StyleLint、Prettier`配置。
+- 集成 `@eslint/js` 的 `recommended` 推荐规则；
+- 集成 `typescript-eslint` 的 `recommendedTypeChecked`，启用 `Type Aware Rules 类型感知规则`，检查 ts、vue 文件的类型错误；
+- 集成 `eslint-plugin-vue`的`flat/recommended` 推荐规则；
+- 集成 `eslint-plugin-unicorn` 的 `flat/recommended` 推荐规则；
+- 集成 `@unocss/eslint-config` 的 `flat` 推荐规则；
+- 集成 `eslint-plugin-tsdoc` 规则；
+- 集成 `eslint-plugin-import-x` 规则;
+- 集成 `eslint-plugin-playwright`、`@vitest/eslint-plugin` 测试代码规则；
+- 支持 `StyleLint` 配置。
 
 > 由于启用了类型感知规则，原则上 typescript 会在整个项目上执行，推测 `lint-staged` 效果不佳。
 
@@ -50,22 +51,3 @@ export default {
     },
 }
 ```
-
-
-## Prettier
-
-安装 `npm i -D prettier`
-
-```js
-// prettier.config.js
-
-import ithinkdt from '@ithinkdt/lint/prettier'
-
-/**
- * @type {import('prettier').Config}
- */
-export default {
-    ...ithinkdt,
-    // 覆盖配置
-}
-```

package/package.json

@@ -1,81 +1,79 @@
 {
   "name": "@ithinkdt/lint",
-  "version": "4.0.0-1",
+  "version": "4.0.0-10",
   "type": "module",
-  "description": "iThinkDT Cloud Lint",
+  "description": "iThinkDT 项目的 ESLint、StyleLint 配置",
   "keywords": [
-    "vue",
     "ithinkdt",
+    "vue",
     "lint",
     "eslint",
-    "eslint-config",
-    "prettier",
     "stylelint"
   ],
   "files": [
-    "*"
+    "src"
   ],
   "main": "./src/index.js",
   "module": "./src/index.js",
+  "types": "./src/index.d.ts",
   "exports": {
     ".": {
       "types": "./src/index.d.ts",
       "default": "./src/index.js"
     },
-    "./prettier": {
-      "types": "./src/prettier.d.ts",
-      "default": "./src/prettier.js"
-    },
     "./stylelint": {
       "types": "./src/stylelint.d.ts",
       "default": "./src/stylelint.js"
     }
   },
   "publishConfig": {
-    "registry": " https://registry.npmjs.org/",
+    "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "sideEffects": false,
   "dependencies": {
-    "@eslint/compat": "^1.1.1",
-    "@typescript-eslint/parser": "^8.0.0-alpha.41",
-    "@vue/compiler-sfc": "^3.4.31",
+    "@eslint-community/eslint-plugin-eslint-comments": "^4.5.0",
+    "@eslint/js": "^9.37.0",
+    "@eslint/json": ">=0.13.2",
+    "@eslint/markdown": "7.4.0",
+    "@stylistic/eslint-plugin": "^5.4.0",
+    "@typescript-eslint/parser": "^8.46.0",
+    "@unocss/eslint-config": "^66.5.2",
+    "@vitest/eslint-plugin": "^1.3.16",
+    "@vue/compiler-sfc": "^3.5.22",
+    "eslint-flat-config-utils": "^2.1.4",
     "eslint-import-resolver-custom-alias": "^1.3.2",
-    "eslint-import-resolver-typescript": "^3.6.1",
-    "eslint-plugin-deprecation": "^3.0.0",
-    "eslint-plugin-import": "npm:eslint-plugin-import-x@^3.0.1",
-    "eslint-plugin-tsdoc": "^0.3.0",
-    "eslint-plugin-unicorn": "^54.0.0",
-    "eslint-plugin-vue": "^9.27.0",
-    "globby": "^14.0.2",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-merge-processors": "^2.0.0",
+    "eslint-plugin-format": "^1.0.2",
+    "eslint-plugin-import": "npm:eslint-plugin-import-x@^4.16.1",
+    "eslint-plugin-no-only-tests": "^3.3.0",
+    "eslint-plugin-playwright": "^2.2.2",
+    "eslint-plugin-tsdoc": ">=0.4.0",
+    "eslint-plugin-unicorn": "^61.0.2",
+    "eslint-plugin-vue": "^10.5.0",
+    "eslint-processor-vue-blocks": "^2.0.0",
+    "globby": "^15.0.0",
     "is-glob": "^4.0.3",
-    "postcss": "^8.4.39",
-    "postcss-html": "^1.7.0",
-    "postcss-scss": "^4.0.9",
-    "stylelint-config-recommended": "^14.0.1",
-    "stylelint-config-standard": "^36.0.1",
-    "stylelint-config-standard-scss": "^13.1.0",
+    "postcss-html": "^1.8.0",
+    "stylelint-config-standard": "^39.0.1",
     "stylelint-config-standard-vue": "^1.0.0",
-    "stylelint-order": "^6.0.4",
-    "stylelint-scss": "^6.4.1",
-    "typescript-eslint": "^8.0.0-alpha.41",
-    "vue-eslint-parser": "^9.4.3"
+    "stylelint-order": "^7.0.0",
+    "typescript-eslint": "^8.46.0",
+    "vue-eslint-parser": "^10.2.0"
   },
   "peerDependencies": {
-    "eslint": "^9.0.0",
-    "stylelint": "^16.0.0",
-    "prettier": "^3.0.0",
-    "typescript": "^5.0.0"
+    "eslint": ">=9",
+    "stylelint": ">=16",
+    "typescript": ">=5.8"
   },
   "devDependencies": {
-    "eslint": "^9.6.0",
-    "prettier": "^3.3.2",
-    "stylelint": "~16.6.1",
-    "typescript": "~5.5.3"
+    "eslint": "^9.37.0",
+    "stylelint": "~16.25.0",
+    "typescript": "~5.9.3"
   },
   "license": "MIT",
   "scripts": {
-    "format": "prettier --write \"./{src}/**/*.{js,vue,ts,jsx,tsx}\"",
     "release": "pnpm publish --no-git-checks"
   }
 }

package/src/base.js

@@ -1,198 +1,287 @@
-import { fixupPluginRules } from '@eslint/compat'
-import { config as tsconfig, configs as tsconfigs } from 'typescript-eslint'
-
 import js from '@eslint/js'
-import unicorn from 'eslint-plugin-unicorn'
-import tsdoc from 'eslint-plugin-tsdoc'
-import deprecation from 'eslint-plugin-deprecation'
+import json from '@eslint/json'
+import markdown from '@eslint/markdown'
+import comments from '@eslint-community/eslint-plugin-eslint-comments/configs'
+import stylistic from '@stylistic/eslint-plugin'
+import { composer } from 'eslint-flat-config-utils'
+import format from 'eslint-plugin-format'
 import importx from 'eslint-plugin-import'
+import noonlytests from 'eslint-plugin-no-only-tests'
+import tsdoc from 'eslint-plugin-tsdoc'
+import unicorn from 'eslint-plugin-unicorn'
+import { configs as tsconfigs } from 'typescript-eslint'
 
-export * as vueparser from 'vue-eslint-parser'
+export { default as vitest } from '@vitest/eslint-plugin'
+export { default as playwright } from 'eslint-plugin-playwright'
+export { default as vue } from 'eslint-plugin-vue'
 
-export { default as tsparser } from './typescript-eslint-parser-for-extra-files/index.js'
+export * as vueParser from 'vue-eslint-parser'
 
-export const disableJsTypeChecked = {
-    files: ['**/*.js', '**/*.cjs'],
+export { default as tsParser } from './tsparser-for-extra-files/index.js'
+
+export { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript'
+
+export const defaultJsFiles = ['**/*.cts', '**/*.js', '**/*.jsx', '**/*.cjs', '**/*.mjs']
+export const defaultTsFiles = ['**/*.ts', '**/*.tsx', '**/*.mts', '**/*.cts']
+export const defaultEsFiles = [...defaultTsFiles, ...defaultJsFiles, '**/*.vue']
+
+export const disableTypeChecked = {
     ...tsconfigs.disableTypeChecked,
+    files: defaultJsFiles,
 }
 
-export default tsconfig(
-    js.configs.recommended,
-    {
-        plugins: { 'import-x': importx },
-        settings: {
-            'import-x/extensions': ['.ts', '.tsx', '.js', '.jsx'],
-            'import-x/external-module-folders': ['node_modules', 'node_modules/@types'],
-            'import-x/parsers': {
-                '@typescript-eslint/parser': ['.ts', '.tsx', '.cts', '.mts'],
-            },
-            'import-x/resolver': {
-                node: {
-                    extensions: ['.ts', '.tsx', '.js', '.cjs', '.jsx'],
-                },
-                typescript: {
-                    alwaysTryTypes: true,
-                },
-            },
-        },
-        rules: {
-            'import-x/no-unresolved': 'error',
-            // 'import-x/named': 'error',
-            'import-x/namespace': 'error',
-            'import-x/default': 'error',
-            'import-x/export': 'error',
-            'import-x/no-named-as-default': 'warn',
-            'import-x/no-named-as-default-member': 'warn',
-            'import-x/no-duplicates': 'warn',
-            'import-x/named': 'off',
-        },
-    },
-    unicorn.configs['flat/recommended'],
-    ...tsconfigs.recommendedTypeChecked,
-    {
-        plugins: {
-            tsdoc,
-            deprecation: fixupPluginRules(deprecation),
+export function base({ stylistic: stylisticOptions, inCI }) {
+    return composer(
+        comments.recommended,
+        markdown.configs.recommended,
+        {
+            ...json.configs.recommended,
+            files: ['**/*.json'],
+            ignores: ['package-lock.json'],
+            language: 'json/json',
         },
-        rules: {
-            // ------ start copy from @vue/eslint-config-typescript
-
-            // The core 'no-unused-vars' rules (in the eslint:recommeded ruleset)
-            // does not work with type definitions
-            'no-unused-vars': 'off',
-            // TS already checks for that, and Typescript-Eslint recommends to disable it
-            // https://typescript-eslint.io/linting/troubleshooting#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
-            'no-undef': 'off',
-
-            // The following rules are enabled in an `overrides` field in the
-            // `@typescript-eslint/recommended` ruleset, only turned on for TypeScript source modules
-            // <https://github.com/typescript-eslint/typescript-eslint/blob/cb2d44650d27d8b917e8ce19423245b834db29d2/packages/eslint-plugin/src/configs/eslint-recommended.ts#L27-L30>
-
-            // But as ESLint cannot precisely target `<script lang="ts">` blocks and skip normal `<script>`,
-            // no TypeScript code in `.vue` files would be checked against these rules.
-
-            // So we now enable them globally.
-            // That would also check plain JavaScript files, which diverges a little from
-            // the original intention of the `@typescript-eslint/recommended` rulset.
-            // But it should be mostly fine.
-            'no-var': 'error', // ts transpiles let/const to var, so no need for vars any more
-            'prefer-const': ['error', { destructuring: 'all' }], // ts provides better types with const
-            'prefer-rest-params': 'error', // ts provides better types with rest args over arguments
-            'prefer-spread': 'error', // ts transpiles spread to apply, so no need for manual apply
-
-            // this rule, if on, would require explicit return type on the `render` function
-            '@typescript-eslint/explicit-function-return-type': 'off',
-
-            // ------ end
-
-            // 忽略下划线开始的变量名
-            '@typescript-eslint/no-unused-vars': [
-                'warn',
-                {
+        [js.configs.recommended,
+            unicorn.configs.recommended,
+            ...tsconfigs.recommendedTypeChecked,
+            importx.flatConfigs.recommended,
+            importx.flatConfigs.typescript,
+        ].map((it) => {
+            return {
+                ...it,
+                files: defaultEsFiles,
+            }
+        }),
+        stylisticOptions
+            ? [
+                    {
+                        ...stylistic.configs.customize(stylisticOptions),
+                        files: defaultEsFiles,
+                    },
+                    {
+                        files: ['**/*.css', '**/*.scss', '**/*.less'],
+                        languageOptions: {
+                            parser: format.parserPlain,
+                        },
+                        plugins: {
+                            format,
+                        },
+                        rules: {
+                            'format/prettier': ['warn', {
+                                parser: 'css',
+                                tabWidth: stylisticOptions.indent,
+                            }],
+                        },
+                    },
+                ]
+            : [],
+        {
+            files: defaultEsFiles,
+            rules: {
+                'comments/disable-enable-pair': ['error', {
+                    allowWholeFile: true,
+                }],
+                // see https://typescript-eslint.io/troubleshooting/typed-linting/performance#eslint-plugin-import
+                'import-x/no-unresolved': 'off',
+                'import-x/namespace': 'off',
+                'import-x/default': 'off',
+                'import-x/no-duplicates': ['warn', {
+                    considerQueryString: true,
+                }],
+                'import-x/extensions': 'off',
+                'import-x/no-unused-modules': 'off',
+                'import-x/no-deprecated': inCI ? 'error' : 'off',
+                'import-x/no-named-as-default': inCI ? 'warn' : 'off',
+                'import-x/no-named-as-default-member': 'off',
+                'import-x/no-cycle': ['error', {
+                    maxDepth: 2,
+                    ignoreExternal: true,
+                }],
+                'import-x/no-useless-path-segments': 'error',
+                'import-x/first': 'warn',
+                'import-x/exports-last': 'off',
+                'import-x/group-exports': 'off',
+                'import-x/newline-after-import': 'error',
+                'import-x/no-relative-packages': 'error',
+                'import-x/no-absolute-path': 'error',
+
+                // ------ start copy from @vue/eslint-config-typescript
+
+                // The core 'no-unused-vars' rules (in the eslint:recommeded ruleset)
+                // does not work with type definitions
+                'no-unused-vars': 'off',
+                // TS already checks for that, and Typescript-Eslint recommends to disable it
+                // https://typescript-eslint.io/linting/troubleshooting#i-get-errors-from-the-no-undef-rule-about-global-variables-not-being-defined-even-though-there-are-no-typescript-errors
+                'no-undef': 'off',
+
+                // The following rules are enabled in an `overrides` field in the
+                // `@typescript-eslint/recommended` ruleset, only turned on for TypeScript source modules
+                // <https://github.com/typescript-eslint/typescript-eslint/blob/cb2d44650d27d8b917e8ce19423245b834db29d2/packages/eslint-plugin/src/configs/eslint-recommended.ts#L27-L30>
+
+                // But as ESLint cannot precisely target `<script lang="ts">` blocks and skip normal `<script>`,
+                // no TypeScript code in `.vue` files would be checked against these rules.
+
+                // So we now enable them globally.
+                // That would also check plain JavaScript files, which diverges a little from
+                // the original intention of the `@typescript-eslint/recommended` rulset.
+                // But it should be mostly fine.
+                'no-var': 'error', // ts transpiles let/const to var, so no need for vars any more
+                'prefer-const': ['error', {
+                    destructuring: 'all',
+                }], // ts provides better types with const
+                'prefer-rest-params': 'error', // ts provides better types with rest args over arguments
+                'prefer-spread': 'error', // ts transpiles spread to apply, so no need for manual apply
+
+                // this rule, if on, would require explicit return type on the `render` function
+                // 'ts/explicit-function-return-type': 'off',
+
+                // ------ end
+
+                // 忽略下划线开始的变量名
+                'ts/no-unused-vars': ['warn', {
+                    args: 'after-used',
                     argsIgnorePattern: '^_',
                     varsIgnorePattern: '^_',
-                },
-            ],
-            // 允许非空断言
-            '@typescript-eslint/no-non-null-assertion': 'off',
-            // 空合并提示
-            '@typescript-eslint/prefer-nullish-coalescing': [
-                'warn',
-                {
+                    destructuredArrayIgnorePattern: '^_',
+                    ignoreRestSiblings: true,
+                    caughtErrors: 'none',
+                }],
+                // 允许非空断言
+                'ts/no-non-null-assertion': 'off',
+                // 空合并提示
+                'ts/prefer-nullish-coalescing': ['warn', {
                     ignoreConditionalTests: true,
                     ignoreTernaryTests: true,
                     ignoreMixedLogicalExpressions: true,
                     ignorePrimitives: true,
-                },
-            ],
-
-            '@typescript-eslint/no-empty-object-type': [
-                'error',
-                { allowInterfaces: 'with-single-extends', allowWithName: 'Props$' },
-            ],
+                }],
+                'ts/no-empty-object-type': ['error', {
+                    allowInterfaces: 'with-single-extends',
+                    allowWithName: 'Props$',
+                }],
 
-            '@typescript-eslint/no-explicit-any': ['error', { ignoreRestArgs: true }],
+                'ts/no-explicit-any': ['error', {
+                    ignoreRestArgs: true,
+                }],
 
-            // 允许未 catch 的 promise
-            '@typescript-eslint/no-floating-promises': 'off',
-            '@typescript-eslint/no-misused-promises': [
-                'warn',
-                {
+                // 允许未 catch 的 promise
+                'ts/no-floating-promises': 'off',
+                'ts/no-misused-promises': ['warn', {
                     checksVoidReturn: false,
-                },
-            ],
-            // 允许模版表达式使用数字
-            '@typescript-eslint/restrict-template-expressions': [
-                'warn',
-                {
+                }],
+                // 允许模版表达式使用数字
+                'ts/restrict-template-expressions': ['warn', {
                     allowNumber: true,
-                },
-            ],
+                }],
 
-            // 允许缩写
-            'unicorn/prevent-abbreviations': ['off'],
+                // 允许缩写
+                'unicorn/prevent-abbreviations': 'off',
 
-            // 不提升箭头函数
-            'unicorn/consistent-function-scoping': ['warn', { checkArrowFunctions: false }],
+                // 不提升箭头函数
+                'unicorn/consistent-function-scoping': ['warn', {
+                    checkArrowFunctions: false,
+                }],
 
-            // 文件名拼写忽略组件
-            'unicorn/filename-case': [
-                'warn',
-                {
+                // 文件名拼写忽略组件
+                'unicorn/filename-case': ['warn', {
                     case: 'kebabCase',
                     ignore: [String.raw`\.(j|t)sx$`, String.raw`\.vue`],
-                },
-            ],
+                }],
 
-            // Array.reduce 设为 警告
-            'unicorn/no-array-reduce': ['warn'],
+                // 忽略 Array.reduce
+                'unicorn/no-array-reduce': 'off',
 
-            // 重导出检查 忽略已用变量
-            'unicorn/prefer-export-from': ['error', { ignoreUsedVariables: true }],
+                // 重导出检查 忽略已用变量
+                'unicorn/prefer-export-from': ['error', {
+                    ignoreUsedVariables: true,
+                }],
 
-            // tla 设为 警告
-            'unicorn/prefer-top-level-await': ['warn'],
+                // tla 设为 警告
+                'unicorn/prefer-top-level-await': 'warn',
 
-            // 仅单行时优先三元表达式
-            'unicorn/prefer-ternary': ['warn', 'only-single-line'],
+                'unicorn/no-useless-undefined': ['warn', {
+                    checkArguments: false,
+                    checkArrowFunctionBody: false,
+                }],
+                'unicorn/no-null': 'off',
 
-            // 关闭 优先 String#replaceAll()，使用全局标志进行正则表达式搜索
-            'unicorn/prefer-string-replace-all': ['off'],
+                // 仅单行时优先三元表达式
+                'unicorn/prefer-ternary': ['warn',
+                    'only-single-line',
+                ],
 
-            // 关闭 优先 structuredClone()
-            'unicorn/prefer-structured-clone': 'off',
+                // 关闭 优先 String#replaceAll()，使用全局标志进行正则表达式搜索
+                'unicorn/prefer-string-replace-all': 'off',
 
-            // 与 @typescript-eslint/no-this-alias 重复
-            'unicorn/no-this-assignment': 'off',
+                // 关闭 优先 structuredClone()
+                'unicorn/prefer-structured-clone': 'off',
 
-            'unicorn/template-indent': 'off',
-            'unicorn/empty-brace-spaces': 'off',
-            'unicorn/no-nested-ternary': 'off',
-            'unicorn/number-literal-case': 'off',
+                // 与 ts/no-this-alias 重复
+                'unicorn/no-this-assignment': 'off',
+
+                'unicorn/template-indent': 'off',
+                'unicorn/empty-brace-spaces': 'off',
+                'unicorn/no-nested-ternary': 'off',
+                'unicorn/number-literal-case': 'off',
+                'unicorn/prefer-top-level-await': 'off',
+            },
         },
-    },
-    {
-        files: ['**/*.ts', '**/*.tsx'],
-        rules: {
-            // 启用 tsdoc 扫描
-            'tsdoc/syntax': 'warn',
-
-            // 启用 已弃用API 扫描
-            'deprecation/deprecation': 'error',
+        {
+            files: defaultTsFiles,
+            plugins: {
+                tsdoc,
+            },
+            rules: {
+                // 启用 tsdoc 扫描
+                'tsdoc/syntax': 'warn',
+                // 不允许使用标记为 @deprecated 的代码
+                'ts/no-deprecated': 'warn',
+            },
         },
-    },
-    {
-        files: ['**/*.d.ts'],
-        rules: {
-            '@typescript-eslint/no-explicit-any': ['warn', { ignoreRestArgs: true }],
-            'unicorn/no-abusive-eslint-disable': 'off',
+        {
+            files: ['**/*.d.ts'],
+            rules: {
+                'ts/no-explicit-any': ['warn', {
+                    ignoreRestArgs: true,
+                }],
+                'ts/no-empty-object-type': 'off',
+                'unicorn/no-abusive-eslint-disable': 'off',
+            },
         },
-    },
-    {
-        files: ['**/*.cjs'],
-        rules: {
-            // in plain CommonJS modules, you can't use `import foo = require('foo')` to pass this rule, so it has to be disabled
-            '@typescript-eslint/no-require-imports': 'off',
+        {
+            files: ['**/shims-*.d.ts'],
+            rules: {
+                'comments/no-unlimited-disable': 'off',
+            },
         },
-    },
-)
+        {
+            files: ['**/*.cjs'],
+            rules: {
+                // in plain CommonJS modules, you can't use `import foo = require('foo')` to pass this rule, so it has to be disabled
+                'ts/no-require-imports': 'off',
+            },
+        },
+        {
+            files: ['**/tests/**'],
+            plugins: {
+                'no-only-tests': noonlytests,
+            },
+            rules: {
+                'test/no-only-tests': ['error', {
+                    fix: inCI ? true : false,
+                }],
+            },
+        },
+        {
+            files: ['**/locales/**'],
+            rules: {
+                // 文件名拼写忽略 locale
+                'unicorn/filename-case': 'off',
+            },
+        },
+    ).renamePlugins({
+        'no-only-tests': 'test',
+        '@typescript-eslint': 'ts',
+        '@stylistic': 'style',
+        '@eslint-community/eslint-comments': 'comments',
+    })
+}

package/src/index.d.ts

@@ -1,4 +1,18 @@
+import { StylisticCustomizeOptions } from '@stylistic/eslint-plugin'
 import { Config } from 'typescript-eslint'
 
-declare const config: Config
-export default config
+export { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript'
+
+/** Options for {@link lintConfig} */
+export interface LintOptions {
+    /** 是否启用 \@unocss/eslint-config */
+    unocss?: boolean
+    /** 是否启用 \@stylistic/eslint-plugin */
+    stylistic?: boolean | StylisticCustomizeOptions
+
+    /** 指定 TSConfig 根目录 */
+    tsconfigRootDir?: string
+}
+
+declare const lintConfig: (options?: LintOptions) => Config
+export default lintConfig