refactor: upgrade eslint and fix lint and type errors (#1600)

Author: meteorlxy

.eslintignore

@@ -6,12 +6,13 @@ const getSubDirectories = (dir: string): string[] =>
   fs
     .readdirSync(dir)
     .filter((item) => fs.statSync(path.join(dir, item)).isDirectory())
-const packages = getSubDirectories(path.resolve(__dirname, 'packages'))
+
+const PACKAGES = getSubDirectories(path.resolve(__dirname, 'packages'))
 
 export default {
   extends: ['@commitlint/config-conventional'],
   rules: {
-    'scope-enum': [2, 'always', [...packages, 'e2e']],
+    'scope-enum': [2, 'always', [...PACKAGES, 'e2e']],
     'footer-max-line-length': [0],
   },
 } satisfies UserConfig

.eslintrc.cjs

@@ -1,11 +1,8 @@
 import { getDirname, path } from 'vuepress/utils'
 
-const __dirname = getDirname(import.meta.url)
+const DIRNAME = getDirname(import.meta.url)
 
 export const fooPlugin = {
   name: 'test-plugin',
-  clientConfigFile: path.resolve(
-    __dirname,
-    './nonDefaultExportClientConfig.js',
-  ),
+  clientConfigFile: path.resolve(DIRNAME, './nonDefaultExportClientConfig.js'),
 }

commitlint.config.ts

@@ -8,20 +8,22 @@ import NotFound from './layouts/NotFound.vue'
 import './styles/index.scss'
 
 export default defineClientConfig({
-  enhance({ app, router }) {
+  enhance() {
     // ...
   },
 
   setup() {
     // ...
   },
 
+  /* eslint-disable @typescript-eslint/no-unsafe-assignment -- vue sfc type info is not available in eslint scope */
   layouts: {
     CssModulesLayout,
     CustomLayout,
     Layout,
     NotFound,
   },
+  /* eslint-enable @typescript-eslint/no-unsafe-assignment */
 
   rootComponents: [RootComponentFromTheme],
 })

e2e/docs/.vuepress/plugins/foo/fooPlugin.ts

@@ -21,4 +21,6 @@ const siteData = useSiteData()
   </div>
 </template>
 
-<style lang="scss" scoped></style>
+<style lang="scss" scoped>
+// ...
+</style>

e2e/docs/.vuepress/theme/client/config.ts

@@ -1,26 +1,24 @@
-import type { Page, Theme } from 'vuepress/core'
+import type { Theme } from 'vuepress/core'
 import { getDirname, path } from 'vuepress/utils'
 
-const __dirname = getDirname(import.meta.url)
+const DIRNAME = getDirname(import.meta.url)
 
-export const e2eTheme = (): Theme => {
-  return {
-    name: '@vuepress/theme-e2e',
+export const e2eTheme = (): Theme => ({
+  name: '@vuepress/theme-e2e',
 
-    alias: {
-      // ...
-    },
+  alias: {
+    // ...
+  },
 
-    define: {
-      // ...
-    },
+  define: {
+    // ...
+  },
 
-    clientConfigFile: path.resolve(__dirname, '../client/config.ts'),
+  clientConfigFile: path.resolve(DIRNAME, '../client/config.ts'),
 
-    extendsPage: (page: Page) => {
-      // ...
-    },
+  extendsPage: () => {
+    // ...
+  },
 
-    plugins: [],
-  }
-}
+  plugins: [],
+})

e2e/docs/.vuepress/theme/client/layouts/Layout.vue

@@ -1,2 +1,2 @@
-declare const str: string
-export default str
+declare const STR: string
+export default STR

e2e/docs/.vuepress/theme/node/e2eTheme.ts

@@ -1,16 +1,16 @@
 import { defineConfig, devices } from '@playwright/test'
-import { BASE, BUNDLER, isCI, isDev } from './utils/env'
+import { BASE, BUNDLER, IS_CI, IS_DEV } from './utils/env'
 
-const commandPart1 = isDev ? 'docs:dev' : 'docs:build'
-const commandPart2 = BUNDLER === 'vite' ? '' : `-${BUNDLER}`
-const commandPart3 = isDev ? '' : ' && pnpm docs:serve'
+const COMMAND_PART1 = IS_DEV ? 'docs:dev' : 'docs:build'
+const COMMAND_PART2 = BUNDLER === 'vite' ? '' : `-${BUNDLER}`
+const COMMAND_PART3 = IS_DEV ? '' : ' && pnpm docs:serve'
 
 export default defineConfig({
   testDir: 'tests',
-  forbidOnly: isCI,
-  reporter: isCI ? 'github' : 'line',
-  retries: isCI ? 2 : 0,
-  workers: isDev ? 1 : undefined,
+  forbidOnly: IS_CI,
+  reporter: IS_CI ? 'github' : 'line',
+  retries: IS_CI ? 2 : 0,
+  workers: IS_DEV ? 1 : undefined,
   projects: [
     {
       name: 'chromium',
@@ -22,8 +22,8 @@ export default defineConfig({
     trace: 'on-first-retry',
   },
   webServer: {
-    command: `pnpm docs:clean && pnpm ${commandPart1}${commandPart2}${commandPart3}`,
+    command: `pnpm docs:clean && pnpm ${COMMAND_PART1}${COMMAND_PART2}${COMMAND_PART3}`,
     url: 'http://127.0.0.1:9080',
-    reuseExistingServer: !isCI,
+    reuseExistingServer: !IS_CI,
   },
 })

e2e/modules/conditional-exports/types.d.ts

@@ -1,5 +1,5 @@
 import { expect, test } from '@playwright/test'
-import { isDev } from '../utils/env'
+import { IS_DEV } from '../utils/env'
 import { readSourceMarkdown, writeSourceMarkdown } from '../utils/source'
 
 const hmrUpdateTitle = async (): Promise<void> => {
@@ -33,7 +33,7 @@ const hmrRestore = async (): Promise<void> => {
   )
 }
 
-if (isDev) {
+if (IS_DEV) {
   test.beforeEach(async () => {
     await hmrRestore()
   })