style: update format & lint config (#9162)

Co-authored-by: 丶远方 <[email protected]> Co-authored-by: 三咲智子 Kevin Deng <[email protected]> Co-authored-by: Guo Xingjun <[email protected]>
vuejs · Dec 26, 2023 · bfe6b45 · bfe6b45
1 parent baf0b76
commit bfe6b45
Show file tree

Hide file tree

Showing 464 changed files with 12,751 additions and 12,292 deletions.
diff --git a/.eslintrc.cjs b/.eslintrc.cjs
@@ -1,12 +1,11 @@
-/* eslint-disable no-restricted-globals */
-
+const { builtinModules } = require('node:module')
 const DOMGlobals = ['window', 'document']
 const NodeGlobals = ['module', 'require']
 
 const banConstEnum = {
   selector: 'TSEnumDeclaration[const=true]',
   message:
-    'Please use non-const enums. This project automatically inlines enums.'
+    'Please use non-const enums. This project automatically inlines enums.',
 }
 
 /**
@@ -15,9 +14,9 @@ const banConstEnum = {
 module.exports = {
   parser: '@typescript-eslint/parser',
   parserOptions: {
-    sourceType: 'module'
+    sourceType: 'module',
   },
-  plugins: ['jest'],
+  plugins: ['jest', 'import', '@typescript-eslint'],
   rules: {
     'no-debugger': 'error',
     // most of the codebase are expected to be env agnostic
@@ -32,8 +31,27 @@ module.exports = {
       // tsc compiles assignment spread into Object.assign() calls, but esbuild
       // still generates verbose helpers, so spread assignment is also prohiboted
       'ObjectExpression > SpreadElement',
-      'AwaitExpression'
-    ]
+      'AwaitExpression',
+    ],
+    'sort-imports': ['error', { ignoreDeclarationSort: true }],
+
+    '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',
+    // Enforce the use of 'import type' for importing types
+    '@typescript-eslint/consistent-type-imports': [
+      'error',
+      {
+        fixStyle: 'inline-type-imports',
+        disallowTypeAnnotations: false,
+      },
+    ],
+    // 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',
   },
   overrides: [
     // tests, no restrictions (runs in Node / jest with jsdom)
@@ -43,54 +61,66 @@ module.exports = {
         'no-restricted-globals': 'off',
         'no-restricted-syntax': 'off',
         'jest/no-disabled-tests': 'error',
-        'jest/no-focused-tests': 'error'
-      }
+        'jest/no-focused-tests': 'error',
+      },
     },
     // shared, may be used in any env
     {
-      files: ['packages/shared/**'],
+      files: ['packages/shared/**', '.eslintrc.cjs'],
       rules: {
-        'no-restricted-globals': 'off'
-      }
+        'no-restricted-globals': 'off',
+      },
     },
     // Packages targeting DOM
     {
       files: ['packages/{vue,vue-compat,runtime-dom}/**'],
       rules: {
-        'no-restricted-globals': ['error', ...NodeGlobals]
-      }
+        'no-restricted-globals': ['error', ...NodeGlobals],
+      },
     },
     // Packages targeting Node
     {
       files: ['packages/{compiler-sfc,compiler-ssr,server-renderer}/**'],
       rules: {
         'no-restricted-globals': ['error', ...DOMGlobals],
-        'no-restricted-syntax': ['error', banConstEnum]
-      }
+        'no-restricted-syntax': ['error', banConstEnum],
+      },
     },
     // Private package, browser only + no syntax restrictions
     {
       files: ['packages/template-explorer/**', 'packages/sfc-playground/**'],
       rules: {
         'no-restricted-globals': ['error', ...NodeGlobals],
-        'no-restricted-syntax': ['error', banConstEnum]
-      }
+        'no-restricted-syntax': ['error', banConstEnum],
+      },
     },
     // JavaScript files
     {
       files: ['*.js', '*.cjs'],
       rules: {
         // We only do `no-unused-vars` checks for js files, TS files are checked by TypeScript itself.
-        'no-unused-vars': ['error', { vars: 'all', args: 'none' }]
-      }
+        'no-unused-vars': ['error', { vars: 'all', args: 'none' }],
+      },
     },
     // Node scripts
     {
-      files: ['scripts/**', '*.{js,ts}', 'packages/**/index.js'],
+      files: [
+        'scripts/**',
+        './*.{js,ts}',
+        'packages/*/*.js',
+        'packages/vue/*/*.js',
+      ],
       rules: {
         'no-restricted-globals': 'off',
-        'no-restricted-syntax': ['error', banConstEnum]
-      }
-    }
-  ]
+        'no-restricted-syntax': ['error', banConstEnum],
+      },
+    },
+    // Import nodejs modules in compiler-sfc
+    {
+      files: ['packages/compiler-sfc/src/**'],
+      rules: {
+        'import/no-nodejs-modules': ['error', { allow: builtinModules }],
+      },
+    },
+  ],
 }
