feat: support check dead links in lint command (#184)

Co-authored-by: Copilot <[email protected]>

Author: JounQin

.changeset/metal-turkeys-pay.md

@@ -0,0 +1,5 @@
+---
+"@alauda/doom-export": patch
+---
+
+chore(deps): lock playwright version

.changeset/silly-rabbits-invite.md

@@ -0,0 +1,5 @@
+---
+"@alauda/doom": patch
+---
+
+feat: support check dead links in lint command

package.json

@@ -33,20 +33,20 @@
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.1",
     "@changesets/cli": "^2.29.7",
-    "@eslint/js": "^9.35.0",
+    "@eslint/js": "^9.36.0",
     "@swc-node/register": "^1.11.1",
-    "@swc/core": "1.13.5",
+    "@swc/core": "^1.13.20",
     "@types/cli-progress": "^3.11.6",
     "@types/ejs": "^3.1.5",
     "@types/mdast": "^4.0.4",
-    "@types/node": "^22.18.5",
+    "@types/node": "^22.18.6",
     "@types/picomatch": "^4.0.2",
     "@types/pluralize": "^0.0.33",
-    "@types/react": "^19.1.13",
+    "@types/react": "^19.1.15",
     "@types/react-dom": "^19.1.9",
     "@types/swagger2openapi": "^7.0.4",
     "@unts/patch-package": "^8.1.1",
-    "eslint": "^9.35.0",
+    "eslint": "^9.36.0",
     "eslint-import-resolver-typescript": "^4.4.4",
     "eslint-plugin-import-x": "^4.16.1",
     "eslint-plugin-react-hooks": "^5.2.0",

packages/doom/package.json

@@ -45,25 +45,25 @@
     "@eslint-react/eslint-plugin": "^1.53.1",
     "@inquirer/prompts": "^7.8.6",
     "@openapi-contrib/openapi-schema-to-json-schema": "^5.1.0",
-    "@playwright/browser-chromium": "^1.55.0",
-    "@rsbuild/plugin-react": "^1.4.0",
+    "@playwright/browser-chromium": "^1.55.1",
+    "@rsbuild/plugin-react": "^1.4.1",
     "@rsbuild/plugin-sass": "^1.4.0",
     "@rsbuild/plugin-svgr": "^1.2.2",
     "@rsbuild/plugin-yaml": "^1.0.3",
-    "@rspress/core": "2.0.0-beta.32",
-    "@rspress/plugin-algolia": "2.0.0-beta.32",
-    "@rspress/plugin-llms": "2.0.0-beta.32",
-    "@rspress/plugin-sitemap": "2.0.0-beta.32",
-    "@rspress/shared": "2.0.0-beta.32",
-    "@shikijs/transformers": "^3.12.2",
+    "@rspress/core": "2.0.0-beta.34",
+    "@rspress/plugin-algolia": "2.0.0-beta.34",
+    "@rspress/plugin-llms": "2.0.0-beta.34",
+    "@rspress/plugin-sitemap": "2.0.0-beta.34",
+    "@rspress/shared": "2.0.0-beta.34",
+    "@shikijs/transformers": "^3.13.0",
     "@total-typescript/ts-reset": "^0.6.1",
     "ab64": "^0.1.6",
     "chokidar": "^4.0.3",
     "clsx": "^2.1.1",
     "commander": "^13.1.0 || ^14.0.1",
     "ejs": "^3.1.10",
     "es-toolkit": "^1.39.10",
-    "eslint": "^9.35.0",
+    "eslint": "^9.36.0",
     "eslint-plugin-mdx": "^3.6.2",
     "globals": "^16.4.0",
     "html-tag-names": "^2.1.0",
@@ -74,8 +74,8 @@
     "mdast-util-phrasing": "^4.1.0",
     "mdast-util-to-markdown": "^2.1.2",
     "mdast-util-to-string": "^4.0.0",
-    "mermaid": "^11.11.0",
-    "openai": "^5.20.3",
+    "mermaid": "^11.12.0",
+    "openai": "^5.23.1",
     "openapi-types": "^12.1.3",
     "p-ratelimit": "^1.0.1",
     "picomatch": "^4.0.3",
@@ -96,14 +96,14 @@
     "remark-mdx": "^3.1.1",
     "remark-message-control": "^8.0.0",
     "remark-stringify": "^11.0.0",
-    "shiki": "^3.12.2",
+    "shiki": "^3.13.0",
     "simple-git": "^3.28.0",
     "string-width": "^7.2.0",
     "swagger2openapi": "^7.0.8",
     "tinyglobby": "^0.2.15",
     "type-fest": "^4.41.0 || ^5.0.0",
     "typescript": "^5.9.2",
-    "typescript-eslint": "^8.44.0",
+    "typescript-eslint": "^8.44.1",
     "unified": "^11.0.5",
     "unified-lint-rule": "^3.0.1",
     "unist-util-position": "^5.0.0",

packages/doom/src/cli/helpers.ts

@@ -4,8 +4,8 @@ import { glob } from 'tinyglobby'
 import { xfetch } from 'x-fetch'
 import { parse } from 'yaml'
 
-import { FALSY_VALUES, TRUTHY_VALUES } from '../shared/index.js'
-import type { NormalizedTermItem } from '../terms.js'
+import { FALSY_VALUES, TRUTHY_VALUES } from '../shared/index.ts'
+import type { NormalizedTermItem } from '../terms.ts'
 
 export const parseBoolean = (value?: string) =>
   value === undefined || !FALSY_VALUES.has(value)

packages/doom/src/cli/lint.ts

@@ -1,18 +1,21 @@
+import fs from 'node:fs/promises'
 import path from 'node:path'
 
 import { logger } from '@rspress/core'
 import { Command } from 'commander'
 import { ESLint } from 'eslint'
 import { cyan } from 'yoctocolors'
 
-import doom from '../eslint.js'
-import type { GlobalCliOptions } from '../types.js'
+import doom from '../eslint.ts'
+import type { GlobalCliOptions } from '../types.ts'
+import { OPTIONS_FILE, STORAGE_DIR } from '../utils/index.ts'
 
-import { loadConfig } from './load-config.js'
+import { loadConfig } from './load-config.ts'
 
 export interface LintCommandOptions {
   cspell?: boolean
   glob: string | string[]
+  debug?: boolean
 }
 
 export const lintCommand = new Command('lint')
@@ -24,10 +27,22 @@ export const lintCommand = new Command('lint')
     '**/*.{js,jsx,ts,tsx,md,mdx}',
   )
   .option('--no-cspell', 'Disable cspell linting')
