用户输入
$ARGUMENTS
在继续之前,你必须考虑用户输入(如果非空)。
执行前检查
检查扩展钩子(实现前):
- 检查项目根目录下是否存在
.specify/extensions.yml文件。 - 如果存在,读取它并查找
hooks.before_implement键下的条目。 - 如果 YAML 无法解析或无效,请勿静默跳过:告知用户无法读取
.specify/extensions.yml(包含解析器错误),并且没有检查任何钩子(包括其中注册的强制(optional: false)钩子),然后正常继续。 - 过滤掉
enabled显式为false的钩子。没有enabled字段的钩子默认视为已启用。 - 对于剩余的每个钩子,不要尝试解释或评估钩子的
condition表达式:- 如果钩子没有
condition字段,或该字段为 null/空,则将钩子视为可执行。 - 如果钩子定义了非空的
condition,则跳过该钩子,将条件评估留给 HookExecutor 实现。
- 如果钩子没有
- 在从钩子命令名称构造命令调用时,将点(
.)替换为连字符(-)。例如speckit.git.commit→/speckit-git-commit。 - 对于每个可执行的钩子,根据其
optional标志输出以下内容:- 可选钩子(
optional: true):## 扩展钩子 **可选前置钩子**:{extension} 命令:`/{command}` 描述:{description} 提示:{prompt} 执行:`/{command}` - 强制钩子(
optional: false):
发出上述代码块后,你必须实际调用该钩子并等待其完成,然后再继续。使用你在此代理/会话中运行命令的相同方式运行它(调用方式可能不同于上面显示的 literal## 扩展钩子 **自动前置钩子**:{extension} 正在执行:`/{command}` EXECUTE_COMMAND:{command} 在继续到“大纲”之前等待钩子命令的结果。{command}id,例如,技能模式代理以/skill:speckit-...或$speckit-...的形式运行它)。仅发出代码块并不运行钩子。
- 可选钩子(
- 如果没有注册钩子或
.specify/extensions.yml不存在,则静默跳过。
大纲
-
从仓库根目录运行
.specify/scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks并解析 FEATURE_DIR 和 AVAILABLE_DOCS 列表。所有路径必须为绝对路径。对于参数中的单引号(例如 “I'm Groot”),请使用转义语法:例如 'I'''m Groot'(如果可能,也可以使用双引号:“I'm Groot”)。 -
检查清单状态(如果 FEATURE_DIR/checklists/ 存在):
-
将清单标记视为只读门控:扫描复选框状态,报告状态,必要时在继续前询问;不要修改清单文件或标记。
-
checklists/requirements.md是由/speckit-specify和/speckit-clarify维护的内置规范质量清单;由/speckit-checklist生成的自定义清单是评审者拥有的需求质量评审工件。 -
对于自定义清单,
[x]表示评审者认为需求质量标准已满足;这不意味着实现工作已完成。 -
扫描 checklists/ 目录中的所有清单文件。
-
对于每个清单,进行计数:
- 总项:所有匹配
- [ ]或- [X]或- [x]的行。 - 已勾选项:匹配
- [X]或- [x]的行。 - 未勾选项:匹配
- [ ]的行。
- 总项:所有匹配
-
创建状态表:
| 清单 | 总计 | 已勾选 | 未勾选 | 状态 | |-----------|-------|---------|-----------|--------| | ux.md | 12 | 12 | 0 | ✓ 通过 | | test.md | 8 | 5 | 3 | ✗ 失败 | | security.md | 6 | 6 | 0 | ✓ 通过 | -
计算整体状态:
- 通过:所有清单的未勾选项均为 0。
- 失败:一个或多个清单存在未勾选项。
-
如果有任何清单存在未勾选项:
- 显示包含未勾选项计数的表格。
- 停止并询问:“某些清单存在未勾选项。您是否仍要继续实现?(yes/no)”
- 等待用户响应后再继续。
- 如果用户回答“no”或“wait”或“stop”,则停止执行。
- 如果用户回答“yes”或“proceed”或“continue”,则继续执行步骤 3。
-
如果所有清单均已勾选:
- 显示所有清单均通过的表格。
- 自动继续执行步骤 3。
-
-
加载并分析实现上下文:
- 必需:读取 tasks.md 以获取完整任务列表和执行计划。
- 必需:读取 plan.md 以获取技术栈、架构和文件结构。
- 如果存在:读取 data-model.md 以获取实体和关系。
- 如果存在:读取 contracts/ 以获取 API 规范和测试要求。
- 如果存在:读取 research.md 以获取技术决策和约束。
- 如果存在:读取 .specify/memory/constitution.md 以获取治理约束。
- 如果存在:读取 quickstart.md 以获取集成场景。
-
项目设置验证:
- 必需:根据实际项目设置创建/验证忽略文件:
检测与创建逻辑:
-
检查以下命令是否成功执行,以确定仓库是否为 git 仓库(如果是,则创建/验证 .gitignore):
git rev-parse --git-dir 2>/dev/null -
检查 Dockerfile* 是否存在或 Docker 是否在 plan.md 中→创建/验证 .dockerignore。
-
检查 .eslintrc* 是否存在→创建/验证 .eslintignore。
-
检查 eslint.config.* 是否存在→确保配置的
ignores条目覆盖所需模式。 -
检查 .prettierrc* 是否存在→创建/验证 .prettierignore。
-
检查 .npmrc 或 package.json 是否存在→创建/验证 .npmignore(如果正在发布)。
-
检查 terraform 文件(*.tf)是否存在→创建/验证 .terraformignore。
-
检查是否需要 .helmignore(存在 helm charts)→创建/验证 .helmignore。
如果忽略文件已存在:验证它是否包含基本模式,仅附加缺失的关键模式。 如果忽略文件缺失:为检测到的技术创建完整的模式集。
各技术的常用模式(来自 plan.md 技术栈):
- Node.js/JavaScript/TypeScript:
node_modules/、dist/、build/、*.log、.env* - Python:
__pycache__/、*.pyc、.venv/、venv/、dist/、*.egg-info/ - Java:
target/、*.class、*.jar、.gradle/、build/ - C#/.NET:
bin/、obj/、*.user、*.suo、packages/ - Go:
*.exe、*.test、vendor/、*.out - Ruby:
.bundle/、log/、tmp/、*.gem、vendor/bundle/ - PHP:
vendor/、*.log、*.cache、*.env - Rust:
target/、debug/、release/、*.rs.bk、*.rlib、*.prof*、.idea/、*.log、.env* - Kotlin:
build/、out/、.gradle/、.idea/、*.class、*.jar、*.iml、*.log、.env* - C++:
build/、bin/、obj/、out/、*.o、*.so、*.a、*.exe、*.dll、.idea/、*.log、.env* - C:
build/、bin/、obj/、out/、*.o、*.a、*.so、*.exe、*.dll、autom4te.cache/、config.status、config.log、.idea/、*.log、.env* - Swift:
.build/、DerivedData/、*.swiftpm/、Packages/ - R:
.Rproj.user/、.Rhistory、.RData、.Ruserdata、*.Rproj、packrat/、renv/ - 通用:
.DS_Store、Thumbs.db、*.tmp、*.swp、.vscode/、.idea/
工具特定模式:
- Docker:
node_modules/、.git/、Dockerfile*、.dockerignore、*.log*、.env*、coverage/ - ESLint:
node_modules/、dist/、build/、coverage/、*.min.js - Prettier:
node_modules/、dist/、build/、coverage/、package-lock.json、yarn.lock、pnpm-lock.yaml - Terraform:
.terraform/、*.tfstate*、*.tfvars、.terraform.lock.hcl - Kubernetes/k8s:
*.secret.yaml、secrets/、.kube/、kubeconfig*、*.key、*.crt
-
解析 tasks.md 结构并提取:
- 任务阶段:设置、测试、核心、集成、完善。
- 任务依赖关系:顺序执行与并行执行规则。
- 任务详情:ID、描述、文件路径、并行标记 [P]。
- 执行流程:顺序和依赖要求。
-
按照任务计划执行实现:
- 阶段执行:完成每个阶段后再进入下一个阶段。
- 遵循依赖关系:按顺序运行顺序任务,并行任务 [P] 可以同时运行。
- 遵循 TDD 方法:在其对应的实现任务之前执行测试任务。
- 基于文件的协调:影响相同文件的任务必须顺序运行。
- 验证检查点:验证每个阶段完成后再继续。
-
实现执行规则:
- 先进行设置:初始化项目结构、依赖项、配置。
- 测试优先于代码:如果需要为契约、实体和集成场景编写测试。
- 核心开发:实现模型、服务、CLI 命令、端点。
- 集成工作:数据库连接、中间件、日志记录、外部服务。
- 完善与验证:单元测试、性能优化、文档。
-
进度跟踪与错误处理:
- 在完成每个任务后报告进度。
- 如果任何非并行任务失败,则停止执行。
- 对于并行任务 [P],继续成功任务,报告失败任务。
- 提供清晰的错误消息以及调试上下文。
- 如果实现无法继续,建议后续步骤。
- 重要:对于已完成的任务,务必在任务文件中将任务标记为 [X]。
-
完成验证:
- 验证所有必需的任务是否已完成。
- 检查实现的功能是否与原始规范匹配。
- 验证测试通过且覆盖率满足要求。
- 确认实现遵循技术计划。
注意:此命令假定 tasks.md 中存在完整的任务分解。如果任务不完整或缺失,建议先运行 /speckit-tasks 以重新生成任务列表。
强制执行后钩子
在向用户报告完成之前,你必须完成此部分。
检查项目根目录下是否存在 .specify/extensions.yml 文件。
- 如果不存在,或者
hooks.after_implement键下没有注册钩子,则跳至完成报告。 - 如果存在,读取它并查找
hooks.after_implement键下的条目。 - 如果 YAML 无法解析或无效,请勿静默跳过:告知用户无法读取
.specify/extensions.yml(包含解析器错误),并且没有检查任何钩子(包括其中注册的强制(optional: false)钩子),然后继续到完成报告。 - 过滤掉
enabled显式为false的钩子。没有enabled字段的钩子默认视为已启用。 - 对于剩余的每个钩子,不要尝试解释或评估钩子的
condition表达式:- 如果钩子没有
condition字段,或该字段为 null/空,则将钩子视为可执行。 - 如果钩子定义了非空的
condition,则跳过该钩子,将条件评估留给 HookExecutor 实现。
- 如果钩子没有
- 在从钩子命令名称构造命令调用时,将点(
.)替换为连字符(-)。例如speckit.git.commit→/speckit-git-commit。 - 对于每个可执行的钩子,根据其
optional标志输出以下内容:- 强制钩子(
optional: false)— 你必须为每个强制钩子发出EXECUTE_COMMAND::
发出上述代码块后,你必须实际调用该钩子并等待其完成,然后再继续。使用你在此代理/会话中运行命令的相同方式运行它(调用方式可能不同于上面显示的 literal## 扩展钩子 **自动钩子**:{extension} 正在执行:`/{command}` EXECUTE_COMMAND:{command}{command}id,例如,技能模式代理以/skill:speckit-...或$speckit-...的形式运行它)。仅发出代码块并不运行钩子。 - 可选钩子(
optional: true):## 扩展钩子 **可选钩子**:{extension} 命令:`/{command}` 描述:{description} 提示:{prompt} 执行:`/{command}`
- 强制钩子(
完成报告
报告最终状态,并附上已完成工作的摘要。
完成条件
- tasks.md 中的所有任务均已完成并标记为
[X]。 - 实现已根据规范、计划和测试覆盖率进行验证。
- 根据上述“强制执行后钩子”中的规则,扩展钩子已调度或跳过。
- 已向用户报告完成情况,并附上已完成工作的摘要。