feat: 添加 --advice 参数,支持快速获取执行建议
- 新增 scripts/core/advice_generator.py 建议生成器模块 - 在 config.py 中添加 DEPENDENCIES 依赖配置 - 在 lyxy_document_reader.py 中添加 -a/--advice 参数 - 复用 Reader 实例的 supports 方法检测文件类型 - 支持平台检测,对 macOS x86_64 PDF 返回特殊命令 - 添加单元测试和集成测试 - 更新 SKILL.md,引导优先使用 --advice 参数 - 更新 README.md,添加项目结构说明 - 添加 openspec/specs/cli-advice/spec.md 规范文档
This commit is contained in:
26
README.md
26
README.md
@@ -6,18 +6,23 @@
|
||||
|
||||
- 使用 uv 运行脚本和测试,禁用主机 Python
|
||||
- 依赖管理:使用 `uv run --with` 按需加载依赖
|
||||
- 依赖说明:详见 SKILL.md 的"依赖安装指南"章节
|
||||
- 快速获取建议:使用 `-a/--advice` 参数查看执行命令,无需手动查找依赖
|
||||
|
||||
## 项目结构
|
||||
|
||||
```
|
||||
scripts/ # 核心代码
|
||||
├── core/ # 核心模块(解析调度、异常、Markdown 工具)
|
||||
├── readers/ # 格式阅读器
|
||||
└── utils/ # 工具函数
|
||||
tests/ # 测试
|
||||
openspec/ # 规范文档
|
||||
skill/ # SKILL 文档
|
||||
scripts/ # 核心代码
|
||||
├── core/ # 核心模块
|
||||
│ ├── advice_generator.py # 执行建议生成器(新增)
|
||||
│ ├── parser.py # 解析调度
|
||||
│ ├── exceptions.py # 异常定义
|
||||
│ └── markdown.py # Markdown 工具
|
||||
├── readers/ # 格式阅读器
|
||||
├── utils/ # 工具函数
|
||||
└── config.py # 配置(含 DEPENDENCIES 依赖配置)
|
||||
tests/ # 测试
|
||||
openspec/ # 规范文档
|
||||
skill/ # SKILL 文档
|
||||
```
|
||||
|
||||
## 开发工作流
|
||||
@@ -160,7 +165,7 @@ uv run \
|
||||
- 编码测试(GBK、UTF-8 BOM 等)
|
||||
- 一致性测试(验证不同 Reader 解析结果的一致性)
|
||||
|
||||
运行测试前,请根据测试类型使用 `uv run --with` 安装对应的依赖包。详见上方的"开发工作流"章节和 SKILL.md 的"依赖安装指南"。
|
||||
运行测试前,请根据测试类型使用 `uv run --with` 安装对应的依赖包。详见上方的"开发工作流"章节。
|
||||
|
||||
|
||||
## 代码规范
|
||||
@@ -196,8 +201,7 @@ skill/SKILL.md 面向 AI 用户,必须遵循 Claude Skill 构建指南的最
|
||||
|
||||
- 使用 `uv run --with` 方式按需加载依赖
|
||||
- 必须使用具体的 pip 包名
|
||||
- 按文档类型分组说明
|
||||
- 详见 SKILL.md 的"依赖安装指南"章节
|
||||
- 使用 `-a/--advice` 参数可快速获取针对具体文件的执行命令
|
||||
|
||||
## 解析器架构
|
||||
|
||||
|
||||
Reference in New Issue
Block a user