Component Docs Batcher

概述

Component Docs Batcher 是一个自动化批量生成和维护前端组件库文档的工具。专为 Monorepo 架构的组件库设计，通过智能扫描主要组件文件，对比文档更新状态，生成规范化的组件文档，确保文档与代码保持同步。

核心功能

• 智能组件识别: 自动识别组件目录中的主要组件文件（如 button/button.tsx），跳过 index.ts、store、hooks 等辅助文件
• Git时间对比: 通过对比组件文件和文档的git最后提交时间，确定文档状态（比文件系统时间更准确）
• 任务清单生成: 自动生成结构化的todos.md任务清单
• 批量文档生成: 按照规范批量生成完整的组件文档
• 组件库优化: 针对 Monorepo 组件库结构优化，文档位于组件目录下的 index.zh-CN.md

工作流程

步骤1: 扫描组件

使用 scan-components.ts 脚本扫描组件库，识别需要处理的组件：