From c50d39999bf77e769c24d46e37d3780fe48e621b Mon Sep 17 00:00:00 2001
From: meteorlxy <meteor.lxy@foxmail.com>
Date: Sat, 31 Aug 2024 15:59:53 +0800
Subject: [PATCH] style: fix lint errors

---
 docs/.vuepress/components/NpmBadge.vue        | 20 ++++++------
 docs/.vuepress/configs/head.ts                |  1 +
 docs/.vuepress/configs/meta.ts                |  6 ++--
 docs/.vuepress/configs/navbar/en.ts           | 11 ++++---
 docs/.vuepress/configs/navbar/zh.ts           | 11 ++++---
 docs/.vuepress/configs/sidebar/en.ts          |  4 +--
 docs/.vuepress/configs/sidebar/zh.ts          |  4 +--
 .../cookbook/making-a-theme-extendable.md     | 18 +++++------
 .../cookbook/usage-of-client-config.md        |  2 +-
 docs/advanced/plugin.md                       | 32 +++++++------------
 docs/advanced/theme.md                        | 21 ++++++------
 docs/guide/assets.md                          |  8 ++---
 docs/reference/components.md                  |  2 +-
 docs/reference/node-api.md                    | 10 +++---
 .../cookbook/making-a-theme-extendable.md     | 18 +++++------
 .../cookbook/usage-of-client-config.md        |  2 +-
 docs/zh/advanced/plugin.md                    | 32 +++++++------------
 docs/zh/advanced/theme.md                     | 21 ++++++------
 docs/zh/guide/assets.md                       |  8 ++---
 docs/zh/reference/components.md               |  2 +-
 docs/zh/reference/node-api.md                 | 10 +++---
 eslint.config.js                              |  5 +++
 22 files changed, 116 insertions(+), 132 deletions(-)

diff --git a/docs/.vuepress/components/NpmBadge.vue b/docs/.vuepress/components/NpmBadge.vue
index c9ff7be2..171047f3 100644
--- a/docs/.vuepress/components/NpmBadge.vue
+++ b/docs/.vuepress/components/NpmBadge.vue
@@ -1,17 +1,17 @@
 <script setup lang="ts">
 import { computed } from 'vue'
 
