代码检查

文档站点的内容质量下降会损害产品本身。Nimbus 对待编写质量就像代码检查工具对待源码——一套你按需运行的规则。

两层机制

构建前的校验器自动运行，仅在问题会导致站点无法正常工作时才阻止构建——配置结构、frontmatter schema、MDX 组件、重复路由。

lint 引擎是按需的编写质量层。规则有稳定的 ID，如 nimbus/single-h1 和 nimbus/bare-url。构建永远不会被 lint 发现所阻止——草稿仍会渲染，警告仍然突出但不会阻塞。

运行

npx @cloudflare/nimbus-docs lint

yarn dlx @cloudflare/nimbus-docs lint

pnpm dlx @cloudflare/nimbus-docs lint

bunx @cloudflare/nimbus-docs lint

标志——与 lint 组合使用：

它遍历 src/content/，运行你启用的每条编写规则，当任何 error 级别的发现存在时以非零状态退出。

配置严重级别

严重级别覆盖在集成中配置。将规则映射为 "error"、"warn" 或 "off"：

nimbus(config, {
  rules: {
    "nimbus/single-h1": "error",
    "nimbus/bare-url": "warn",
  },
  collections: {
    partials: { rules: { "nimbus/single-h1": "off" } },
  },
});

集合级 rules 与顶层集合进行浅合并。编写规则默认关闭——完全省略 rules 不会运行任何规则；你需要逐条规则启用。

文件内禁用

使用 nimbusDisableRules frontmatter 或行内注释对单个文件禁用规则——无需配置。上面配置的严重级别会被物化到 .nimbus/lint.json，这样独立 CLI 读取到的配置与集成相同。