refactor: 本仓升为唯一源(原 sap-cli 源码仓归档)
方向反转:此前 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 重写为单源开发流程。
This commit is contained in:
@@ -0,0 +1,4 @@
|
||||
schema: spec-driven
|
||||
change: add-upload-syntax-check
|
||||
status: archived
|
||||
archived_at: "2026-06-13"
|
||||
@@ -0,0 +1,19 @@
|
||||
# Proposal: 新增 upload 和 syntax-check 独立命令
|
||||
|
||||
## Why
|
||||
|
||||
sync 命令耦合了五步操作,无法满足只上传不激活、只检查语法的场景。拆分为原子命令后,用户可按需组合操作。
|
||||
|
||||
## What Changes
|
||||
|
||||
- 新增 upload 命令(锁定→写入→解锁,不检查不激活)
|
||||
- 新增 syntax-check 命令(检查远程对象语法,不上传不激活)
|
||||
|
||||
## Impact
|
||||
|
||||
- 新增 sapcli/commands/upload.py
|
||||
- 新增 sapcli/commands/syntax_check.py
|
||||
- parser.py 新增两个命令注册
|
||||
- app.py 新增命令路由
|
||||
- object-lifecycle spec 新增两个 Requirement
|
||||
- sync 命令完全不变
|
||||
+47
@@ -0,0 +1,47 @@
|
||||
## ADDED Requirements
|
||||
|
||||
### Requirement: Source Code Upload
|
||||
|
||||
系统 SHALL 上传本地源代码到 SAP 系统,执行锁定→写入→解锁流程,不执行语法检查和激活。
|
||||
upload 不会自动创建对象——上传前对象必须已存在于 SAP 系统中。
|
||||
|
||||
#### Scenario: Upload success
|
||||
- **WHEN** 用户执行 upload 命令,对象已存在于 SAP,本地文件有效
|
||||
- **THEN** 系统执行锁定、写入源码、解锁,报告写入的字符数和行数,不执行语法检查和激活
|
||||
|
||||
#### Scenario: Upload non-existent object
|
||||
- **WHEN** 用户上传一个 SAP 中不存在的对象
|
||||
- **THEN** 系统报告对象不存在的错误(不自动创建,区别于 sync)
|
||||
|
||||
#### Scenario: Upload with transport request
|
||||
- **WHEN** 用户通过 --corr_nr 指定传输请求号
|
||||
- **THEN** 系统使用该传输请求号进行锁定和写入
|
||||
|
||||
#### Scenario: Upload type without source
|
||||
- **WHEN** 用户尝试上传不支持源码的类型(如 functiongroup、tabletype、messageclass、searchhelp、lockobject)
|
||||
- **THEN** 系统报告该类型不支持上传操作
|
||||
|
||||
#### Scenario: Upload local file not found
|
||||
- **WHEN** 用户指定的本地源码文件路径不存在
|
||||
- **THEN** 系统报告文件不存在的错误
|
||||
|
||||
### Requirement: Syntax Check
|
||||
|
||||
系统 SHALL 对 SAP 远程对象的源代码执行语法检查,不上传代码、不激活。
|
||||
syntax-check 检查 SAP 上现有对象的源码(通常是 active 状态),用于验证结构变更后的依赖影响。
|
||||
|
||||
#### Scenario: Syntax check passed
|
||||
- **WHEN** 用户执行 syntax-check 命令,对象的源码无语法错误
|
||||
- **THEN** 系统报告语法检查通过
|
||||
|
||||
#### Scenario: Syntax check failed
|
||||
- **WHEN** 对象源码包含语法错误
|
||||
- **THEN** 系统报告语法检查未通过,显示每个错误的行号和描述
|
||||
|
||||
#### Scenario: Syntax check non-existent object
|
||||
- **WHEN** 用户对 SAP 中不存在的对象执行语法检查
|
||||
- **THEN** 系统报告对象不存在的错误
|
||||
|
||||
#### Scenario: Syntax check type without source
|
||||
- **WHEN** 用户对不支持源码的类型(如 functiongroup、tabletype)执行语法检查
|
||||
- **THEN** 系统报告该类型不支持语法检查操作
|
||||
@@ -0,0 +1,44 @@
|
||||
## 1. OpenSpec 规范
|
||||
|
||||
- [x] 1.1 创建 openspec/changes/add-upload-syntax-check/ 变更目录
|
||||
- [x] 1.2 编写 proposal.md(Why / What Changes / Impact)
|
||||
- [x] 1.3 编写 specs/object-lifecycle/spec.md(ADDED: Source Code Upload、Syntax Check)
|
||||
- [x] 1.4 编写 tasks.md 任务清单
|
||||
|
||||
## 2. TDD 测试(先写测试,必须 RED)
|
||||
|
||||
- [x] 2.1 TestUploadCommand:test_upload_success(断言 syntax_check/activate 未被调用)
|
||||
- [x] 2.2 TestUploadCommand:test_upload_nonexistent_object(ObjectNotFoundError)
|
||||
- [x] 2.3 TestUploadCommand:test_upload_type_without_source(InvalidNameError)
|
||||
- [x] 2.4 TestUploadCommand:test_upload_with_corr_nr(通过 --corr_nr 指定)
|
||||
- [x] 2.5 TestUploadCommand:test_upload_file_not_found(ConfigError)
|
||||
- [x] 2.6 TestSyntaxCheckCommand:test_syntax_check_passed(输出含"通过")
|
||||
- [x] 2.7 TestSyntaxCheckCommand:test_syntax_check_failed(输出含错误行号)
|
||||
- [x] 2.8 TestSyntaxCheckCommand:test_syntax_check_nonexistent(ObjectNotFoundError)
|
||||
- [x] 2.9 TestSyntaxCheckCommand:test_syntax_check_type_without_source(InvalidNameError)
|
||||
- [x] 2.10 运行测试确认全部 RED(9 个测试 ModuleNotFoundError 失败)
|
||||
|
||||
## 3. 实现命令
|
||||
|
||||
- [x] 3.1 实现 sapcli/commands/upload.py(cmd_upload,参照 activate.py 结构)
|
||||
- [x] 3.2 实现 sapcli/commands/syntax_check.py(cmd_syntax_check)
|
||||
|
||||
## 4. Parser 注册 + App 路由
|
||||
|
||||
- [x] 4.1 parser.py 注册 upload_parser(--name/--type/--path/--corr_nr)
|
||||
- [x] 4.2 parser.py 注册 syntax-check 的 sc_parser(--name/--type)
|
||||
- [x] 4.3 commands/__init__.py 导出 cmd_upload / cmd_syntax_check
|
||||
- [x] 4.4 app.py 导入并路由 upload / syntax-check
|
||||
|
||||
## 5. 验证(必须 GREEN)
|
||||
|
||||
- [x] 5.1 运行 pytest tests/unit/ 全部通过(363 passed)
|
||||
- [x] 5.2 python main.py upload --help / syntax-check --help 正常
|
||||
- [x] 5.3 python main.py --help 出现两个新命令
|
||||
- [x] 5.4 python main.py sync --help 参数未变(回归验证通过)
|
||||
- [x] 5.5 openspec validate add-upload-syntax-check → valid
|
||||
|
||||
## 6. 收尾
|
||||
|
||||
- [x] 6.1 tasks.md 所有 checkbox 标记为 [x]
|
||||
- [x] 6.2 .openspec.yaml status 改为 completed
|
||||
Reference in New Issue
Block a user