+  .option('--debug', 'Show debug logs', false)
   .action(async function (root?: string) {
-    const { cspell, glob, ...globalOptions } = this.optsWithGlobals<
-      LintCommandOptions & GlobalCliOptions
-    >()
+    const {
+      cspell,
+      glob,
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      debug,
+      ...globalOptions
+    } = this.optsWithGlobals<LintCommandOptions & GlobalCliOptions>()
+
+    await fs.mkdir(STORAGE_DIR, { recursive: true })
+
+    await fs.writeFile(
+      OPTIONS_FILE,
+      JSON.stringify({ root, globalOptions }, null, 2),
+    )
 
     const { config } = await loadConfig(root, globalOptions)
 

packages/doom/src/cli/load-config.ts

@@ -31,7 +31,7 @@ import { difference } from 'es-toolkit'
 import { glob } from 'tinyglobby'
 import { cyan } from 'yoctocolors'
 
-import { attributesPlugin } from '../plugins/attributes/index.js'
+import { attributesPlugin } from '../plugins/attributes/index.ts'
 import {
   apiPlugin,
   autoSidebarPlugin,
@@ -42,24 +42,24 @@ import {
   mermaidPlugin,
   permissionPlugin,
   replacePlugin,
-} from '../plugins/index.js'
+} from '../plugins/index.ts'
 import {
   isExplicitlyUnversioned,
   normalizeSlash,
   UNVERSIONED,
   type DoomSite,
-} from '../shared/index.js'
-import type { AlgoliaOptions, ExportItem, GlobalCliOptions } from '../types.js'
-import { pathExists, pkgResolve, resolveStaticConfig } from '../utils/index.js'
+} from '../shared/index.ts'
+import type { AlgoliaOptions, ExportItem, GlobalCliOptions } from '../types.ts'
+import { pathExists, pkgResolve, resolveStaticConfig } from '../utils/index.ts'
 
 import {
   DEFAULT_CONFIG_NAME,
   DEFAULT_EXTENSIONS,
   I18N_FILE,
   SITES_FILE,
   YAML_EXTENSIONS,
-} from './constants.js'
-import { defaultGitHubUrl, isDoc } from './helpers.js'
+} from './constants.ts'
+import { defaultGitHubUrl, isDoc } from './helpers.ts'
 
 const DEFAULT_LOGO = '/logo.svg'
 

packages/doom/src/plugins/api/index.ts

@@ -3,11 +3,11 @@ import type { RspressPlugin } from '@rspress/core'
 import type { OpenAPI, OpenAPIV3_1 } from 'openapi-types'
 import { convertObj } from 'swagger2openapi'
 
-import { generateRuntimeModule } from '../../utils/index.js'
+import { generateRuntimeModule } from '../../utils/index.ts'
 
-import type { ApiPluginOptions, CustomResourceDefinition } from './types.js'
+import type { ApiPluginOptions, CustomResourceDefinition } from './types.ts'
 
-export type * from './types.js'
+export type * from './types.ts'
 
 // @internal
 declare module 'doom-@api-crdsMap' {

packages/doom/src/plugins/attributes/index.ts

@@ -1,6 +1,6 @@
 import type { RspressPlugin } from '@rspress/core'
 
-import { remarkAttributes } from './remark-attributes/index.js'
+import { remarkAttributes } from './remark-attributes/index.ts'
 
 export const attributesPlugin = (): RspressPlugin => {
   return {

packages/doom/src/plugins/attributes/remark-attributes/index.ts

@@ -2,10 +2,10 @@ import type { Root } from 'mdast'
 import type { Extension as FromMarkdownExtension } from 'mdast-util-from-markdown'
 import type { Plugin } from 'unified'
 
-import { attributesTransformer } from './attributes-transformer.js'
-import { mdastAttributes } from './mdast-attributes.js'
-import { micromarkAttributes } from './micromark-attributes.js'
-import type { AttributesExtension } from './types.js'
+import { attributesTransformer } from './attributes-transformer.ts'
+import { mdastAttributes } from './mdast-attributes.ts'
+import { micromarkAttributes } from './micromark-attributes.ts'
+import type { AttributesExtension } from './types.ts'
 
 export interface AttributesData {
   micromarkExtensions?: AttributesExtension[]