gvt doc — 生成开发规范文档

从钩子模块配置生成模块自身的开发规范 Markdown 文档，放入模块目录下（默认 CONVENTIONS.md）。不带参数时，为所有已启用模块重新生成；指定模块名时只生成该模块（名称来自 gvt ls）。

用法

# 重新生成所有已启用模块的规范文档
gvt doc

# 只为后端模块生成规范文档
gvt doc backend

# 为前端模块生成，指定输出文件名
gvt doc portal --out CODING_STANDARDS.md

参数

参数	简写	说明
--out	-o	输出文件名（默认 CONVENTIONS.md）

gvt doc 不带参数时覆盖所有已启用模块的文档；也可以传入单个模块名（来自 gvt ls 的输出）只更新该模块。文档始终覆盖写入。

自动生成

gvt add 注册模块时会自动调用此功能，为所有已启用的模块生成/更新规范文档，无需手动执行。

文档内容

生成的 Markdown 文档包含：

• 模块基本信息（目录、类型、版本、包管理器）
• 每个检查项的详细信息（状态、命令、阈值、排除目录等）
• 尾部说明如何重新生成

示例输出结构：

# backend 开发规范

> 本文档由 gvt doc 从 .gvt/hook/ 配置文件自动生成

## 基本信息

- 目录：backend
- 模块类型：backend

## 检查项

### 单文件行数检查

- 状态：启用
- 行数限制：
  - 警告阈值：250 行
  - 最大上限：300 行
  - 测试文件：
    - 警告阈值：300 行
    - 最大上限：500 行

### Go 静态检查

- 状态：启用
- 命令：go vet ./...

适用场景

• 修改 .gvt/hook/ 配置文件后，手动重新生成最新规范文档
• 为新成员提供一目了然的代码规范参考
• 在 CI 中生成文档作为制品

注意事项

• 文档始终覆盖写入，不会保留旧内容。
• gvt add 自动覆盖时，为所有已启用模块生成文档（不仅是当前注册的模块）。
• 使用 gvt ls 查看可用的模块名称。