style: add @typescript-eslint/eslint-plugin plugin (#8978)

Co-authored-by: 三咲智子 Kevin Deng <[email protected]>

Author: Alfred-Skyblue

.eslintrc.cjs

@@ -16,9 +16,10 @@ const banConstEnum = {
 module.exports = {
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    sourceType: 'module'
+    sourceType: 'module',
+    project: './tsconfig.eslint.json'
   },
-  plugins: ['jest', 'import'],
+  plugins: ['jest', 'import', '@typescript-eslint'],
   rules: {
     'no-debugger': 'error',
     // most of the codebase are expected to be env agnostic
@@ -38,7 +39,23 @@ module.exports = {
     'import/no-nodejs-modules': [
       'error',
       { allow: builtinModules.map(mod => `node:${mod}`) }
-    ]
+    ],
+    // This rule enforces the preference for using '@ts-expect-error' comments in TypeScript
+    // code to indicate intentional type errors, improving code clarity and maintainability.
+    '@typescript-eslint/prefer-ts-expect-error': 'error',
+    // Avoid unnecessary type assertions
+    '@typescript-eslint/no-unnecessary-type-assertion': 'error',
+    // Enforce the use of 'import type' for importing types
+    '@typescript-eslint/consistent-type-imports': [
+      'error',
+      {
+        fixStyle: 'inline-type-imports'
+      }
+    ],
+    // Enforce the use of top-level import type qualifier when an import only has specifiers with inline type qualifiers
+    '@typescript-eslint/no-import-type-side-effects': 'error',
+    // Ensure consistent usage of indexed object access style in TypeScript code.
+    '@typescript-eslint/consistent-indexed-object-style': 'error'
   },
   overrides: [
     // tests, no restrictions (runs in Node / jest with jsdom)
@@ -103,6 +120,11 @@ module.exports = {
       rules: {
         'import/no-nodejs-modules': ['error', { allow: builtinModules }]
       }
+    },
+    {
+      // disable type checking for JS files
+      files: ['*.js'],
+      extends: ['plugin:@typescript-eslint/disable-type-checked']
     }
   ]
 }

package.json

@@ -72,6 +72,7 @@
     "@types/minimist": "^1.2.5",
     "@types/node": "^20.10.4",
     "@types/semver": "^7.5.5",
+    "@typescript-eslint/eslint-plugin": "^6.15.0",
     "@typescript-eslint/parser": "^6.13.2",
     "@vitest/coverage-istanbul": "^1.0.4",
     "@vue/consolidate": "0.17.3",

pnpm-lock.yaml

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["packages", "scripts", "./*.ts"]
+}