吴让宇
c5905a5b1e
方向反转：此前 SKILL.md 是「模板渲染产物」、sap-cli 是源；现 sap-cli 归档， sap-cli-skill 承接开发与分发，SKILL.md 回归手工维护的正本。 迁移（来自 sap-cli，共 104 文件）： - tests/ 692 例测试（15 个文件的内联 sys.path 改指 assets/） - openspec/ SDD 规格与归档变更（42 文件） - docs/ 开发文档与 ADT 原理（含 dev/CLAUDE.md、AGENTS.md） - .claude/ rules 副本 + settings.json（供 Claude Code） - .github/ .hermes/ .pre-commit-config.yaml .editorconfig CLAUDE.md - scripts/ 保持仅 setup.py（pack_skill.py 已随旧仓归档，不迁） 修复（迁移暴露的真实缺陷）： - assets/pyproject.toml 的 build-backend 写作 `setuptools.backends._legacy:_Backend`， 该模块在 setuptools 中不存在 → `pip install -e` 从来装不上。改为 build_meta。 实测：临时 venv 安装成功，sap-cli --help 正常列出 31 个命令 - pyproject readme 指向不存在的 assets/README.md（editable 安装会失败）→ 改内联文本 - pyproject urls 改指 sap-cli-skill 机制调整： - .github/workflows/ci.yml 适配 assets/ 布局；顶部注明该工作流仅 GitHub 执行， 本仓在 Gitee 不会自动跑 - pre-commit 增本地测试门禁（Gitee 上真正生效的那道） - .gitignore 合并旧仓完整规则（保留 log/ 下 md 知识库入库，只忽略运行日志） - 大文件上限 100KB→1MB（架构图 512KB） 守卫测试 tests/unit/test_repo_guards.py（10 → 18 例）： - SKILL.md 须记录 parser 全部 CLI 命令 / 铁律 1-5 须为真实小节标题 / 示例不得违反铁律 5 - references/ 规则齐备；.claude/rules 与 references 必须一致（实测抓到一次真实漂移） - VERSION == sapcli.__version__ == README 版本 - 仓内不得再出现 pack_skill.py / skill-src（防废弃流程回潮） 698 tests OK；editable 安装与 CLI 入口经临时 venv 实测通过。 docs/RELEASING.md 重写为单源开发流程。
80 lines
2.6 KiB
Markdown
80 lines
2.6 KiB
Markdown
# Search and Browse Specification
|
|
|
|
## Purpose
|
|
|
|
定义 sap-cli 的搜索和浏览功能行为，包括对象列表、引用查询和源码搜索。
|
|
|
|
## Requirements
|
|
|
|
### Requirement: Object Listing
|
|
|
|
系统 SHALL 列出 SAP 系统中指定类型的开发对象。
|
|
|
|
#### Scenario: List by type with prefix
|
|
- **WHEN** 用户执行 list 命令并指定对象类型和前缀筛选
|
|
- **THEN** 系统显示匹配的对象名称列表
|
|
|
|
#### Scenario: List without filter
|
|
- **WHEN** 用户执行 list 命令但未指定筛选条件
|
|
- **THEN** 系统显示该类型的所有可访问对象
|
|
|
|
### Requirement: Where-Used Query
|
|
|
|
系统 SHALL 查询指定对象在其他开发对象中的引用关系。
|
|
|
|
#### Scenario: Find references
|
|
- **WHEN** 用户执行 whereused 命令并指定对象名称和类型
|
|
- **THEN** 系统显示所有引用该对象的开发对象列表
|
|
|
|
#### Scenario: No references found
|
|
- **WHEN** 指定对象没有被任何其他对象引用
|
|
- **THEN** 系统显示无引用结果的信息
|
|
|
|
### Requirement: Source Code Search
|
|
|
|
系统 SHALL 在 SAP 系统中搜索源代码内容。
|
|
|
|
#### Scenario: Search by keyword
|
|
- **WHEN** 用户执行 search 命令并提供搜索关键词
|
|
- **THEN** 系统显示包含该关键词的对象名称、类型和匹配行
|
|
|
|
#### Scenario: Search no results
|
|
- **WHEN** 搜索关键词没有匹配结果
|
|
- **THEN** 系统显示无搜索结果的信息
|
|
|
|
### Requirement: Code Diff
|
|
|
|
系统 SHALL 对比本地源码与 SAP 系统中当前版本的差异。
|
|
|
|
#### Scenario: Diff with differences
|
|
- **WHEN** 用户执行 diff 命令，本地文件与 SAP 版本存在差异
|
|
- **THEN** 系统显示差异内容（新增、删除、修改的行）
|
|
|
|
#### Scenario: Diff identical
|
|
- **WHEN** 本地文件与 SAP 版本完全一致
|
|
- **THEN** 系统显示无差异的信息
|
|
|
|
### Requirement: CDS View Operations
|
|
|
|
系统 SHALL 支持 CDS View 的下载和创建操作。
|
|
|
|
#### Scenario: Download CDS view
|
|
- **WHEN** 用户执行 cds download 命令并指定 CDS View 名称
|
|
- **THEN** 系统下载 CDS View 定义并保存到本地
|
|
|
|
#### Scenario: Create CDS view
|
|
- **WHEN** 用户执行 cds create 命令并指定名称和描述
|
|
- **THEN** 系统在 SAP 中创建新的 CDS View
|
|
|
|
### Requirement: Package Operations
|
|
|
|
系统 SHALL 支持 ABAP 包的查询和创建操作。
|
|
|
|
#### Scenario: Query package info
|
|
- **WHEN** 用户执行 package info 命令并指定包名
|
|
- **THEN** 系统显示包的描述、包含的对象数量等信息
|
|
|
|
#### Scenario: Create package
|
|
- **WHEN** 用户执行 package create 命令并指定包名和描述
|
|
- **THEN** 系统在 SAP 中创建新的 ABAP 包
|