-const props = defineProps({
-  package: {
-    type: String,
-    required: true,
+const props = withDefaults(
+  defineProps<{
+    /** package name */
+    package: string
+    /** dist-tag to use */
+    distTag?: string
+  }>(),
+  {
+    distTag: 'next',
   },
-  distTag: {
-    type: String,
-    required: false,
-    default: 'next',
-  },
-})
+)
 
 const badgeLink = computed(
   () => `https://www.npmjs.com/package/${props.package}`,
diff --git a/docs/.vuepress/configs/head.ts b/docs/.vuepress/configs/head.ts
index a869976d..0d45b078 100644
--- a/docs/.vuepress/configs/head.ts
+++ b/docs/.vuepress/configs/head.ts
@@ -1,5 +1,6 @@
 import type { HeadConfig } from 'vuepress/core'
 
+// eslint-disable-next-line @typescript-eslint/naming-convention
 export const head: HeadConfig[] = [
   [
     'link',
diff --git a/docs/.vuepress/configs/meta.ts b/docs/.vuepress/configs/meta.ts
index ab9ee5d4..3b89a465 100644
--- a/docs/.vuepress/configs/meta.ts
+++ b/docs/.vuepress/configs/meta.ts
@@ -3,6 +3,8 @@ import { fs } from 'vuepress/utils'
 
 const require = createRequire(import.meta.url)
 
-export const version = fs.readJsonSync(
-  require.resolve('vuepress/package.json'),
+export const VERSION = (
+  fs.readJsonSync(require.resolve('vuepress/package.json')) as {
+    version: string
+  }
 ).version
diff --git a/docs/.vuepress/configs/navbar/en.ts b/docs/.vuepress/configs/navbar/en.ts
index bc1aca5c..adc22769 100644
--- a/docs/.vuepress/configs/navbar/en.ts
+++ b/docs/.vuepress/configs/navbar/en.ts
@@ -1,7 +1,7 @@
-import type { NavbarConfig } from '@vuepress/theme-default'
-import { version } from '../meta.js'
+import type { NavbarOptions } from '@vuepress/theme-default'
+import { VERSION } from '../meta.js'
 
-export const navbarEn: NavbarConfig = [
+export const navbarEn: NavbarOptions = [
   {
     text: 'Guide',
     children: [
@@ -97,7 +97,7 @@ export const navbarEn: NavbarConfig = [
     ],
   },
   {
-    text: `v${version}`,
+    text: `v${VERSION}`,
     children: [
       {
         text: 'Changelog',
@@ -113,4 +113,5 @@ export const navbarEn: NavbarConfig = [
       },
     ],
   },
-]
+  // TODO: remove the type assertion
+] as NavbarOptions
diff --git a/docs/.vuepress/configs/navbar/zh.ts b/docs/.vuepress/configs/navbar/zh.ts
index 7a861937..47a3d994 100644
--- a/docs/.vuepress/configs/navbar/zh.ts
+++ b/docs/.vuepress/configs/navbar/zh.ts
@@ -1,7 +1,7 @@
-import type { NavbarConfig } from '@vuepress/theme-default'
-import { version } from '../meta.js'
+import type { NavbarOptions } from '@vuepress/theme-default'
+import { VERSION } from '../meta.js'
 
-export const navbarZh: NavbarConfig = [
+export const navbarZh: NavbarOptions = [
   {
     text: '指南',
     children: [
@@ -93,7 +93,7 @@ export const navbarZh: NavbarConfig = [
     ],
   },
   {
-    text: `v${version}`,
+    text: `v${VERSION}`,
     children: [
       {
         text: '更新日志',
@@ -109,4 +109,5 @@ export const navbarZh: NavbarConfig = [
       },
     ],
   },
-]
+  // TODO: remove the type assertion
+] as NavbarOptions
diff --git a/docs/.vuepress/configs/sidebar/en.ts b/docs/.vuepress/configs/sidebar/en.ts
index 3d16bb3c..387003b7 100644
--- a/docs/.vuepress/configs/sidebar/en.ts
+++ b/docs/.vuepress/configs/sidebar/en.ts
@@ -1,6 +1,6 @@
-import type { SidebarConfig } from '@vuepress/theme-default'
+import type { SidebarOptions } from '@vuepress/theme-default'
 
-export const sidebarEn: SidebarConfig = {
+export const sidebarEn: SidebarOptions = {
   '/guide/': [
     {
       text: 'Guide',
diff --git a/docs/.vuepress/configs/sidebar/zh.ts b/docs/.vuepress/configs/sidebar/zh.ts
index 82cc4b77..3955f70c 100644
--- a/docs/.vuepress/configs/sidebar/zh.ts
+++ b/docs/.vuepress/configs/sidebar/zh.ts
@@ -1,6 +1,6 @@
-import type { SidebarConfig } from '@vuepress/theme-default'
+import type { SidebarOptions } from '@vuepress/theme-default'
 
-export const sidebarZh: SidebarConfig = {
+export const sidebarZh: SidebarOptions = {
   '/zh/guide/': [
     {
       text: '指南',
diff --git a/docs/advanced/cookbook/making-a-theme-extendable.md b/docs/advanced/cookbook/making-a-theme-extendable.md
index a12737bc..c14ee0c7 100644
--- a/docs/advanced/cookbook/making-a-theme-extendable.md
+++ b/docs/advanced/cookbook/making-a-theme-extendable.md
@@ -34,16 +34,14 @@ import { getDirname } from 'vuepress/utils'
 
 const __dirname = getDirname(import.meta.url)
 
-export const fooTheme = (options): Theme => {
-  return {
-    name: 'vuepress-theme-foo',
-    alias: {
-      // set alias for replaceable components
-      '@theme/Navbar.vue': path.resolve(__dirname, 'components/Navbar.vue'),
-      '@theme/Sidebar.vue': path.resolve(__dirname, 'components/Sidebar.vue'),
-    },
-  }
-}
+export const fooTheme = (options): Theme => ({
+  name: 'vuepress-theme-foo',
+  alias: {
+    // set alias for replaceable components
+    '@theme/Navbar.vue': path.resolve(__dirname, 'components/Navbar.vue'),
+    '@theme/Sidebar.vue': path.resolve(__dirname, 'components/Sidebar.vue'),
+  },
+})
 ```
 
 Next, use those components via aliases in your theme:
diff --git a/docs/advanced/cookbook/usage-of-client-config.md b/docs/advanced/cookbook/usage-of-client-config.md
index 39de1777..56ca2fc0 100644
--- a/docs/advanced/cookbook/usage-of-client-config.md
+++ b/docs/advanced/cookbook/usage-of-client-config.md
@@ -130,8 +130,8 @@ In the `setup` function, the [`__VUEPRESS_SSR__`](../../reference/client-api.md#
 Another way to use non-ssr-friendly features is to put them inside the [onMounted](https://vuejs.org/api/composition-api-lifecycle.html#onmounted) hook:
 
 ```ts
-import { defineClientConfig } from 'vuepress/client'
 import { onMounted } from 'vue'
+import { defineClientConfig } from 'vuepress/client'
 
 export default defineClientConfig({
   setup() {
diff --git a/docs/advanced/plugin.md b/docs/advanced/plugin.md
index c7e3538f..f3aac5a2 100644
--- a/docs/advanced/plugin.md
+++ b/docs/advanced/plugin.md
@@ -18,32 +18,24 @@ const fooPlugin = {
 A plugin could also be a function that receives the [app instance](../reference/node-api.md#app) as the param and returns a _Plugin Object_, which is called a _Plugin Function_:
 
 ```ts
-const barPlugin = (app) => {
-  return {
-    name: 'vuepress-plugin-bar',
-    // ...
-  }
-}
+const barPlugin = (app) => ({
+  name: 'vuepress-plugin-bar',
+  // ...
+})
 ```
 
 A plugin usually needs to allow user options, so we typically provide users with a function to receive options, and returns a _Plugin Object_ or a _Plugin Function_. Then your plugin should be converted like this:
 
 ```ts
-const fooPlugin = (options) => {
-  return {
-    name: 'vuepress-plugin-foo',
-    // ...
-  }
-}
+const fooPlugin = (options) => ({
+  name: 'vuepress-plugin-foo',
+  // ...
+})
 
-const barPlugin = (options) => {
-  return (app) => {
-    return {
-      name: 'vuepress-plugin-bar',
-      // ...
-    }
-  }
-}
+const barPlugin = (options) => (app) => ({
+  name: 'vuepress-plugin-bar',
+  // ...
+})
 ```
 
 ## Publish to NPM
diff --git a/docs/advanced/theme.md b/docs/advanced/theme.md
index deec6538..9ceae09a 100644
--- a/docs/advanced/theme.md
+++ b/docs/advanced/theme.md
@@ -13,9 +13,9 @@ import { getDirname, path } from 'vuepress/utils'
 
 const __dirname = getDirname(import.meta.url)
 
-const fooTheme = (options) => {
+const fooTheme = (options) =>
   // returns a theme object
-  return {
+  ({
     name: 'vuepress-theme-foo',
 
     // path to the client config of your theme
@@ -32,18 +32,15 @@ const fooTheme = (options) => {
     ],
 
     // other plugin APIs are also available
-  }
-}
+  })
 
-const barTheme = (options) => {
+const barTheme =
+  (options) =>
   // returns a theme function
-  return (app) => {
-    return {
-      name: 'vuepress-theme-bar',
-      // ...
-    }
-  }
-}
+  (app) => ({
+    name: 'vuepress-theme-bar',
+    // ...
+  })
 ```
 
 Then, create theme's client config file `client.js` :
diff --git a/docs/guide/assets.md b/docs/guide/assets.md
index e686d8e1..93618ad1 100644
--- a/docs/guide/assets.md
+++ b/docs/guide/assets.md
@@ -71,16 +71,16 @@ When using [webpack bundler](../reference/bundler/webpack.md), you need to set [
 However, sometimes you may have some dynamical links referencing public files, especially when you are authoring a custom theme. In such case, the `base` could not be handled automatically. To help with that, VuePress provides a [withBase](../reference/client-api.md#withbase) helper to prepend `base` for you:
 
 ```vue
-<template>
-  <img :src="withBase(logoPath)" />
-</template>
-
 <script setup>
 import { ref } from 'vue'
 import { withBase } from 'vuepress/client'
 
 const logoPath = ref('/images/hero.png')
 </script>
+
+<template>
+  <img :src="withBase(logoPath)" />
+</template>
 ```
 
 You can also access the helper by `$withBase` directly:
diff --git a/docs/reference/components.md b/docs/reference/components.md
index 3a045c39..0c772db7 100644
--- a/docs/reference/components.md
+++ b/docs/reference/components.md
@@ -13,7 +13,7 @@ interface AutoLinkConfig {
   /**
    * Pattern to determine if the link should be active, which has higher priority than `exact`
    */
-  activeMatch?: string | RegExp
+  activeMatch?: RegExp | string
 
   /**
    * The `aria-label` attribute
diff --git a/docs/reference/node-api.md b/docs/reference/node-api.md
index 23cda854..37c79729 100644
--- a/docs/reference/node-api.md
+++ b/docs/reference/node-api.md
@@ -213,7 +213,7 @@ const homeSourceFile = app.dir.source('README.md')
 - Signature:
 
 ```ts
-writeTemp(file: string, content: string): Promise<string>
+declare const writeTemp = (file: string, content: string) => Promise<string>
 ```
 
 - Parameters:
@@ -250,7 +250,7 @@ import { foo } from '@temp/foo'
 - Signature:
 
 ```ts
-init(): Promise<void>
+declare const init = () => Promise<void>
 ```
 
 - Details:
@@ -265,7 +265,7 @@ init(): Promise<void>
 - Signature:
 
 ```ts
-prepare(): Promise<void>
+declare const prepare = () => Promise<void>
 ```
 
 - Details:
@@ -280,7 +280,7 @@ prepare(): Promise<void>
 - Signature:
 
 ```ts
-build(): Promise<void>
+declare const build = () => Promise<void>
 ```
 
 - Details:
@@ -298,7 +298,7 @@ build(): Promise<void>
 - Signature:
 
 ```ts
-dev(): Promise<() => Promise<void>>
+declare const dev = () => Promise<() => Promise<void>>
 ```
 
 - Details:
diff --git a/docs/zh/advanced/cookbook/making-a-theme-extendable.md b/docs/zh/advanced/cookbook/making-a-theme-extendable.md
index 1de74e6b..a3de57b3 100644
--- a/docs/zh/advanced/cookbook/making-a-theme-extendable.md
+++ b/docs/zh/advanced/cookbook/making-a-theme-extendable.md
@@ -34,16 +34,14 @@ import { getDirname, path } from 'vuepress/utils'
 
 const __dirname = getDirname(import.meta.url)
 
-export const fooTheme = (options): Theme => {
-  return {
-    name: 'vuepress-theme-foo',
-    alias: {
-      // 为可替换的组件设置别名
-      '@theme/Navbar.vue': path.resolve(__dirname, 'components/Navbar.vue'),
-      '@theme/Sidebar.vue': path.resolve(__dirname, 'components/Sidebar.vue'),
-    },
-  }
-}
+export const fooTheme = (options): Theme => ({
+  name: 'vuepress-theme-foo',
+  alias: {
+    // 为可替换的组件设置别名
+    '@theme/Navbar.vue': path.resolve(__dirname, 'components/Navbar.vue'),
+    '@theme/Sidebar.vue': path.resolve(__dirname, 'components/Sidebar.vue'),
+  },
+})
 ```
 
 然后，在你的主题中通过别名来使用这些组件：
diff --git a/docs/zh/advanced/cookbook/usage-of-client-config.md b/docs/zh/advanced/cookbook/usage-of-client-config.md
index 25bdc41c..26dab64b 100644
--- a/docs/zh/advanced/cookbook/usage-of-client-config.md
+++ b/docs/zh/advanced/cookbook/usage-of-client-config.md
@@ -130,8 +130,8 @@ export default defineClientConfig({
 使用不支持 SSR 的功能的另一种方式就是将他们放在 [onMounted](https://staging-cn.vuejs.org/api/composition-api-lifecycle.html#onmounted) Hook 中：
 
 ```ts
-import { defineClientConfig } from 'vuepress/client'
 import { onMounted } from 'vue'
+import { defineClientConfig } from 'vuepress/client'
 
 export default defineClientConfig({
   setup() {
diff --git a/docs/zh/advanced/plugin.md b/docs/zh/advanced/plugin.md
index 8f53a186..36a095bb 100644
--- a/docs/zh/advanced/plugin.md
+++ b/docs/zh/advanced/plugin.md
@@ -18,32 +18,24 @@ const fooPlugin = {
 插件还可以是一个接收 [App 实例](../reference/node-api.md#app) 作为参数，且返回值为 _插件对象_ 的函数，称之为 _插件函数_ ：
 
 ```ts
-const barPlugin = (app) => {
-  return {
-    name: 'vuepress-plugin-bar',
-    // ...
-  }
-}
+const barPlugin = (app) => ({
+  name: 'vuepress-plugin-bar',
+  // ...
+})
 ```
 
 插件通常需要允许用户传入配置，因此我们一般都会提供给用户一个函数来接收配置，然后将 _插件对象_ 或者 _插件函数_ 作为返回值。于是，你的插件应该转换成这样的形式：
 
 ```ts
-const fooPlugin = (options) => {
-  return {
-    name: 'vuepress-plugin-foo',
-    // ...
-  }
-}
+const fooPlugin = (options) => ({
+  name: 'vuepress-plugin-foo',
+  // ...
+})
 
-const barPlugin = (options) => {
-  return (app) => {
-    return {
-      name: 'vuepress-plugin-bar',
-      // ...
-    }
-  }
-}
+const barPlugin = (options) => (app) => ({
+  name: 'vuepress-plugin-bar',
+  // ...
+})
 ```
 
 ## 发布到 NPM
diff --git a/docs/zh/advanced/theme.md b/docs/zh/advanced/theme.md
index fcb3c6d7..239b6f68 100644
--- a/docs/zh/advanced/theme.md
+++ b/docs/zh/advanced/theme.md
@@ -13,9 +13,9 @@ import { getDirname, path } from 'vuepress/utils'
 
 const __dirname = getDirname(import.meta.url)
 
-const fooTheme = (options) => {
+const fooTheme = (options) =>
   // 返回一个主题对象
-  return {
+  ({
     name: 'vuepress-theme-foo',
 
     // 主题的客户端配置文件的路径
@@ -32,18 +32,15 @@ const fooTheme = (options) => {
     ],
 
     // 其他的插件 API 也都可用
-  }
-}
+  })
 
-const barTheme = (options) => {
+const barTheme =
+  (options) =>
   // 返回一个主题函数
-  return (app) => {
-    return {
-      name: 'vuepress-theme-bar',
-      // ...
-    }
-  }
-}
+  (app) => ({
+    name: 'vuepress-theme-bar',
+    // ...
+  })
 ```
 
 然后，创建主题的客户端配置文件 `client.js` :
diff --git a/docs/zh/guide/assets.md b/docs/zh/guide/assets.md
index 52ee28b2..611cda86 100644
--- a/docs/zh/guide/assets.md
+++ b/docs/zh/guide/assets.md
@@ -71,16 +71,16 @@
 然而，有些情况下，你可能会有一些指向 Public 文件的动态路径，尤其是在你开发一个自定义主题的时候。在这种情况下， `base` 无法被自动处理。为了解决这个问题，VuePress 提供了 [withBase](../reference/client-api.md#withbase) 工具函数，它可以帮助你添加 `base` 前缀：
 
 ```vue
-<template>
-  <img :src="withBase(logoPath)" />
-</template>
-
 <script setup>
 import { ref } from 'vue'
 import { withBase } from 'vuepress/client'
 
 const logoPath = ref('/images/hero.png')
 </script>
+
+<template>
+  <img :src="withBase(logoPath)" />
+</template>
 ```
 
 你也可以通过 `$withBase` 来直接使用这个工具函数：
diff --git a/docs/zh/reference/components.md b/docs/zh/reference/components.md
index 95f790d2..5b4b9c96 100644
--- a/docs/zh/reference/components.md
+++ b/docs/zh/reference/components.md
@@ -13,7 +13,7 @@ interface AutoLinkConfig {
   /**
    * 判断该链接是否被激活的模式，优先级高于 `exact`
    */
-  activeMatch?: string | RegExp
+  activeMatch?: RegExp | string
 
   /**
    * `aria-label` 属性
diff --git a/docs/zh/reference/node-api.md b/docs/zh/reference/node-api.md
index 867b3d09..ceb6d412 100644
--- a/docs/zh/reference/node-api.md
+++ b/docs/zh/reference/node-api.md
@@ -213,7 +213,7 @@ const homeSourceFile = app.dir.source('README.md')
 - 函数签名：
 
 ```ts
-writeTemp(file: string, content: string): Promise<string>
+declare const writeTemp = (file: string, content: string) => Promise<string>
 ```
 
 - 参数：
@@ -250,7 +250,7 @@ import { foo } from '@temp/foo'
 - 函数签名：
 
 ```ts
-init(): Promise<void>
+declare const init = () => Promise<void>
 ```
 
 - 详情：
@@ -265,7 +265,7 @@ init(): Promise<void>
 - 函数签名：
 
 ```ts
-prepare(): Promise<void>
+declare const prepare = () => Promise<void>
 ```
 
 - 详情：
@@ -280,7 +280,7 @@ prepare(): Promise<void>
 - 函数签名：
 
 ```ts
-build(): Promise<void>
+declare const build = () => Promise<void>
 ```
 
 - 详情：
@@ -297,7 +297,7 @@ build(): Promise<void>
 - 函数签名：
 
 ```ts
-dev(): Promise<() => Promise<void>>
+declare const dev = () => Promise<() => Promise<void>>
 ```
 
 - 详情：
diff --git a/eslint.config.js b/eslint.config.js
index 31cefe06..d20785d5 100644
--- a/eslint.config.js
+++ b/eslint.config.js
@@ -1,6 +1,11 @@
 import { vuepress } from 'eslint-config-vuepress'
 
 export default vuepress({
+  ignores: [
+    // the intended js parsing error could not be disabled, so we have to ignore them
+    'docs/guide/markdown.md',
+    'docs/zh/guide/markdown.md',
+  ],
   vue: {
     overrides: {
       'no-useless-assignment': 'off', // TODO: false positive in vue sfc