π« Toolkit to help you get started with SDD or any other process!
feat: add bundled lean preset with minimal workflow commands (#2161)
Manfred Riem43cb0fa7ab76
diff --git a/presets/catalog.json b/presets/catalog.jsonindex ca40f8528..5650092ba 100644--- a/presets/catalog.json+++ b/presets/catalog.json@@ -1,6 +1,22 @@{"schema_version": "1.0",- "updated_at": "2026-03-10T00:00:00Z",+ "updated_at": "2026-04-10T00:00:00Z","catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/presets/catalog.json",- "presets": {}+ "presets": {+ "lean": {+ "name": "Lean Workflow",+ "id": "lean",+ "version": "1.0.0",+ "description": "Minimal core workflow commands - just the prompt, just the artifact",+ "author": "github",+ "repository": "https://github.com/github/spec-kit",+ "bundled": true,+ "tags": [+ "lean",+ "minimal",+ "workflow",+ "core"+ ]+ }+ }}diff --git a/presets/lean/commands/speckit.constitution.md b/presets/lean/commands/speckit.constitution.mdnew file mode 100644index 000000000..920337003--- /dev/null+++ b/presets/lean/commands/speckit.constitution.md@@ -0,0 +1,15 @@+---+description: Create or update the project constitution.+---++## User Input++```text+$ARGUMENTS+```++## Outline++1. Create or update the project constitution and store it in `.specify/memory/constitution.md`.+ - Project name, guiding principles, non-negotiable rules+ - Derive from user input and existing repo context (README, docs)diff --git a/presets/lean/commands/speckit.implement.md b/presets/lean/commands/speckit.implement.mdnew file mode 100644index 000000000..fc68a1f8b--- /dev/null+++ b/presets/lean/commands/speckit.implement.md@@ -0,0 +1,22 @@+---+description: Execute the implementation plan by processing all tasks in tasks.md.+---++## User Input++```text+$ARGUMENTS+```++## Outline++1. Read `.specify/feature.json` to get the feature directory path.++2. **Load context**: `.specify/memory/constitution.md` and `<feature_directory>/spec.md` and `<feature_directory>/plan.md` and `<feature_directory>/tasks.md`.++3. **Execute tasks** in order:+ - Complete each task before moving to the next+ - Mark completed tasks by changing `- [ ]` to `- [x]` in `<feature_directory>/tasks.md`+ - Halt on failure and report the issue++4. **Validate**: Verify all tasks are completed and the implementation matches the spec.diff --git a/presets/lean/commands/speckit.plan.md b/presets/lean/commands/speckit.plan.mdnew file mode 100644index 000000000..9fbbe4c37--- /dev/null+++ b/presets/lean/commands/speckit.plan.md@@ -0,0 +1,19 @@+---+description: Create a plan and store it in plan.md.+---++## User Input++```text+$ARGUMENTS+```++## Outline++1. Read `.specify/feature.json` to get the feature directory path.++2. **Load context**: `.specify/memory/constitution.md` and `<feature_directory>/spec.md`.++3. Create an implementation plan and store it in `<feature_directory>/plan.md`.+ - Technical context: tech stack, dependencies, project structure+ - Design decisions, architecture, file structurediff --git a/presets/lean/commands/speckit.specify.md b/presets/lean/commands/speckit.specify.mdnew file mode 100644index 000000000..c15353557--- /dev/null+++ b/presets/lean/commands/speckit.specify.md@@ -0,0 +1,23 @@+---+description: Create a specification and store it in spec.md.+---++## User Input++```text+$ARGUMENTS+```++## Outline++1. **Ask the user** for the feature directory path (e.g., `specs/my-feature`). Do not proceed until provided.++2. Create the directory and write `.specify/feature.json`:+ ```json+ { "feature_directory": "<feature_directory>" }+ ```++3. Create a specification from the user input and store it in `<feature_directory>/spec.md`.+ - Overview, functional requirements, user scenarios, success criteria+ - Every requirement must be testable+ - Make informed defaults for unspecified detailsdiff --git a/presets/lean/commands/speckit.tasks.md b/presets/lean/commands/speckit.tasks.mdnew file mode 100644index 000000000..724a7b840--- /dev/null+++ b/presets/lean/commands/speckit.tasks.md@@ -0,0 +1,19 @@+---+description: Create the tasks needed for implementation and store them in tasks.md.+---++## User Input++```text+$ARGUMENTS+```++## Outline++1. Read `.specify/feature.json` to get the feature directory path.++2. **Load context**: `.specify/memory/constitution.md` and `<feature_directory>/spec.md` and `<feature_directory>/plan.md`.++3. Create dependency-ordered implementation tasks and store them in `<feature_directory>/tasks.md`.+ - Every task uses checklist format: `- [ ] [TaskID] Description with file path`+ - Organized by phase: setup, foundational, user stories in priority order, polishdiff --git a/presets/lean/preset.yml b/presets/lean/preset.ymlnew file mode 100644index 000000000..eae84928c--- /dev/null+++ b/presets/lean/preset.yml@@ -0,0 +1,50 @@+schema_version: "1.0"++preset:+ id: "lean"+ name: "Lean Workflow"+ version: "1.0.0"+ description: "Minimal core workflow commands - just the prompt, just the artifact"+ author: "github"+ repository: "https://github.com/github/spec-kit"+ license: "MIT"++requires:+ speckit_version: ">=0.6.0"++provides:+ templates:+ - type: "command"+ name: "speckit.specify"+ file: "commands/speckit.specify.md"+ description: "Lean specify - create spec.md from a feature description"+ replaces: "speckit.specify"++ - type: "command"+ name: "speckit.plan"+ file: "commands/speckit.plan.md"+ description: "Lean plan - create plan.md from the spec"+ replaces: "speckit.plan"++ - type: "command"+ name: "speckit.tasks"+ file: "commands/speckit.tasks.md"+ description: "Lean tasks - create tasks.md from plan and spec"+ replaces: "speckit.tasks"++ - type: "command"+ name: "speckit.implement"+ file: "commands/speckit.implement.md"+ description: "Lean implement - execute tasks from tasks.md"+ replaces: "speckit.implement"++ - type: "command"+ name: "speckit.constitution"+ file: "commands/speckit.constitution.md"+ description: "Lean constitution - create or update project constitution"+ replaces: "speckit.constitution"++tags:+ - "lean"+ - "minimal"+ - "workflow"diff --git a/pyproject.toml b/pyproject.tomlindex e43f81272..5c4e464c9 100644--- a/pyproject.toml+++ b/pyproject.toml@@ -41,6 +41,8 @@ packages = ["src/specify_cli"]"scripts/powershell" = "specify_cli/core_pack/scripts/powershell"# Bundled extensions (installable via `specify extension add <name>`)"extensions/git" = "specify_cli/core_pack/extensions/git"+# Bundled presets (installable via `specify preset add <name>` or `specify init --preset <name>`)+"presets/lean" = "specify_cli/core_pack/presets/lean"[project.optional-dependencies]test = [diff --git a/src/specify_cli/__init__.py b/src/specify_cli/__init__.pyindex e37c4b45f..0bbf42ad5 100644--- a/src/specify_cli/__init__.py+++ b/src/specify_cli/__init__.py@@ -621,6 +621,31 @@ def _locate_bundled_extension(extension_id: str) -> Path | None:return None+def _locate_bundled_preset(preset_id: str) -> Path | None:+ """Return the path to a bundled preset, or None.++ Checks the wheel's core_pack first, then falls back to the+ source-checkout ``presets/<id>/`` directory.+ """+ import re as _re+ if not _re.match(r'^[a-z0-9-]+$', preset_id):+ return None++ core = _locate_core_pack()+ if core is not None:+ candidate = core / "presets" / preset_id+ if (candidate / "preset.yml").is_file():+ return candidate++ # Source-checkout / editable install: look relative to repo root+ repo_root = Path(__file__).parent.parent.parent+ candidate = repo_root / "presets" / preset_id+ if (candidate / "preset.yml").is_file():+ return candidate++ return None++def _install_shared_infra(project_path: Path,script_type: str,@@ -1266,27 +1291,44 @@ def init(preset_manager = PresetManager(project_path)speckit_ver = get_speckit_version()- # Try local directory first, then catalog+ # Try local directory first, then bundled, then cataloglocal_path = Path(preset).resolve()if local_path.is_dir() and (local_path / "preset.yml").exists():preset_manager.install_from_directory(local_path, speckit_ver)else:- preset_catalog = PresetCatalog(project_path)- pack_info = preset_catalog.get_pack_info(preset)- if not pack_info:- console.print(f"[yellow]Warning:[/yellow] Preset '{preset}' not found in catalog. Skipping.")+ bundled_path = _locate_bundled_preset(preset)+ if bundled_path:+ preset_manager.install_from_directory(bundled_path, speckit_ver)else:- try:- zip_path = preset_catalog.download_pack(preset)- preset_manager.install_from_zip(zip_path, speckit_ver)- # Clean up downloaded ZIP to avoid cache accumulation+ preset_catalog = PresetCatalog(project_path)+ pack_info = preset_catalog.get_pack_info(preset)+ if not pack_info:+ console.print(f"[yellow]Warning:[/yellow] Preset '{preset}' not found in catalog. Skipping.")+ elif pack_info.get("bundled") and not pack_info.get("download_url"):+ from .extensions import REINSTALL_COMMAND+ console.print(+ f"[yellow]Warning:[/yellow] Preset '{preset}' is bundled with spec-kit "+ f"but could not be found in the installed package."+ )+ console.print(+ "This usually means the spec-kit installation is incomplete or corrupted."+ )+ console.print(f"Try reinstalling: {REINSTALL_COMMAND}")+ else:+ zip_path = Nonetry:- zip_path.unlink(missing_ok=True)- except OSError:- # Best-effort cleanup; failure to delete is non-fatal- pass- except PresetError as preset_err:- console.print(f"[yellow]Warning:[/yellow] Failed to install preset '{preset}': {preset_err}")+ zip_path = preset_catalog.download_pack(preset)+ preset_manager.install_from_zip(zip_path, speckit_ver)+ except PresetError as preset_err:+ console.print(f"[yellow]Warning:[/yellow] Failed to install preset '{preset}': {preset_err}")+ finally:+ if zip_path is not None:+ # Clean up downloaded ZIP to avoid cache accumulation+ try:+ zip_path.unlink(missing_ok=True)+ except OSError:+ # Best-effort cleanup; failure to delete is non-fatal+ passexcept Exception as preset_err:console.print(f"[yellow]Warning:[/yellow] Failed to install preset: {preset_err}")@@ -2140,28 +2182,50 @@ def preset_add(console.print(f"[green]β[/green] Preset '{manifest.name}' v{manifest.version} installed (priority {priority})")elif pack_id:- catalog = PresetCatalog(project_root)- pack_info = catalog.get_pack_info(pack_id)+ # Try bundled preset first, then catalog+ bundled_path = _locate_bundled_preset(pack_id)+ if bundled_path:+ console.print(f"Installing bundled preset [cyan]{pack_id}[/cyan]...")+ manifest = manager.install_from_directory(bundled_path, speckit_version, priority)+ console.print(f"[green]β[/green] Preset '{manifest.name}' v{manifest.version} installed (priority {priority})")+ else:+ catalog = PresetCatalog(project_root)+ pack_info = catalog.get_pack_info(pack_id)- if not pack_info:- console.print(f"[red]Error:[/red] Preset '{pack_id}' not found in catalog")- raise typer.Exit(1)+ if not pack_info:+ console.print(f"[red]Error:[/red] Preset '{pack_id}' not found in catalog")+ raise typer.Exit(1)- if not pack_info.get("_install_allowed", True):- catalog_name = pack_info.get("_catalog_name", "unknown")- console.print(f"[red]Error:[/red] Preset '{pack_id}' is from the '{catalog_name}' catalog which is discovery-only (install not allowed).")- console.print("Add the catalog with --install-allowed or install from the preset's repository directly with --from.")- raise typer.Exit(1)+ # Bundled presets should have been caught above; if we reach+ # here the bundled files are missing from the installation.+ if pack_info.get("bundled") and not pack_info.get("download_url"):+ from .extensions import REINSTALL_COMMAND+ console.print(+ f"[red]Error:[/red] Preset '{pack_id}' is bundled with spec-kit "+ f"but could not be found in the installed package."+ )+ console.print(+ "\nThis usually means the spec-kit installation is incomplete or corrupted."+ )+ console.print("Try reinstalling spec-kit:")+ console.print(f" {REINSTALL_COMMAND}")+ raise typer.Exit(1)- console.print(f"Installing preset [cyan]{pack_info.get('name', pack_id)}[/cyan]...")+ if not pack_info.get("_install_allowed", True):+ catalog_name = pack_info.get("_catalog_name", "unknown")+ console.print(f"[red]Error:[/red] Preset '{pack_id}' is from the '{catalog_name}' catalog which is discovery-only (install not allowed).")+ console.print("Add the catalog with --install-allowed or install from the preset's repository directly with --from.")+ raise typer.Exit(1)- try:- zip_path = catalog.download_pack(pack_id)- manifest = manager.install_from_zip(zip_path, speckit_version, priority)- console.print(f"[green]β[/green] Preset '{manifest.name}' v{manifest.version} installed (priority {priority})")- finally:- if 'zip_path' in locals() and zip_path.exists():- zip_path.unlink(missing_ok=True)+ console.print(f"Installing preset [cyan]{pack_info.get('name', pack_id)}[/cyan]...")++ try:+ zip_path = catalog.download_pack(pack_id)+ manifest = manager.install_from_zip(zip_path, speckit_version, priority)+ console.print(f"[green]β[/green] Preset '{manifest.name}' v{manifest.version} installed (priority {priority})")+ finally:+ if 'zip_path' in locals() and zip_path.exists():+ zip_path.unlink(missing_ok=True)else:console.print("[red]Error:[/red] Specify a preset ID, --from URL, or --dev path")raise typer.Exit(1)diff --git a/src/specify_cli/presets.py b/src/specify_cli/presets.pyindex 137d1d22a..3a0f469a7 100644--- a/src/specify_cli/presets.py+++ b/src/specify_cli/presets.py@@ -1587,6 +1587,16 @@ class PresetCatalog:f"Preset '{pack_id}' not found in catalog")+ # Bundled presets without a download URL must be installed locally+ if pack_info.get("bundled") and not pack_info.get("download_url"):+ from .extensions import REINSTALL_COMMAND+ raise PresetError(+ f"Preset '{pack_id}' is bundled with spec-kit and has no download URL. "+ f"It should be installed from the local package. "+ f"Use 'specify preset add {pack_id}' to install from the bundled package, "+ f"or reinstall spec-kit if the bundled files are missing: {REINSTALL_COMMAND}"+ )+if not pack_info.get("_install_allowed", True):catalog_name = pack_info.get("_catalog_name", "unknown")raise PresetError(diff --git a/tests/test_presets.py b/tests/test_presets.pyindex d22264f80..95af7a900 100644--- a/tests/test_presets.py+++ b/tests/test_presets.py@@ -2865,3 +2865,182 @@ class TestPresetEnableDisable:assert result.exit_code == 1assert "corrupted state" in result.output.lower()+++# ===== Lean Preset Tests =====+++LEAN_PRESET_DIR = Path(__file__).parent.parent / "presets" / "lean"++LEAN_COMMAND_NAMES = [+ "speckit.specify",+ "speckit.plan",+ "speckit.tasks",+ "speckit.implement",+ "speckit.constitution",+]+++class TestLeanPreset:+ """Tests for the lean preset that ships with the repo."""++ def test_lean_preset_exists(self):+ """Verify the lean preset directory and manifest exist."""+ assert LEAN_PRESET_DIR.exists()+ assert (LEAN_PRESET_DIR / "preset.yml").exists()++ def test_lean_manifest_valid(self):+ """Verify the lean preset manifest is valid."""+ manifest = PresetManifest(LEAN_PRESET_DIR / "preset.yml")+ assert manifest.id == "lean"+ assert manifest.name == "Lean Workflow"+ assert manifest.version == "1.0.0"+ assert len(manifest.templates) == 5 # 5 commands++ def test_lean_provides_core_workflow_commands(self):+ """Verify the lean preset provides overrides for core workflow commands."""+ manifest = PresetManifest(LEAN_PRESET_DIR / "preset.yml")+ provided_names = {t["name"] for t in manifest.templates}+ for name in LEAN_COMMAND_NAMES:+ assert name in provided_names, f"Lean preset missing command: {name}"++ def test_lean_command_files_exist(self):+ """Verify that all declared command files actually exist on disk."""+ manifest = PresetManifest(LEAN_PRESET_DIR / "preset.yml")+ for tmpl in manifest.templates:+ tmpl_path = LEAN_PRESET_DIR / tmpl["file"]+ assert tmpl_path.exists(), f"Missing command file: {tmpl['file']}"++ def test_lean_commands_have_no_scripts(self):+ """Verify lean commands have no scripts or agent_scripts in frontmatter."""+ from specify_cli.agents import CommandRegistrar++ for name in LEAN_COMMAND_NAMES:+ cmd_path = LEAN_PRESET_DIR / "commands" / f"speckit.{name.split('.')[-1]}.md"+ content = cmd_path.read_text()+ frontmatter, _ = CommandRegistrar.parse_frontmatter(content)+ assert "scripts" not in frontmatter, f"{name} should not have scripts in frontmatter"+ assert "agent_scripts" not in frontmatter, f"{name} should not have agent_scripts in frontmatter"++ def test_lean_commands_have_no_hooks(self):+ """Verify lean commands do not contain extension hook boilerplate."""+ for name in LEAN_COMMAND_NAMES:+ cmd_path = LEAN_PRESET_DIR / "commands" / f"speckit.{name.split('.')[-1]}.md"+ content = cmd_path.read_text()+ assert "hooks." not in content, f"{name} should not reference extension hooks"+ assert "extensions.yml" not in content, f"{name} should not reference extensions.yml"++ def test_install_lean_preset(self, project_dir):+ """Test installing the lean preset from its directory."""+ manager = PresetManager(project_dir)+ manifest = manager.install_from_directory(LEAN_PRESET_DIR, "0.6.0")+ assert manifest.id == "lean"+ assert manager.registry.is_installed("lean")++ def test_lean_overrides_commands(self, project_dir):+ """Test that lean preset overrides are resolved correctly."""+ manager = PresetManager(project_dir)+ manager.install_from_directory(LEAN_PRESET_DIR, "0.6.0")++ resolver = PresetResolver(project_dir)+ for name in LEAN_COMMAND_NAMES:+ result = resolver.resolve(name, template_type="command")+ assert result is not None, f"Lean override for {name} not resolved"+++# ===== Bundled Preset Locator Tests =====+++class TestBundledPresetLocator:+ """Tests for _locate_bundled_preset discovery function."""++ def test_locate_bundled_lean_preset(self):+ """_locate_bundled_preset finds the lean preset."""+ from specify_cli import _locate_bundled_preset++ path = _locate_bundled_preset("lean")+ assert path is not None+ assert (path / "preset.yml").is_file()++ def test_locate_bundled_preset_not_found(self):+ """_locate_bundled_preset returns None for nonexistent preset."""+ from specify_cli import _locate_bundled_preset++ path = _locate_bundled_preset("nonexistent-preset")+ assert path is None++ def test_locate_bundled_preset_rejects_invalid_id(self):+ """_locate_bundled_preset rejects IDs with invalid characters."""+ from specify_cli import _locate_bundled_preset++ assert _locate_bundled_preset("../escape") is None+ assert _locate_bundled_preset("UPPERCASE") is None+ assert _locate_bundled_preset("has spaces") is None++ def test_bundled_preset_add_via_cli(self, project_dir):+ """Test that 'specify preset add lean' installs the bundled preset."""+ from typer.testing import CliRunner+ from unittest.mock import patch+ from specify_cli import app++ runner = CliRunner()+ with patch.object(Path, "cwd", return_value=project_dir), \+ patch("specify_cli.get_speckit_version", return_value="0.6.0"):+ result = runner.invoke(app, ["preset", "add", "lean"])++ assert result.exit_code == 0, result.output+ assert "Lean Workflow" in result.output+ assert "installed" in result.output.lower()++ def test_bundled_preset_in_catalog(self):+ """Verify the lean preset is listed in catalog.json with bundled marker."""+ catalog_path = Path(__file__).parent.parent / "presets" / "catalog.json"+ catalog = json.loads(catalog_path.read_text())+ assert "lean" in catalog["presets"]+ assert catalog["presets"]["lean"]["bundled"] is True+ assert "download_url" not in catalog["presets"]["lean"]++ def test_bundled_preset_download_raises_error(self, project_dir):+ """download_pack raises PresetError for bundled presets without download_url."""+ catalog = PresetCatalog(project_dir)++ catalog_data = {+ "test-bundled": {+ "name": "Test Bundled",+ "version": "1.0.0",+ "bundled": True,+ }+ }+ from unittest.mock import patch+ with patch.object(catalog, "_get_merged_packs", return_value=catalog_data):+ with pytest.raises(PresetError, match="bundled with spec-kit"):+ catalog.download_pack("test-bundled")++ def test_bundled_preset_missing_locally_cli_error(self, project_dir):+ """CLI shows clear error when bundled preset cannot be found locally."""+ from typer.testing import CliRunner+ from unittest.mock import patch+ from specify_cli import app++ runner = CliRunner()+ # Patch _locate_bundled_preset to return None (simulating missing files)+ # and mock the catalog to return a bundled entry for "lean"+ fake_pack_info = {+ "id": "lean",+ "name": "Lean Workflow",+ "version": "1.0.0",+ "bundled": True,+ "_install_allowed": True,+ }+ with patch.object(Path, "cwd", return_value=project_dir), \+ patch("specify_cli._locate_bundled_preset", return_value=None), \+ patch("specify_cli.presets.PresetCatalog") as MockCatalog:+ MockCatalog.return_value.get_pack_info.return_value = fake_pack_info+ result = runner.invoke(app, ["preset", "add", "lean"])++ # Should fail with a helpful error explaining this is a bundled preset+ # and suggesting how to recover.+ assert result.exit_code == 1+ output = strip_ansi(result.output).lower()+ assert "bundled" in output, result.output+ assert "reinstall" in output, result.output