style: fix lint and format errors

meteorlxy · meteorlxy · commit 9883d65a3512 · 2025-08-06T14:24:18.000+08:00
diff --git a/docs/.vuepress/components/NpmBadge.vue b/docs/.vuepress/components/NpmBadge.vue
@@ -1,31 +1,24 @@
 <script setup lang="ts">
 import { computed } from 'vue'
 
-const props = withDefaults(
-  defineProps<{
-    /** package name */
-    package: string
-    /** dist-tag to use */
-    distTag?: string
-  }>(),
-  {
-    distTag: 'next',
-  },
-)
+const { package: pkg, distTag = 'next' } = defineProps<{
+  /** package name */
+  package: string
+  /** dist-tag to use */
+  distTag?: string
+}>()
 
-const badgeLink = computed(
-  () => `https://www.npmjs.com/package/${props.package}`,
-)
+const badgeLink = computed(() => `https://www.npmjs.com/package/${pkg}`)
 const badgeLabel = computed(() => {
-  if (props.distTag) {
-    return `${props.package}@${props.distTag}`
+  if (distTag) {
+    return `${pkg}@${distTag}`
   }
-  return props.package
+  return pkg
 })
 const badgeImg = computed(
   () =>
-    `https://badgen.net/npm/v/${props.package}/${
-      props.distTag
+    `https://badgen.net/npm/v/${pkg}/${
+      distTag
     }?label=${encodeURIComponent(badgeLabel.value)}`,
 )
 </script>
diff --git a/docs/guide/deployment.md b/docs/guide/deployment.md
@@ -205,12 +205,10 @@ See [Edgio Documentation > Framework Guides > VuePress](https://docs.edg.io/guid
 ## Netlify
 
 1. On [Netlify](https://netlify.com), set up a new project from GitHub with the following settings:
-
    - **Build Command:** `pnpm docs:build`
    - **Publish directory:** `docs/.vuepress/dist`
 
 2. Set [Environment variables](https://docs.netlify.com/configure-builds/environment-variables) to choose node version:
-
    - `NODE_VERSION`: 20
 
 3. Hit the deploy button.
@@ -224,7 +222,6 @@ You should disable Pretty URLs in the "Site Configuration" → "Build & Deploy"
 ## Vercel
 
 1. Go to [Vercel](https://vercel.com), set up a new project from GitHub with the following settings:
-
    - **FRAMEWORK PRESET:** `Other`
    - **BUILD COMMAND:** `pnpm docs:build`
    - **OUTPUT DIRECTORY:** `docs/.vuepress/dist`
diff --git a/docs/reference/components.md b/docs/reference/components.md
@@ -3,7 +3,6 @@
 ## AutoLink
 
 - Props:
-
   - config
     - Type: `AutoLinkConfig`
     - Required: `true`
@@ -93,7 +92,6 @@ interface AutoLinkConfig {
   This component and its children will only be rendered in client-side. That means, it will not be rendered to HTML during build (SSR).
 
   If a component is trying to access Browser / DOM APIs directly in `setup()`, an error will occur during build because those APIs are unavailable in Node.js environment. In such case, you could do either:
-
   - Modify the component to only access Browser / DOM APIs in `onBeforeMount()` or `onMounted()` hook.
   - Wrap the component with `<ClientOnly>`.
 
@@ -104,7 +102,6 @@ Since Vue 3.5, if you only want to avoid hydration mismatch, you can try the new
 ## Content
 
 - Props:
-
   - path
     - Type: `string`
     - Required: `false`
@@ -129,7 +126,6 @@ Since Vue 3.5, if you only want to avoid hydration mismatch, you can try the new
 ## RouteLink
 
 - Props:
-
   - to
     - Type: `string`
     - Required: `true`
diff --git a/docs/reference/config.md b/docs/reference/config.md
@@ -124,7 +124,6 @@ Rendered as：
   Specify locales for i18n support.
 
   Acceptable fields:
-
   - [lang](#lang)
   - [title](#title)
   - [description](#description)
@@ -160,7 +159,6 @@ Rendered as：
   Set the bundler of your site.
 
   If this option is not set, the default bundler will be used:
-
   - With `vuepress` or `vuepress-vite`, the default bundler is vite.
   - With `vuepress-webpack`, the default bundler is webpack.
 
diff --git a/docs/reference/frontmatter.md b/docs/reference/frontmatter.md
@@ -147,7 +147,6 @@ layout: CustomLayout
   | `:raw`   | Raw route path             |
 
   The `:year`, `:month` and `:day` patterns are resolved according to the following priority:
-
   - The `date` frontmatter.
   - The filename that matches the date pattern `yyyy-MM-dd-foobar.md` or `yyyy-MM-foobar.md`.
   - The dirname that matches the date pattern `yyyy/MM/dd/foobar.md` or `yyyy/MM/foobar.md`.
diff --git a/docs/reference/node-api.md b/docs/reference/node-api.md
@@ -181,7 +181,6 @@ const dev = async () => {
 ### dir
 
 - Utils:
-
   - `dir.cache()`: resolve to cache directory
   - `dir.temp()`: resolve to temp directory
   - `dir.source()`: resolve to source directory
@@ -395,7 +394,6 @@ Hello, world.
   Language of the page.
 
 - Example:
-
   - `'en-US'`
   - `'zh-CN'`
 
@@ -481,7 +479,6 @@ interface PageData {
   Date of the page, in 'yyyy-MM-dd' format.
 
 - Example:
-
   - `'0000-00-00'`
   - `'2021-08-16`'
 
@@ -545,7 +542,6 @@ interface MarkdownLink {
   It would be `null` if the page does not come from a Markdown source file.
 
 - Example:
-
   - `'/'`
   - `'/foo.html'`
 
@@ -564,7 +560,6 @@ interface MarkdownLink {
   It is inferred from the relative file path of the Markdown source file and the key of `locales` option in user config.
 
 - Example:
-
   - `'/'`
   - `'/en/'`
   - `'/zh/'`
diff --git a/docs/reference/plugin-api.md b/docs/reference/plugin-api.md
@@ -45,7 +45,6 @@ The following hooks will be processed in dev / build:
   It will be used for identifying plugins to avoid using a same plugin multiple times, so make sure to use a unique plugin name.
 
   It should follow the naming convention:
-
   - Non-scoped: `vuepress-plugin-foo`
   - Scoped: `@org/vuepress-plugin-foo`
 
diff --git a/docs/reference/theme-api.md b/docs/reference/theme-api.md
@@ -13,7 +13,6 @@ A VuePress theme also works as a plugin, so Theme API can accept all the options
   Name of the theme.
 
   It should follow the naming convention, and ensure consistency with the package name when publishing to NPM:
-
   - Non-scoped: `vuepress-theme-foo`
   - Scoped: `@org/vuepress-theme-foo`
 
@@ -34,7 +33,6 @@ A VuePress theme also works as a plugin, so Theme API can accept all the options
   The theme to inherit.
 
   All of the Theme API of the parent theme will be inherited, but the child theme will not override the parent theme directly. Theme specific options will override according to following rules:
-
   - [plugins](#plugins): When a same plugin is used in both child and parent theme, if the plugin does not support to be used multiple times, only the one used in the child theme will take effect.
   - [templateBuild](#templatebuild) / [templateDev](#templatedev): Child theme templates will override parent theme templates.
 
diff --git a/docs/zh/guide/deployment.md b/docs/zh/guide/deployment.md
@@ -205,12 +205,10 @@ heroku login
 ## Netlify
 
 1. 前往 [Netlify](https://netlify.com) ，从 GitHub 创建一个新项目，并进行如下配置：
-
    - **Build Command:** `pnpm docs:build`
    - **Publish directory:** `docs/.vuepress/dist`
 
 2. 设置 [Environment variables](https://docs.netlify.com/configure-builds/environment-variables) 来选择 Node 版本：
-
    - `NODE_VERSION`: 20
 
 3. 点击 deploy 按钮。
@@ -224,7 +222,6 @@ heroku login
 ## Vercel
 
 1. 前往 [Vercel](https://vercel.com) ，从 GitHub 创建一个新项目，并进行如下配置：
-
    - **FRAMEWORK PRESET:** `Other`
    - **BUILD COMMAND:** `pnpm docs:build`
    - **OUTPUT DIRECTORY:** `docs/.vuepress/dist`
diff --git a/docs/zh/reference/components.md b/docs/zh/reference/components.md
@@ -3,7 +3,6 @@
 ## AutoLink
 
 - Props:
-
   - config
     - 类型：`AutoLinkConfig`
     - 是否必须：`true`
@@ -93,7 +92,6 @@ interface AutoLinkConfig {
   该组件和它的子元素只会在客户端被渲染。也就是说，它不会在构建 (SSR) 过程中被渲染到 HTML 内。
 
   如果一个组件在 `setup()` 中直接使用 浏览器 / DOM API ，它会导致构建过程报错，因为这些 API 在 Node.js 的环境中是无法使用的。在这种情况下，你可以选择一种方式：
-
   - 修改这个组件，只在 `onBeforeMount()` 或 `onMounted()` Hook 中使用 浏览器 / DOM API 。
   - 使用 `<ClientOnly>` 包裹这个组件。
 
@@ -104,7 +102,6 @@ interface AutoLinkConfig {
 ## Content
 
 - Props:
-
   - path
     - 类型： `string`
     - 是否必须： `false`
@@ -129,7 +126,6 @@ interface AutoLinkConfig {
 ## RouteLink
 
 - Props:
-
   - to
     - 类型： `string`
     - 是否必须： `true`
diff --git a/docs/zh/reference/config.md b/docs/zh/reference/config.md
@@ -123,7 +123,6 @@ export default {
   多语言支持的各个语言 locales 。
 
   可以使用的字段有：
-
   - [lang](#lang)
   - [title](#title)
   - [description](#description)
@@ -159,7 +158,6 @@ export default {
   设置站点要使用的打包工具。
 
   如果不设置该选项，将会使用默认的打包工具：
-
   - 使用 `vuepress` 或 `vuepress-vite` 时，默认的打包工具是 Vite 。
   - 使用 `vuepress-webpack` 时，默认的打包工具是 Webpack 。
 
diff --git a/docs/zh/reference/frontmatter.md b/docs/zh/reference/frontmatter.md
@@ -147,7 +147,6 @@ layout: CustomLayout
   | `:raw`   | 原始路由路径       |
 
   `:year`, `:month` 和 `:day` Pattern 根据如下优先级进行解析：
-
   - Frontmatter 中的 `date` 字段。
   - 符合 `yyyy-MM-dd-foobar.md` 或 `yyyy-MM-foobar.md` 日期格式的文件名。
   - 符合 `yyyy/MM/dd/foobar.md` 或 `yyyy/MM/foobar.md` 日期格式的目录名。
diff --git a/docs/zh/reference/node-api.md b/docs/zh/reference/node-api.md
@@ -181,7 +181,6 @@ const dev = async () => {
 ### dir
 
 - 工具函数：
-
   - `dir.cache()`： 解析至缓存目录
   - `dir.temp()`： 解析至临时文件目录
   - `dir.source()`： 解析至源文件目录
@@ -393,7 +392,6 @@ export default {
   该 Page 的语言。
 
 - 示例：
-
   - `'en-US'`
   - `'zh-CN'`
 
@@ -479,7 +477,6 @@ interface PageData {
   该 Page 的日期，遵从 'yyyy-MM-dd' 格式。
 
 - 示例：
-
   - `'0000-00-00'`
   - `'2021-08-16`'
 
@@ -543,7 +540,6 @@ interface MarkdownLink {
   如果该 Page 不是来自于 Markdown 源文件，那么该属性会为 `null` 。
 
 - 示例：
-
   - `'/'`
   - `'/foo.html'`
 
@@ -562,7 +558,6 @@ interface MarkdownLink {
   它是根据页面的 Markdown 源文件相对路径、以及用户配置的 `locales` 的键推断得到的。
 
 - 示例：
-
   - `'/'`
   - `'/en/'`
   - `'/zh/'`
diff --git a/docs/zh/reference/plugin-api.md b/docs/zh/reference/plugin-api.md
@@ -45,7 +45,6 @@
   它会被用来识别插件，以避免多次使用同一个插件，因此应确保你的插件名称是独一无二的。
 
   它应遵从如下命名约定：
-
   - 非 Scoped: `vuepress-plugin-foo`
   - Scoped: `@org/vuepress-plugin-foo`
 
diff --git a/docs/zh/reference/theme-api.md b/docs/zh/reference/theme-api.md
@@ -13,7 +13,6 @@ VuePress 主题同样是一个插件，因此主题 API 可以接收 [插件 API
   主题的名称。
 
   它应遵从如下命名约定，并且在发布到 NPM 时应确保和包名保持一致：
-
   - 非 Scoped: `vuepress-theme-foo`
   - Scoped: `@org/vuepress-theme-foo`
 
@@ -34,7 +33,6 @@ VuePress 主题同样是一个插件，因此主题 API 可以接收 [插件 API
   要继承的主题。
 
   父主题的所有主题 API 都会被继承，但是子主题不会直接覆盖父主题。主题特定的配置项会根据以下规则进行覆盖：
-
   - [plugins](#plugins)： 当同一个插件在子主题和父主题中都被使用时，如果该插件不支持被多次使用，那么只有在子主题中使用的插件会生效。
   - [templateBuild](#templatebuild) / [templateDev](#templatedev)： 子主题的模板会覆盖父主题的模板。
 
diff --git a/eslint.config.js b/eslint.config.js
@@ -1,11 +1,13 @@
 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',
-  ],
+  ignores: {
+    files: [
+      // 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
