chore: upgrade lint toolchain (#6901)

* fix: build docs

* fix: deps

Author: xqvvu

.github/workflows/build-docs.yml

@@ -109,6 +109,9 @@ jobs:
           username: ${{ secrets.FASTGPT_ALI_IMAGE_USER }}
           password: ${{ secrets.FASTGPT_ALI_IMAGE_PSW }}
 
+      - name: Prepare Docker workspace catalog
+        run: cp pnpm-workspace.yaml document/pnpm-workspace.yaml
+
       - name: Build and push Docker images (CN)
         if: matrix.domain_config.suffix == 'cn'
         uses: docker/build-push-action@v5

.github/workflows/preview-docs-build.yml

@@ -28,6 +28,9 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
+      - name: Prepare Docker workspace catalog
+        run: cp pnpm-workspace.yaml document/pnpm-workspace.yaml
+
       - name: Build Docker image (no push)
         uses: docker/build-push-action@v6
         with:

document/.textlintignore

@@ -0,0 +1 @@
+content/**/*.en.mdx

document/.textlintrc.json

@@ -0,0 +1,6 @@
+{
+  "plugins": ["mdx"],
+  "rules": {
+    "preset-zh-technical-writing": true
+  }
+}

document/content/self-host/upgrading/4-15/4150.mdx

@@ -70,7 +70,8 @@ FILE_TOKEN_KEY=
 
 ## 代码优化
 
-1. 重新调整代码结构，升级 nextjs 最新版，切换至 turbopack 构建，提高构建速度；升级容器默认 node 至 24。
+1. 重新调整代码结构，升级 Next.js 最新版，切换至 Turbopack 构建，提高构建速度；升级容器默认 Node.js 至 24。
 2. 优化 Agent tool 声明和运行，统一所有 tool 的声明和运行方式。
 3. 文件上传内容从 system prompt 中放到 user message 中，提高 cache 命中率。
-4. 服务端 env 加载全部使用`@t3-oss/env-core`，增加更多类型检查。其余服务，也采用集中导出 env 的方式进行环境变量使用。
+4. 服务端 env 加载全部使用 `@t3-oss/env-core`，增加更多类型检查。其余服务，也采用集中导出 env 的方式进行环境变量使用。
+5. 升级了项目工程化工具链版本，包括 ESLint、Prettier、textlint 和 lint-staged 工具。

document/package.json

@@ -8,7 +8,8 @@
     "dev": "next dev --turbo",
     "start": "next start",
     "postinstall": "fumadocs-mdx",
-    "format-doc": "pnpx zhlint --dir ./ *.mdx --fix",
+    "format-doc": "pnpm exec textlint --fix \"content/**/*.mdx\" && pnpm exec prettier --config ../.prettierrc.js --write \"**/*.mdx\" && pnpm exec textlint \"content/**/*.mdx\"",
+    "lint-doc:text": "pnpm exec textlint \"content/**/*.mdx\"",
     "initDocTime": "node ./script/initDocTime.js",
     "initDocToc": "node ./script/generateToc.js",
     "checkDocRefs": "node ./script/checkDocRefs.js",
@@ -47,8 +48,10 @@
     "@types/react-dom": "^19.1.6",
     "postcss": "^8.5.10",
     "tailwindcss": "^4.1.11",
+    "textlint": "catalog:lint",
+    "textlint-plugin-mdx": "catalog:lint",
+    "textlint-rule-preset-zh-technical-writing": "catalog:lint",
     "typescript": "^5.8.3",
-    "zhlint": "^0.8.2",
     "zod": "^4.0.5"
   }
 }

lint-staged.config.mjs

@@ -3,6 +3,30 @@ import path from 'node:path';
 const quoteFiles = (files) =>
   files.map((file) => JSON.stringify(path.relative(process.cwd(), file))).join(' ');
 
+const toAbsolutePath = (file) => (path.isAbsolute(file) ? file : path.resolve(process.cwd(), file));
+
+const quoteDocumentFiles = (files) =>
+  files
+    .map((file) =>
+      JSON.stringify(path.relative(path.join(process.cwd(), 'document'), toAbsolutePath(file)))
+    )
+    .join(' ');
+
+const quoteDocumentArtifactPaths = () =>
+  [
+    'document/data/doc-last-modified.json',
+    'document/content/toc.mdx',
+    'document/content/toc.en.mdx'
+  ]
+    .map((file) => JSON.stringify(file))
+    .join(' ');
+
+const withoutTranslatedDocumentFiles = (files) =>
+  files.filter((file) => {
+    const documentPath = path.relative(path.join(process.cwd(), 'document'), toAbsolutePath(file));
+    return !/\.[a-z]{2}\.mdx$/.test(documentPath);
+  });
+
 const withoutIgnoredPaths = (files) =>
   files.filter((file) => {
     const relativePath = path.relative(process.cwd(), file);
@@ -17,17 +41,29 @@ const withoutIgnoredPaths = (files) =>
   });
 
 export default {
-  './document/**/**/*.mdx': (files) =>
-    files.length === 0
-      ? []
-      : [
-        'pnpm -C ./document run format-doc',
-        'pnpm -C ./document run initDocTime',
-        'pnpm -C ./document run initDocToc',
-        'pnpm -C ./document run checkDocRefs',
-        'pnpm -C ./document run removeInvalidImg',
-        'git add .'
-      ],
+  './document/**/**/*.mdx': (files) => {
+    if (files.length === 0) return [];
+
+    const filenames = quoteDocumentFiles(files);
+    const textlintFiles = withoutTranslatedDocumentFiles(files);
+    const textlintFilenames = quoteDocumentFiles(textlintFiles);
+
+    return [
+      ...(textlintFiles.length > 0
+        ? [`pnpm -C ./document exec textlint --fix ${textlintFilenames}`]
+        : []),
+      `pnpm -C ./document exec prettier --config ../.prettierrc.js --write ${filenames}`,
+      ...(textlintFiles.length > 0
+        ? [`pnpm -C ./document exec textlint ${textlintFilenames}`]
+        : []),
+      'pnpm -C ./document run initDocTime',
+      'pnpm -C ./document run initDocToc',
+      'pnpm -C ./document run checkDocRefs',
+      'pnpm -C ./document run removeInvalidImg',
+      `git add -- ${quoteDocumentArtifactPaths()}`,
+      'git add -u -- document/public/imgs'
+    ];
+  },
   '**/*.{ts,tsx}': (files) => {
     const lintFiles = withoutIgnoredPaths(files);
     if (lintFiles.length === 0) return [];

package.json

@@ -28,18 +28,18 @@
   "devDependencies": {
     "@chakra-ui/cli": "^2.4.1",
     "@vitest/coverage-v8": "catalog:",
-    "eslint": "catalog:eslint",
-    "eslint-config-next": "catalog:eslint",
+    "eslint": "catalog:lint",
+    "eslint-config-next": "catalog:lint",
     "husky": "^8.0.3",
     "i18next": "catalog:",
     "js-yaml": "catalog:",
-    "lint-staged": "catalog:",
+    "lint-staged": "catalog:lint",
     "mongodb-memory-server": "catalog:",
     "next-i18next": "catalog:",
-    "prettier": "catalog:",
+    "prettier": "catalog:lint",
     "react-i18next": "catalog:",
     "turbo": "2.9.9",
-    "typescript-eslint": "catalog:eslint",
+    "typescript-eslint": "catalog:lint",
     "typescript": "catalog:",
     "vitest": "catalog:"
   },