💫 Toolkit to help you get started with SDD or any other process!
add --require-spec to check-prerequisites (#4367)
Huzaifa Iftikharac55a7a9558f
diff --git a/scripts/bash/check-prerequisites.sh b/scripts/bash/check-prerequisites.shindex c21edc41f..7d6dba135 100644--- a/scripts/bash/check-prerequisites.sh+++ b/scripts/bash/check-prerequisites.sh@@ -9,6 +9,7 @@## OPTIONS:# --json Output in JSON format+# --require-spec Require spec.md to exist (for analysis phase)# --require-tasks Require tasks.md to exist (for implementation phase)# --include-tasks Include tasks.md in AVAILABLE_DOCS list# --paths-only Only output path variables (no validation)@@ -24,6 +25,7 @@ set -e# Parse command line argumentsJSON_MODE=false+REQUIRE_SPEC=falseREQUIRE_TASKS=falseINCLUDE_TASKS=falsePATHS_ONLY=false@@ -34,6 +36,9 @@ while [[ $# -gt 0 ]]; do--json)JSON_MODE=true;;+ --require-spec)+ REQUIRE_SPEC=true+ ;;--require-tasks)REQUIRE_TASKS=true;;@@ -59,6 +64,7 @@ Consolidated prerequisite checking for Spec-Driven Development workflow.OPTIONS:--json Output in JSON format+ --require-spec Require spec.md to exist (for analysis phase)--require-tasks Require tasks.md to exist (for implementation phase)--include-tasks Include tasks.md in AVAILABLE_DOCS list--paths-only Only output path variables (no prerequisite validation)@@ -142,6 +148,13 @@ if [[ ! -f "$IMPL_PLAN" ]]; thenexit 1fi+# Check for spec.md if required+if $REQUIRE_SPEC && [[ ! -f "$FEATURE_SPEC" ]]; then+ echo "ERROR: spec.md not found in $FEATURE_DIR" >&2+ echo "Run $(format_speckit_command specify "$REPO_ROOT") first to create the feature specification." >&2+ exit 1+fi+# Check for tasks.md if requiredif $REQUIRE_TASKS && [[ ! -f "$TASKS" ]]; thenecho "ERROR: tasks.md not found in $FEATURE_DIR" >&2diff --git a/scripts/powershell/check-prerequisites.ps1 b/scripts/powershell/check-prerequisites.ps1index 27c87d6c6..0e9434d06 100644--- a/scripts/powershell/check-prerequisites.ps1+++ b/scripts/powershell/check-prerequisites.ps1@@ -9,6 +9,7 @@## OPTIONS:# -Json Output in JSON format+# -RequireSpec Require spec.md to exist (for analysis phase)# -RequireTasks Require tasks.md to exist (for implementation phase)# -IncludeTasks Include tasks.md in AVAILABLE_DOCS list# -PathsOnly Only output path variables (no validation)@@ -18,6 +19,7 @@[CmdletBinding()]param([switch]$Json,+ [switch]$RequireSpec,[switch]$RequireTasks,[switch]$IncludeTasks,[switch]$PathsOnly,@@ -36,6 +38,7 @@ Consolidated prerequisite checking for Spec-Driven Development workflow.OPTIONS:-Json Output in JSON format+ -RequireSpec Require spec.md to exist (for analysis phase)-RequireTasks Require tasks.md to exist (for implementation phase)-IncludeTasks Include tasks.md in AVAILABLE_DOCS list-PathsOnly Only output path variables (no prerequisite validation)@@ -105,6 +108,14 @@ if (-not (Test-Path $paths.IMPL_PLAN -PathType Leaf)) {exit 1}+# Check for spec.md if required+if ($RequireSpec -and -not (Test-Path $paths.FEATURE_SPEC -PathType Leaf)) {+ [Console]::Error.WriteLine("ERROR: spec.md not found in $($paths.FEATURE_DIR)")+ $specifyCommand = Format-SpecKitCommand -CommandName 'specify' -RepoRoot $paths.REPO_ROOT+ [Console]::Error.WriteLine("Run $specifyCommand first to create the feature specification.")+ exit 1+}+# Check for tasks.md if requiredif ($RequireTasks -and -not (Test-Path $paths.TASKS -PathType Leaf)) {[Console]::Error.WriteLine("ERROR: tasks.md not found in $($paths.FEATURE_DIR)")diff --git a/scripts/python/check_prerequisites.py b/scripts/python/check_prerequisites.pyindex a5dc3e7e3..e025b4d67 100644--- a/scripts/python/check_prerequisites.py+++ b/scripts/python/check_prerequisites.py@@ -37,6 +37,7 @@ Consolidated prerequisite checking for Spec-Driven Development workflow.OPTIONS:--json Output in JSON format+ --require-spec Require spec.md to exist (for analysis phase)--require-tasks Require tasks.md to exist (for implementation phase)--include-tasks Include tasks.md in AVAILABLE_DOCS list--paths-only Only output path variables (no prerequisite validation)@@ -59,6 +60,7 @@ EXAMPLES:@dataclass(frozen=True)class Args:json_mode: bool = False+ require_spec: bool = Falserequire_tasks: bool = Falseinclude_tasks: bool = Falsepaths_only: bool = False@@ -67,6 +69,7 @@ class Args:def _parse_args(argv: list[str]) -> Args:json_mode = False+ require_spec = Falserequire_tasks = Falseinclude_tasks = Falsepaths_only = False@@ -77,6 +80,8 @@ def _parse_args(argv: list[str]) -> Args:arg = argv[index]if arg == "--json":json_mode = True+ elif arg == "--require-spec":+ require_spec = Trueelif arg == "--require-tasks":require_tasks = Trueelif arg == "--include-tasks":@@ -105,6 +110,7 @@ def _parse_args(argv: list[str]) -> Args:return Args(json_mode=json_mode,+ require_spec=require_spec,require_tasks=require_tasks,include_tasks=include_tasks,paths_only=paths_only,@@ -230,6 +236,14 @@ def main(argv: list[str] | None = None) -> int:)return 1+ if args.require_spec and not paths.feature_spec.is_file():+ print(f"ERROR: spec.md not found in {paths.feature_dir}", file=sys.stderr)+ print(+ f"Run {format_speckit_command('specify', paths.repo_root)} first to create the feature specification.",+ file=sys.stderr,+ )+ return 1+if args.require_tasks and not paths.tasks.is_file():print(f"ERROR: tasks.md not found in {paths.feature_dir}", file=sys.stderr)print(diff --git a/templates/commands/analyze.md b/templates/commands/analyze.mdindex 2cd83bd7c..2e13af58a 100644--- a/templates/commands/analyze.md+++ b/templates/commands/analyze.md@@ -1,9 +1,9 @@---description: Perform a non-destructive cross-artifact consistency and quality analysis across spec.md, plan.md, and tasks.md after task generation.scripts:- sh: scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks- ps: scripts/powershell/check-prerequisites.ps1 -Json -RequireTasks -IncludeTasks- py: scripts/python/check_prerequisites.py --json --require-tasks --include-tasks+ sh: scripts/bash/check-prerequisites.sh --json --require-spec --require-tasks --include-tasks+ ps: scripts/powershell/check-prerequisites.ps1 -Json -RequireSpec -RequireTasks -IncludeTasks+ py: scripts/python/check_prerequisites.py --json --require-spec --require-tasks --include-tasks---## User Inputdiff --git a/templates/commands/converge.md b/templates/commands/converge.mdindex eadb96ee5..a177c3137 100644--- a/templates/commands/converge.md+++ b/templates/commands/converge.md@@ -1,9 +1,9 @@---description: Assess the current codebase against the feature's spec, plan, and tasks, then append any remaining unbuilt work as new tasks to tasks.md so implement can complete it.scripts:- sh: scripts/bash/check-prerequisites.sh --json --require-tasks --include-tasks- ps: scripts/powershell/check-prerequisites.ps1 -Json -RequireTasks -IncludeTasks- py: scripts/python/check_prerequisites.py --json --require-tasks --include-tasks+ sh: scripts/bash/check-prerequisites.sh --json --require-spec --require-tasks --include-tasks+ ps: scripts/powershell/check-prerequisites.ps1 -Json -RequireSpec -RequireTasks -IncludeTasks+ py: scripts/python/check_prerequisites.py --json --require-spec --require-tasks --include-tasks---## User Inputdiff --git a/tests/test_check_prerequisites_python_parity.py b/tests/test_check_prerequisites_python_parity.pyindex b0e74217c..69372d3f1 100644--- a/tests/test_check_prerequisites_python_parity.py+++ b/tests/test_check_prerequisites_python_parity.py@@ -247,6 +247,78 @@ def test_python_json_output_matches_bash(prereq_repo: Path, args: tuple[str, ...assert _json_stdout(py) == _json_stdout(bash)+@requires_bash+def test_python_require_spec_matches_bash(prereq_repo: Path) -> None:+ feat = prereq_repo / "specs" / "001-my-feature"+ feat.mkdir(parents=True)+ (feat / "plan.md").write_text("# plan\n", encoding="utf-8")+ (feat / "tasks.md").write_text("# tasks\n", encoding="utf-8")+ _write_feature_json(prereq_repo)++ # spec.md is missing, and without the flag that stays the caller's problem+ bash_without = _run(_bash_cmd(prereq_repo, "--json", "--require-tasks"), prereq_repo)+ py_without = _run(_py_cmd(prereq_repo, "--json", "--require-tasks"), prereq_repo)+ assert py_without.returncode == bash_without.returncode == 0++ # with the flag both variants fail the same way and name the same command+ bash_missing = _run(+ _bash_cmd(prereq_repo, "--json", "--require-spec", "--require-tasks"), prereq_repo+ )+ py_missing = _run(+ _py_cmd(prereq_repo, "--json", "--require-spec", "--require-tasks"), prereq_repo+ )+ assert py_missing.returncode == bash_missing.returncode == 1+ assert py_missing.stderr == bash_missing.stderr+ assert "spec.md not found" in bash_missing.stderr++ # and once the spec exists the flag is satisfied+ (feat / "spec.md").write_text("# spec\n", encoding="utf-8")+ bash_present = _run(+ _bash_cmd(prereq_repo, "--json", "--require-spec", "--require-tasks"), prereq_repo+ )+ py_present = _run(+ _py_cmd(prereq_repo, "--json", "--require-spec", "--require-tasks"), prereq_repo+ )+ assert py_present.returncode == bash_present.returncode == 0+ assert _json_stdout(py_present) == _json_stdout(bash_present)++[email protected](not (HAS_PWSH or _WINDOWS_POWERSHELL), reason="no PowerShell available")+def test_powershell_require_spec_matches_python(prereq_repo: Path) -> None:+ feat = prereq_repo / "specs" / "001-my-feature"+ feat.mkdir(parents=True)+ (feat / "plan.md").write_text("# plan\n", encoding="utf-8")+ (feat / "tasks.md").write_text("# tasks\n", encoding="utf-8")+ _write_feature_json(prereq_repo)++ # spec.md is missing, and without the flag that stays the caller's problem+ ps_without = _run(_ps_cmd(prereq_repo, "-Json", "-RequireTasks"), prereq_repo)+ py_without = _run(_py_cmd(prereq_repo, "--json", "--require-tasks"), prereq_repo)+ assert ps_without.returncode == py_without.returncode == 0++ # with the flag both variants fail the same way and name the same file+ ps_missing = _run(+ _ps_cmd(prereq_repo, "-Json", "-RequireSpec", "-RequireTasks"), prereq_repo+ )+ py_missing = _run(+ _py_cmd(prereq_repo, "--json", "--require-spec", "--require-tasks"), prereq_repo+ )+ assert ps_missing.returncode == py_missing.returncode == 1+ assert "spec.md not found" in ps_missing.stderr+ assert "spec.md not found" in py_missing.stderr++ # and once the spec exists the flag is satisfied and the payloads agree+ (feat / "spec.md").write_text("# spec\n", encoding="utf-8")+ ps_present = _run(+ _ps_cmd(prereq_repo, "-Json", "-RequireSpec", "-RequireTasks"), prereq_repo+ )+ py_present = _run(+ _py_cmd(prereq_repo, "--json", "--require-spec", "--require-tasks"), prereq_repo+ )+ assert ps_present.returncode == py_present.returncode == 0+ assert _json_stdout(ps_present) == _json_stdout(py_present)++@requires_bashdef test_python_text_output_matches_bash(prereq_repo: Path) -> None:feat = prereq_repo / "specs" / "001-my-feature"