diff --git a/.github/renovate.json5 b/.github/renovate.json5
@@ -7,35 +7,35 @@
   packageRules: [
     {
       depTypeList: ['peerDependencies'],
-      enabled: false
+      enabled: false,
     },
     {
       groupName: 'test',
       matchPackageNames: ['vitest', 'jsdom', 'puppeteer'],
-      matchPackagePrefixes: ['@vitest']
+      matchPackagePrefixes: ['@vitest'],
     },
     {
       groupName: 'playground',
       matchFileNames: [
         'packages/sfc-playground/package.json',
-        'packages/template-explorer/package.json'
-      ]
+        'packages/template-explorer/package.json',
+      ],
     },
     {
       groupName: 'compiler',
       matchPackageNames: ['magic-string'],
-      matchPackagePrefixes: ['@babel', 'postcss']
+      matchPackagePrefixes: ['@babel', 'postcss'],
     },
     {
       groupName: 'build',
       matchPackageNames: ['vite', 'terser'],
-      matchPackagePrefixes: ['rollup', 'esbuild', '@rollup', '@vitejs']
+      matchPackagePrefixes: ['rollup', 'esbuild', '@rollup', '@vitejs'],
     },
     {
       groupName: 'lint',
       matchPackageNames: ['simple-git-hooks', 'lint-staged'],
-      matchPackagePrefixes: ['@typescript-eslint', 'eslint', 'prettier']
-    }
+      matchPackagePrefixes: ['@typescript-eslint', 'eslint', 'prettier'],
+    },
   ],
   ignoreDeps: [
     'vue',
@@ -45,6 +45,6 @@
     'typescript',
 
     // ESM only
-    'estree-walker'
-  ]
+    'estree-walker',
+  ],
 }
diff --git a/.prettierignore b/.prettierignore
@@ -1 +1,4 @@
 dist
+*.md
+*.html
+pnpm-lock.yaml
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,5 @@
-semi: false
-singleQuote: true
-printWidth: 80
-trailingComma: 'none'
-arrowParens: 'avoid'
+{
+  "semi": false,
+  "singleQuote": true,
+  "arrowParens": "avoid"
+}
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -21,7 +21,7 @@
       "console": "integratedTerminal",
       "sourceMaps": true,
       "windows": {
-        "program": "${workspaceFolder}/node_modules/jest/bin/jest",
+        "program": "${workspaceFolder}/node_modules/jest/bin/jest"
       }
     }
   ]

diff --git a/package.json b/package.json
@@ -13,9 +13,9 @@
     "size-esm-runtime": "node scripts/build.js vue -f esm-bundler-runtime",
     "size-esm": "node scripts/build.js runtime-dom runtime-core reactivity shared -f esm-bundler",
     "check": "tsc --incremental --noEmit",
-    "lint": "eslint --cache --ext .ts packages/*/{src,__tests__}/**.ts",
-    "format": "prettier --write --cache \"**/*.[tj]s?(x)\"",
-    "format-check": "prettier --check --cache \"**/*.[tj]s?(x)\"",
+    "lint": "eslint --cache --ext .js,.ts,.tsx .",
+    "format": "prettier --write --cache .",
+    "format-check": "prettier --check --cache .",
     "test": "vitest",
     "test-unit": "vitest -c vitest.unit.config.ts",
     "test-e2e": "node scripts/build.js vue -f global -d && vitest -c vitest.e2e.config.ts",
@@ -72,6 +72,7 @@
     "@types/minimist": "^1.2.5",
     "@types/node": "^20.10.5",
     "@types/semver": "^7.5.5",
+    "@typescript-eslint/eslint-plugin": "^6.16.0",
     "@typescript-eslint/parser": "^6.15.0",
     "@vitest/coverage-istanbul": "^1.1.0",
     "@vue/consolidate": "0.17.3",
@@ -81,6 +82,7 @@
     "esbuild-plugin-polyfill-node": "^0.3.0",
     "eslint": "^8.56.0",
     "eslint-define-config": "^1.24.1",
+    "eslint-plugin-import": "npm:eslint-plugin-i@^2.29.1",
     "eslint-plugin-jest": "^27.6.0",
     "estree-walker": "^2.0.2",
     "execa": "^8.0.1",