mirror of
https://github.com/github/spec-kit.git
synced 2026-08-15 14:02:04 +02:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
4871b485f9 | ||
|
|
6aa9431b24 | ||
|
|
1b3695bfb3 | ||
|
|
3451a21277 | ||
|
|
fd8cc6da22 | ||
|
|
2df78f33fb | ||
|
|
36da77f864 | ||
|
|
1a44a6aa08 | ||
|
|
f0ee1fc419 | ||
|
|
44c3dc7d3e | ||
|
|
2100f59f7e | ||
|
|
a2c7ff29db | ||
|
|
ea1f5b8a2d | ||
|
|
29efcbe2c4 | ||
|
|
11e3176fd1 | ||
|
|
16cfab7724 | ||
|
|
1a60d1b6b8 | ||
|
|
d751231468 | ||
|
|
684b3d8e05 | ||
|
|
247abbf5e4 | ||
|
|
6da6956c3e |
@@ -8,7 +8,7 @@ body:
|
||||
value: |
|
||||
Thanks for requesting a new agent! Before submitting, please check if the agent is already supported.
|
||||
|
||||
**Currently supported agents**: Alquimia AI, Amp, Antigravity, Auggie CLI, Claude Code, Cline, CodeBuddy, Codex CLI, Cursor, Devin for Terminal, Factory Droid, Firebender, Forge, Gemini CLI, GitHub Copilot, Goose, Grok Build, Hermes Agent, IBM Bob, Junie, Kilo Code, Kimi Code, Kiro CLI, Lingma, Mistral Vibe, Oh My Pi, opencode, Pi Coding Agent, Qoder CLI, Qwen Code, RovoDev ACLI, SHAI, Tabnine CLI, Trae, ZCode, Zed
|
||||
**Currently supported agents**: Alquimia AI, Amp, Antigravity, Auggie CLI, Claude Code, Cline, CodeBuddy, Codex CLI, Command Code, Cursor, Devin for Terminal, Factory Droid, Firebender, Forge, Gemini CLI, GitHub Copilot, Goose, Grok Build, Hermes Agent, IBM Bob, Junie, Kilo Code, Kimi Code, Kiro CLI, Lingma, Mistral Vibe, Oh My Pi, opencode, Pi Coding Agent, Qoder CLI, Qwen Code, RovoDev ACLI, SHAI, Tabnine CLI, Trae, ZCode, Zed
|
||||
|
||||
- type: input
|
||||
id: agent-name
|
||||
|
||||
@@ -70,6 +70,7 @@ body:
|
||||
- Cline
|
||||
- CodeBuddy
|
||||
- Codex CLI
|
||||
- Command Code
|
||||
- Cursor
|
||||
- Devin for Terminal
|
||||
- Factory Droid
|
||||
|
||||
@@ -64,6 +64,7 @@ body:
|
||||
- Cline
|
||||
- CodeBuddy
|
||||
- Codex CLI
|
||||
- Command Code
|
||||
- Cursor
|
||||
- Devin for Terminal
|
||||
- Factory Droid
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
{
|
||||
"entries": {
|
||||
"actions/checkout@v6.0.3": {
|
||||
"actions/checkout@v7.0.1": {
|
||||
"repo": "actions/checkout",
|
||||
"version": "v6.0.3",
|
||||
"sha": "df4cb1c069e1874edd31b4311f1884172cec0e10"
|
||||
"version": "v7.0.1",
|
||||
"sha": "3d3c42e5aac5ba805825da76410c181273ba90b1"
|
||||
},
|
||||
"actions/download-artifact@v8.0.1": {
|
||||
"repo": "actions/download-artifact",
|
||||
@@ -15,10 +15,20 @@
|
||||
"version": "v9.0.0",
|
||||
"sha": "3a2844b7e9c422d3c10d287c895573f7108da1b3"
|
||||
},
|
||||
"actions/setup-node@v6.4.0": {
|
||||
"actions/setup-node@v7.0.0": {
|
||||
"repo": "actions/setup-node",
|
||||
"version": "v6.4.0",
|
||||
"sha": "48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e"
|
||||
"version": "v7.0.0",
|
||||
"sha": "820762786026740c76f36085b0efc47a31fe5020"
|
||||
},
|
||||
"actions/setup-python@v7.0.0": {
|
||||
"repo": "actions/setup-python",
|
||||
"version": "v7.0.0",
|
||||
"sha": "5fda3b95a4ea91299a34e894583c3862153e4b97"
|
||||
},
|
||||
"astral-sh/setup-uv@v9.0.0": {
|
||||
"repo": "astral-sh/setup-uv",
|
||||
"version": "v9.0.0",
|
||||
"sha": "c771a70e6277c0a99b617c7a806ffedaca235ff9"
|
||||
},
|
||||
"actions/upload-artifact@v7.0.1": {
|
||||
"repo": "actions/upload-artifact",
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"c64e3dc29aca89e48108bb6d4eb877f6264b4cec9cd56dcd36827893802d2a64","body_hash":"cade22e5083254b735200f4ff7d686104e4ccab848ff7355141b9689354834db","compiler_version":"v0.79.8","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"df4cb1c069e1874edd31b4311f1884172cec0e10","version":"v6.0.3"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"3d3c42e5aac5ba805825da76410c181273ba90b1","version":"v7.0.1"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# This file was automatically generated by gh-aw (v0.79.8). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md
|
||||
#
|
||||
# ___ _ _
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"687ea37b376b3b918331c13fce6cdbf5b9898bab8e514ca57b662b92b6d3cd2c","body_hash":"83b7e917f475d6ddf32f17e7da09dd4097a01dddbcbbf8eeec673912285de8b2","compiler_version":"v0.79.8","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"df4cb1c069e1874edd31b4311f1884172cec0e10","version":"v6.0.3"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"3d3c42e5aac5ba805825da76410c181273ba90b1","version":"v7.0.1"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# This file was automatically generated by gh-aw (v0.79.8). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md
|
||||
#
|
||||
# ___ _ _
|
||||
|
||||
+1
-1
@@ -1,5 +1,5 @@
|
||||
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"b4ba1db5fdec754fa825cc3160879924118bc454a781eed70ef6c90beab83a95","body_hash":"cb6c19088fa13da0a8320c174e8c14c4887d2c8a005a5cb2d2d2faa3f890de39","compiler_version":"v0.79.8","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"df4cb1c069e1874edd31b4311f1884172cec0e10","version":"v6.0.3"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"3d3c42e5aac5ba805825da76410c181273ba90b1","version":"v7.0.1"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# This file was automatically generated by gh-aw (v0.79.8). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md
|
||||
#
|
||||
# ___ _ _
|
||||
|
||||
Generated
+1
-1
@@ -1,5 +1,5 @@
|
||||
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"00c226f69fb7ec2b63755304328cee6ecddbcedbe4a9840310e5f430bd3949f0","body_hash":"44428ecd81ba0e5ed7bb16436052e6cc3479fe4ad02414812e574d17830a464e","compiler_version":"v0.79.8","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"df4cb1c069e1874edd31b4311f1884172cec0e10","version":"v6.0.3"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"3d3c42e5aac5ba805825da76410c181273ba90b1","version":"v7.0.1"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# This file was automatically generated by gh-aw (v0.79.8). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md
|
||||
#
|
||||
# ___ _ _
|
||||
|
||||
Generated
+1
-1
@@ -1,5 +1,5 @@
|
||||
# gh-aw-metadata: {"schema_version":"v4","frontmatter_hash":"aafdb01f262d603577971994522575829802b93d9042d62446313955485df558","body_hash":"4596de2b7de95c7c73c05caedc5c1e97724b39d09d21e9b0dbfc8b570312798a","compiler_version":"v0.79.8","strict":true,"agent_id":"copilot","engine_versions":{"copilot":"1.0.60"}}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"df4cb1c069e1874edd31b4311f1884172cec0e10","version":"v6.0.3"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e","version":"v6.4.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# gh-aw-manifest: {"version":1,"secrets":["COPILOT_GITHUB_TOKEN","GH_AW_CI_TRIGGER_TOKEN","GH_AW_GITHUB_MCP_SERVER_TOKEN","GH_AW_GITHUB_TOKEN","GITHUB_TOKEN"],"actions":[{"repo":"actions/checkout","sha":"3d3c42e5aac5ba805825da76410c181273ba90b1","version":"v7.0.1"},{"repo":"actions/download-artifact","sha":"3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c","version":"v8.0.1"},{"repo":"actions/github-script","sha":"3a2844b7e9c422d3c10d287c895573f7108da1b3","version":"v9.0.0"},{"repo":"actions/setup-node","sha":"820762786026740c76f36085b0efc47a31fe5020","version":"v7.0.0"},{"repo":"actions/upload-artifact","sha":"043fb46d1a93c77aae656e7c1c64a875d1fc6a0a","version":"v7.0.1"},{"repo":"github/gh-aw-actions/setup","sha":"c0338fef4749d08c21f8f975fb0e37efa17dda47","version":"v0.79.8"}],"containers":[{"image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2","digest":"sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6","pinned_image":"ghcr.io/github/gh-aw-firewall/agent:0.27.2@sha256:f88e5b17b6b7a600117bc121114d6ce2155c88c983c0c939c5df884f730fa1d6"},{"image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2","digest":"sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4","pinned_image":"ghcr.io/github/gh-aw-firewall/api-proxy:0.27.2@sha256:ee39841d980878ebbb87592903b06d31a1af500c71525c9616f7e8e2a27041a4"},{"image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2","digest":"sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591","pinned_image":"ghcr.io/github/gh-aw-firewall/squid:0.27.2@sha256:2e3a717e5f19a654cd9a2263beb52012b56bcb68562ec5ae2e42f9d156b49591"},{"image":"ghcr.io/github/gh-aw-mcpg:v0.3.25","digest":"sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa","pinned_image":"ghcr.io/github/gh-aw-mcpg:v0.3.25@sha256:c10331ad17668ef89f38f5e356678788a40b0cd5fef96e8f92e1d9c1de47cbaa"},{"image":"ghcr.io/github/github-mcp-server:v1.1.2","digest":"sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c","pinned_image":"ghcr.io/github/github-mcp-server:v1.1.2@sha256:30197479d8036c7811892bc07e06f9a05c9ef3cdd79bc59f256d50647f95788c"}]}
|
||||
# This file was automatically generated by gh-aw (v0.79.8). DO NOT EDIT. To debug this workflow, load the skill at https://github.com/github/gh-aw/blob/main/debug.md
|
||||
#
|
||||
# ___ _ _
|
||||
|
||||
Generated
+18
-7
File diff suppressed because one or more lines are too long
@@ -60,6 +60,22 @@ permissions:
|
||||
checkout:
|
||||
fetch-depth: 0
|
||||
|
||||
network:
|
||||
allowed:
|
||||
- defaults
|
||||
- pypi.org
|
||||
- files.pythonhosted.org
|
||||
|
||||
steps:
|
||||
- name: Setup uv
|
||||
uses: astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
|
||||
with:
|
||||
python-version: "3.14"
|
||||
- name: Install Python test dependencies
|
||||
run: uv pip install --system -e ".[test]"
|
||||
|
||||
safe-outputs:
|
||||
noop:
|
||||
report-as-issue: false
|
||||
|
||||
@@ -2,6 +2,31 @@
|
||||
|
||||
<!-- insert new changelog below this comment -->
|
||||
|
||||
## [0.16.2] - 2026-08-10
|
||||
|
||||
### Changed
|
||||
|
||||
- Add Command Code integration to spec-kit (#4019)
|
||||
- fix(workflows): strip a resolved condition before the true/false check (#3883)
|
||||
- fix(workflows): guard a non-string overlay edit 'operation' (#3881)
|
||||
- fix: bound response read in integration catalog fetch (#3818)
|
||||
- Fix bug-test Python dependency provisioning (#4030)
|
||||
- fix(bundle): escape Rich markup in bundle CLI error and status output (#4023)
|
||||
- fix(presets): skip an unreadable restore source in `preset remove` (#4020)
|
||||
- Add Keel Discovery extension to community catalog (#4035)
|
||||
- fix: show error details in preset catalog config read failure (#3840)
|
||||
- Update Reconcile Extension to v1.1.0 (#4034)
|
||||
- Add Model Routing Governance preset to community catalog (#4033)
|
||||
- fix: use missing_ok=True in integration JSON removal (#3846)
|
||||
- fix: use missing_ok=True in extension cache clear (#3845)
|
||||
- fix(extensions): reject duplicate provides.templates/scripts names (#4016)
|
||||
- feat(presets): resolve constitution templates at command time (#3984)
|
||||
- [bug-fix] Fix preset-wrap-drops-argument-hint: inherit argument-hint from core template (#3996)
|
||||
- docs: document installing specify-cli from a custom package index (#4032)
|
||||
- feat(extensions): accept provides.templates and provides.scripts in manifest (#4012)
|
||||
- fix(presets): treat an unreadable core template as missing (#3961)
|
||||
- chore: release 0.16.1, begin 0.16.2.dev0 development (#4014)
|
||||
|
||||
## [0.16.1] - 2026-08-07
|
||||
|
||||
### Changed
|
||||
|
||||
@@ -90,7 +90,7 @@ Bare `specify self upgrade` executes immediately, matching the no-prompt behavio
|
||||
|
||||
### 3. Establish project principles
|
||||
|
||||
Launch your coding agent in the project directory. Most agents expose spec-kit as `/speckit.*` slash commands; Codex CLI in skills mode uses `$speckit-*` instead; GitHub Copilot CLI uses `/agents` to select the agent or address it directly in a prompt.
|
||||
Launch your coding agent in the project directory. Most agents expose spec-kit as `/speckit.*` slash commands; Codex CLI and Command Code in skills mode use `$speckit-*` instead; GitHub Copilot CLI uses `/agents` to select the agent or address it directly in a prompt.
|
||||
|
||||
Use the **`/speckit.constitution`** command to create your project's governing principles and development guidelines that will guide all subsequent development.
|
||||
|
||||
|
||||
@@ -72,6 +72,7 @@ The following community-contributed extensions are available in [`catalog.commun
|
||||
| Iterate | Iterate on spec documents with a two-phase define-and-apply workflow — refine specs mid-implementation and go straight back to building | `docs` | Read+Write | [spec-kit-iterate](https://github.com/imviancagrace/spec-kit-iterate) |
|
||||
| Jira Integration | Create Jira Epics, Stories, and Issues from spec-kit specifications and task breakdowns with configurable hierarchy and custom field support | `integration` | Read+Write | [spec-kit-jira](https://github.com/mbachorik/spec-kit-jira) |
|
||||
| Jira Integration (Sync Engine) | Idempotent, drift-aware, fail-closed reconcile engine mirroring spec-kit specs into Jira (Epic per repo, Story per spec, Subtask per phase) | `integration` | Read+Write | [spec-kit-jira-sync](https://github.com/ashbrener/spec-kit-jira-sync) |
|
||||
| Keel Discovery | A Spec Kit extension that puts customer evidence upstream of /speckit.specify, and audits what you shipped against it afterwards | `process` | Read+Write | [spec-kit-keel](https://github.com/keeldiscovery/spec-kit-keel) |
|
||||
| Learning Extension | Generate educational guides from implementations and enhance clarifications with mentoring context | `docs` | Read+Write | [spec-kit-learn](https://github.com/imviancagrace/spec-kit-learn) |
|
||||
| Linear Integration | Mirror spec-kit feature directories into Linear (filesystem → Linear, reconcile-based, unidirectional). | `integration` | Read+Write | [spec-kit-linear-sync](https://github.com/ashbrener/spec-kit-linear-sync) |
|
||||
| Linear Weave | Weave Spec Kit into Linear: pull requirements, mirror tasks.md into sub-issues, sync statuses | `integration` | Read+Write | [spec-kit-linear-weave](https://github.com/tonydwoodhouse/spec-kit-linear-weave) |
|
||||
|
||||
@@ -25,6 +25,7 @@ The following community-contributed presets customize how Spec Kit behaves — o
|
||||
| iSAQB Architecture Governance | Adds iSAQB/CPSA-F and arc42 architecture governance with audit-ready evidence for goals, views, resumability, partial-failure scenarios, ADRs, risks, and technical debt. | 13 templates, 3 commands | — | [spec-kit-preset-isaqb-architecture-governance](https://github.com/hindermath/spec-kit-preset-isaqb-architecture-governance) |
|
||||
| Jira Issue Tracking | Overrides `speckit.taskstoissues` to create Jira epics, stories, and tasks instead of GitHub Issues via Atlassian MCP tools | 1 command | — | [spec-kit-preset-jira](https://github.com/luno/spec-kit-preset-jira) |
|
||||
| Model Driven Engineering | Focuses on streamlined commands, app repository support, cross-spec support, and capability-aware project memory for model-driven engineering workflows | 6 templates, 11 commands | MDE extension | [spec-kit-preset-mde](https://github.com/AI-MDE/spec-kit-preset-mde) |
|
||||
| Model Routing Governance | Maps provider-neutral Spec Kit roles to validated harness-local runner profiles without storing model availability, credentials, or machine-specific selections in Git. | 4 templates, 2 commands, 2 scripts | — | [spec-kit-preset-model-routing-governance](https://github.com/hindermath/spec-kit-preset-model-routing-governance) |
|
||||
| Multi-Repo Branching | Coordinates feature branch creation across multiple git repositories (independent repos and submodules) during plan and tasks phases | 2 commands | — | [spec-kit-preset-multi-repo-branching](https://github.com/sakitA/spec-kit-preset-multi-repo-branching) |
|
||||
| Parallel Autonomous Run Governance | Coordinates permission-bounded autonomous campaigns while preserving the project's learner and accessibility contract across workers and consolidation. | 9 templates, 5 commands, 2 scripts | autonomous-run-governance >=0.2.2; optional: intake-review-governance >=0.1.0 | [spec-kit-preset-parallel-autonomous-run-governance](https://github.com/hindermath/spec-kit-preset-parallel-autonomous-run-governance) |
|
||||
| Pirate Speak (Full) | Transforms all Spec Kit output into pirate speak — specs become "Voyage Manifests", plans become "Battle Plans", tasks become "Crew Assignments" | 6 templates, 9 commands | — | [spec-kit-presets](https://github.com/mnriem/spec-kit-presets) |
|
||||
|
||||
@@ -35,6 +35,27 @@ pipx install specify-cli==0.12.11
|
||||
pip install specify-cli==0.12.11
|
||||
```
|
||||
|
||||
## Install from a custom or private package index
|
||||
|
||||
Some environments (corporate networks, mirrors, proxies, or artifact feeds) require installing `specify-cli` from a package index other than the default public PyPI. Each Python tool exposes a way to point at a different index — configure it before running the install commands above. Substitute your own index URL for the placeholder shown here.
|
||||
|
||||
```bash
|
||||
# uv — via environment variable (applies to the whole command)
|
||||
UV_DEFAULT_INDEX=https://your-index.example.com/pypi/simple/ uv tool install specify-cli
|
||||
|
||||
# uv — via flag
|
||||
uv tool install --default-index https://your-index.example.com/pypi/simple/ specify-cli
|
||||
|
||||
# pipx — pass a pip argument through
|
||||
pipx install specify-cli --index-url https://your-index.example.com/pypi/simple/
|
||||
|
||||
# pip
|
||||
pip install specify-cli --index-url https://your-index.example.com/pypi/simple/
|
||||
```
|
||||
|
||||
> [!NOTE]
|
||||
> The same index configuration applies to pinned installs, upgrades (`--force`/`--upgrade`), and one-time usage — set the environment variable or flag on those commands too. If your index requires authentication, follow your tool's documentation and prefer credential environment variables, keyring, or netrc; do not embed secrets in command-line URLs because they can leak through shell history, process listings, or logs. Avoid committing secrets. For fully offline installs, see the [air-gapped installation guide](air-gapped.md).
|
||||
|
||||
## Verify
|
||||
|
||||
```bash
|
||||
|
||||
@@ -50,7 +50,7 @@ pipx install specify-cli
|
||||
pip install specify-cli
|
||||
```
|
||||
|
||||
To install a specific release, pin the version — for example `uv tool install specify-cli==0.12.11`. See the [PyPI installation guide](install/pypi.md) for details, including how to upgrade.
|
||||
To install a specific release, pin the version — for example `uv tool install specify-cli==0.12.11`. See the [PyPI installation guide](install/pypi.md) for details, including how to upgrade and how to [install from a custom or private package index](install/pypi.md#install-from-a-custom-or-private-package-index).
|
||||
|
||||
### One-time Usage
|
||||
|
||||
|
||||
@@ -14,6 +14,7 @@ The Specify CLI supports a wide range of AI coding agents. When you run `specify
|
||||
| [Cline](https://github.com/cline/cline) | `cline` | IDE-based agent |
|
||||
| [CodeBuddy CLI](https://www.codebuddy.cn/docs/cli/installation) | `codebuddy` | |
|
||||
| [Codex CLI](https://github.com/openai/codex) | `codex` | Skills-based integration; installs skills into `.agents/skills` and invokes them as `$speckit-<command>` |
|
||||
| [Command Code](https://commandcode.ai/docs) | `command-code` | Skills-based integration; installs skills into `.commandcode/skills/` and invokes them as `$speckit-<command>` |
|
||||
| [Cursor](https://cursor.sh/) | `cursor-agent` | |
|
||||
| [Devin for Terminal](https://cli.devin.ai/docs) | `devin` | Skills-based integration; installs skills into `.devin/skills/` and invokes them as `/speckit-<command>` |
|
||||
| [Factory Droid](https://docs.factory.ai/cli/getting-started/overview) | `droid` | Skills-based integration; installs skills into `.factory/skills/` and invokes them as `/speckit-<command>` |
|
||||
@@ -279,6 +280,7 @@ The currently declared multi-install safe integrations are:
|
||||
| `cline` | `.clinerules/workflows` |
|
||||
| `codebuddy` | `.codebuddy/commands` |
|
||||
| `codex` | `.agents/skills` |
|
||||
| `command-code` | `.commandcode/skills` |
|
||||
| `cursor-agent` | `.cursor/skills` |
|
||||
| `droid` | `.factory/skills` |
|
||||
| `firebender` | `.firebender/commands` |
|
||||
|
||||
@@ -40,12 +40,25 @@ requires:
|
||||
required: boolean # Optional, default: false
|
||||
|
||||
provides:
|
||||
commands: # Required, at least one command
|
||||
commands: # At least one of commands/templates/scripts/hooks/events required
|
||||
- name: string # Required, pattern: ^speckit\.[a-z0-9-]+\.[a-z0-9-]+$
|
||||
file: string # Required, relative path to command file
|
||||
description: string # Required
|
||||
aliases: [string] # Optional, same pattern as name; namespace must match extension.id and must not shadow core or installed extension commands
|
||||
|
||||
templates: # Optional, array of declared templates. Always resolve
|
||||
# as "replace" -- 'strategy' is not an authorable field here.
|
||||
- name: string # Required, pattern: ^[a-z0-9-]+$
|
||||
file: string # Required, relative path to template file
|
||||
description: string # Optional
|
||||
|
||||
scripts: # Optional, array of declared scripts. Always resolve
|
||||
# as "replace" -- 'strategy' is not an authorable field here.
|
||||
- name: string # Required, pattern: ^[a-z0-9-]+$
|
||||
file: string # Required, relative path to script file
|
||||
description: string # Optional
|
||||
runtimes: [string] # Optional, subset of: bash, powershell, python
|
||||
|
||||
config: # Optional, array of config files
|
||||
- name: string # Config file name
|
||||
template: string # Template file path
|
||||
@@ -111,6 +124,29 @@ defaults: # Optional, default configuration values
|
||||
- **Examples**: `speckit.jira.specstoissues`, `speckit.linear.sync`
|
||||
- **Invalid**: `jira.specstoissues`, `speckit.command`, `speckit.jira.CreateIssues`
|
||||
|
||||
#### `provides.templates[].name` / `provides.scripts[].name`
|
||||
|
||||
- **Type**: string
|
||||
- **Pattern**: `^[a-z0-9-]+$`
|
||||
- **Description**: Unlike commands, templates and scripts are not invoked by
|
||||
name, so they use the same plain slug pattern as `extension.id` rather than
|
||||
the namespaced command pattern.
|
||||
- **Examples**: `myext-template`, `myext-collect`
|
||||
|
||||
#### `provides.templates[].strategy` / `provides.scripts[].strategy`
|
||||
|
||||
- Not an authorable field. Extension-contributed templates and scripts are
|
||||
always resolved as `replace`; a manifest that includes a `strategy` key on
|
||||
one of these entries is rejected with a `ValidationError`. Composable
|
||||
strategies (`wrap`/`prepend`/`append`) are preset-only.
|
||||
|
||||
#### `provides.scripts[].runtimes`
|
||||
|
||||
- **Type**: array of strings
|
||||
- **Values**: `bash`, `powershell`, `python`
|
||||
- **Description**: Declares which runtimes the script supports. Purely
|
||||
informational metadata — it is not used to select or invoke the script.
|
||||
|
||||
#### `hooks`
|
||||
|
||||
- **Type**: object
|
||||
@@ -143,6 +179,8 @@ manifest.version # str: Version
|
||||
manifest.description # str: Description
|
||||
manifest.requires_speckit_version # str: Required spec-kit version
|
||||
manifest.commands # List[Dict]: Command definitions
|
||||
manifest.templates # List[Dict]: Declared template definitions
|
||||
manifest.scripts # List[Dict]: Declared script definitions
|
||||
manifest.hooks # Dict: Hook definitions
|
||||
```
|
||||
|
||||
|
||||
@@ -177,9 +177,16 @@ Compatibility requirements.
|
||||
|
||||
What the extension provides.
|
||||
|
||||
**Optional sub-fields**:
|
||||
**Optional sub-fields:**
|
||||
|
||||
- `commands`: Array of command objects (at least one command or hook is required)
|
||||
- `commands`: Array of command objects
|
||||
- `templates`: Array of template objects
|
||||
- `scripts`: Array of script objects
|
||||
|
||||
`hooks` and `events` are separate top-level manifest fields (siblings of
|
||||
`provides`, not nested under it — see [`hooks`](#hooks) below). At least one
|
||||
of `provides.commands`, `provides.templates`, `provides.scripts`, `hooks`, or
|
||||
`events` is required.
|
||||
|
||||
**Command object**:
|
||||
|
||||
@@ -188,6 +195,21 @@ What the extension provides.
|
||||
- `description`: Command description (optional)
|
||||
- `aliases`: Alternative command names (optional, array; each must match `speckit.{ext-id}.{command}`)
|
||||
|
||||
**Template object**:
|
||||
|
||||
- `name`: Template name (lowercase, alphanumeric, hyphens — e.g. `myext-template`)
|
||||
- `file`: Path to template file (relative to extension root)
|
||||
- `description`: Template description (optional)
|
||||
|
||||
**Script object**:
|
||||
|
||||
- `name`: Script name (lowercase, alphanumeric, hyphens — e.g. `myext-collect`)
|
||||
- `file`: Path to script file (relative to extension root)
|
||||
- `description`: Script description (optional)
|
||||
- `runtimes`: Runtimes the script supports (optional, array; subset of `bash`, `powershell`, `python` — informational only, not used to select or invoke the script)
|
||||
|
||||
Extension-provided templates and scripts always resolve as `replace`; a manifest that includes a `strategy` key on one of these entries is rejected with a `ValidationError`. Composable strategies (`wrap`/`prepend`/`append`) are preset-only.
|
||||
|
||||
### Optional Fields
|
||||
|
||||
#### `hooks`
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"updated_at": "2026-08-04T00:00:00Z",
|
||||
"updated_at": "2026-08-10T00:00:00Z",
|
||||
"catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/extensions/catalog.community.json",
|
||||
"extensions": {
|
||||
"adrkit": {
|
||||
@@ -2107,6 +2107,40 @@
|
||||
"created_at": "2026-06-08T00:00:00Z",
|
||||
"updated_at": "2026-06-24T00:00:00Z"
|
||||
},
|
||||
"keel": {
|
||||
"name": "Keel Discovery",
|
||||
"id": "keel",
|
||||
"description": "A Spec Kit extension that puts customer evidence upstream of /speckit.specify, and audits what you shipped against it afterwards.",
|
||||
"author": "Keel Discovery",
|
||||
"version": "0.1.1",
|
||||
"download_url": "https://github.com/keeldiscovery/spec-kit-keel/archive/refs/tags/v0.1.1.zip",
|
||||
"repository": "https://github.com/keeldiscovery/spec-kit-keel",
|
||||
"homepage": "https://keeldiscovery.com",
|
||||
"documentation": "https://github.com/keeldiscovery/spec-kit-keel/blob/main/README.md",
|
||||
"changelog": "https://github.com/keeldiscovery/spec-kit-keel/blob/main/CHANGELOG.md",
|
||||
"license": "Apache-2.0",
|
||||
"category": "process",
|
||||
"effect": "read-write",
|
||||
"requires": {
|
||||
"speckit_version": ">=0.15.0"
|
||||
},
|
||||
"provides": {
|
||||
"commands": 5,
|
||||
"hooks": 2
|
||||
},
|
||||
"tags": [
|
||||
"discovery",
|
||||
"evidence",
|
||||
"customer-research",
|
||||
"validation",
|
||||
"traceability"
|
||||
],
|
||||
"verified": false,
|
||||
"downloads": 0,
|
||||
"stars": 0,
|
||||
"created_at": "2026-08-10T00:00:00Z",
|
||||
"updated_at": "2026-08-10T00:00:00Z"
|
||||
},
|
||||
"learn": {
|
||||
"name": "Learning Extension",
|
||||
"id": "learn",
|
||||
@@ -3406,8 +3440,8 @@
|
||||
"id": "reconcile",
|
||||
"description": "Reconcile implementation drift by surgically updating the feature's own spec, plan, and tasks.",
|
||||
"author": "Stanislav Deviatov",
|
||||
"version": "1.0.0",
|
||||
"download_url": "https://github.com/stn1slv/spec-kit-reconcile/archive/refs/tags/v1.0.0.zip",
|
||||
"version": "1.1.0",
|
||||
"download_url": "https://github.com/stn1slv/spec-kit-reconcile/archive/refs/tags/v1.1.0.zip",
|
||||
"repository": "https://github.com/stn1slv/spec-kit-reconcile",
|
||||
"homepage": "https://github.com/stn1slv/spec-kit-reconcile",
|
||||
"documentation": "https://github.com/stn1slv/spec-kit-reconcile/blob/main/README.md",
|
||||
@@ -3432,7 +3466,7 @@
|
||||
"downloads": 0,
|
||||
"stars": 0,
|
||||
"created_at": "2026-03-14T00:00:00Z",
|
||||
"updated_at": "2026-03-14T00:00:00Z"
|
||||
"updated_at": "2026-08-10T00:00:00Z"
|
||||
},
|
||||
"red-team": {
|
||||
"name": "Red Team",
|
||||
|
||||
@@ -84,6 +84,15 @@
|
||||
"repository": "https://github.com/github/spec-kit",
|
||||
"tags": ["cli", "skills"]
|
||||
},
|
||||
"command-code": {
|
||||
"id": "command-code",
|
||||
"name": "Command Code",
|
||||
"version": "1.0.0",
|
||||
"description": "Command Code CLI skills-based integration",
|
||||
"author": "spec-kit-core",
|
||||
"repository": "https://github.com/github/spec-kit",
|
||||
"tags": ["cli", "skills"]
|
||||
},
|
||||
"devin": {
|
||||
"id": "devin",
|
||||
"name": "Devin for Terminal",
|
||||
|
||||
@@ -59,6 +59,19 @@ Content resolution functions for composition:
|
||||
- **Bash**: `resolve_template_content()` in `scripts/bash/common.sh` (templates only; command/script composition is handled by the Python resolver)
|
||||
- **PowerShell**: `Resolve-TemplateContent` in `scripts/powershell/common.ps1` (templates only; command/script composition is handled by the Python resolver)
|
||||
|
||||
### Constitution lifecycle
|
||||
|
||||
Initialization resolves `constitution-template` through the full stack and seeds
|
||||
`.specify/memory/constitution.md` once. Existing files are preserved byte-for-byte. On subsequent
|
||||
`/constitution` runs, the command resolves the current composed template at runtime and uses the live
|
||||
constitution as the source of project-specific values and amendments.
|
||||
|
||||
Preset installation, removal, enablement, disablement, and priority changes do not materialize
|
||||
`constitution-template` by default. When the enabled preset registry contains `constitution-sync`,
|
||||
those operations may reconcile the live file, but only if its provenance hash proves it is still
|
||||
generated content. Missing files may be seeded when the preset is installed; authored or edited
|
||||
constitutions are never overwritten.
|
||||
|
||||
## Command Registration
|
||||
|
||||
When a preset is installed with `type: "command"` entries, the `PresetManager` registers them into all detected agent directories using the shared `CommandRegistrar` from `src/specify_cli/agents.py`.
|
||||
|
||||
@@ -15,6 +15,16 @@ If no preset is installed, core templates are used — exactly the same behavior
|
||||
|
||||
Template resolution happens **at runtime** — although preset files are copied into `.specify/presets/<id>/` during installation, Spec Kit walks the resolution stack on every template lookup rather than merging templates into a single location.
|
||||
|
||||
`constitution-template` follows the same runtime model. Project initialization seeds
|
||||
`.specify/memory/constitution.md` once so downstream commands always have a constitution to read.
|
||||
After that, installing, removing, enabling, disabling, or reprioritizing presets does not rewrite the
|
||||
live constitution. Each `/constitution` run resolves the current composed `constitution-template`,
|
||||
then applies existing project values and amendments to that scaffold.
|
||||
|
||||
Teams that intentionally want preset stack changes to refresh an unchanged generated constitution can
|
||||
install the bundled `constitution-sync` preset. It restores guarded install-time materialization in
|
||||
addition to its command-time propagation behavior; authored constitutions remain protected.
|
||||
|
||||
For detailed resolution and command registration flows, see [ARCHITECTURE.md](ARCHITECTURE.md).
|
||||
|
||||
## Command Overrides
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"updated_at": "2026-07-28T00:00:00Z",
|
||||
"updated_at": "2026-08-10T00:00:00Z",
|
||||
|
||||
"catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/presets/catalog.community.json",
|
||||
"presets": {
|
||||
@@ -541,6 +541,35 @@
|
||||
"created_at": "2026-05-08T00:00:00Z",
|
||||
"updated_at": "2026-05-08T00:00:00Z"
|
||||
},
|
||||
"model-routing-governance": {
|
||||
"name": "Model Routing Governance",
|
||||
"id": "model-routing-governance",
|
||||
"version": "0.1.4",
|
||||
"description": "Maps provider-neutral Spec Kit roles to validated harness-local runner profiles without storing model availability, credentials, or machine-specific selections in Git.",
|
||||
"author": "Thorsten Hindermann",
|
||||
"repository": "https://github.com/hindermath/spec-kit-preset-model-routing-governance",
|
||||
"download_url": "https://github.com/hindermath/spec-kit-preset-model-routing-governance/archive/refs/tags/v0.1.4.zip",
|
||||
"homepage": "https://github.com/hindermath/spec-kit-preset-model-routing-governance",
|
||||
"documentation": "https://github.com/hindermath/spec-kit-preset-model-routing-governance/blob/v0.1.4/README.md",
|
||||
"license": "MIT",
|
||||
"requires": {
|
||||
"speckit_version": ">=0.8.3"
|
||||
},
|
||||
"provides": {
|
||||
"templates": 4,
|
||||
"commands": 2,
|
||||
"scripts": 2
|
||||
},
|
||||
"tags": [
|
||||
"model-routing",
|
||||
"agents",
|
||||
"governance",
|
||||
"provider-neutral",
|
||||
"cross-platform"
|
||||
],
|
||||
"created_at": "2026-08-10T00:00:00Z",
|
||||
"updated_at": "2026-08-10T00:00:00Z"
|
||||
},
|
||||
"multi-repo-branching": {
|
||||
"name": "Multi-Repo Branching",
|
||||
"id": "multi-repo-branching",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"updated_at": "2026-04-24T00:00:00Z",
|
||||
"updated_at": "2026-08-04T00:00:00Z",
|
||||
"catalog_url": "https://raw.githubusercontent.com/github/spec-kit/main/presets/catalog.json",
|
||||
"presets": {
|
||||
"lean": {
|
||||
@@ -30,7 +30,7 @@
|
||||
"name": "Constitution Template Sync",
|
||||
"id": "constitution-sync",
|
||||
"version": "1.0.0",
|
||||
"description": "Opt-in: restores /constitution propagation of amended guidance into plan/spec/tasks templates and installed command files, for teams that treat materialized templates as reviewed artifacts.",
|
||||
"description": "Opt-in: restores guarded install-time constitution seeding and /constitution propagation for teams that treat materialized templates as reviewed artifacts.",
|
||||
"author": "github",
|
||||
"repository": "https://github.com/github/spec-kit",
|
||||
"license": "MIT",
|
||||
|
||||
@@ -1,13 +1,15 @@
|
||||
# Constitution Template Sync
|
||||
|
||||
An **opt-in** preset that restores `/constitution`'s ability to propagate amended guidance into your
|
||||
project's own templates and command files. After you update the constitution, it aligns
|
||||
`plan-template.md`, `spec-template.md`, `tasks-template.md`, project-local command files, and
|
||||
An **opt-in** preset that restores materialized constitution workflows. It refreshes an unchanged
|
||||
generated `.specify/memory/constitution.md` when constitution-providing presets are installed,
|
||||
removed, enabled, disabled, or reprioritized. After `/constitution` updates the live file, it also
|
||||
aligns `plan-template.md`, `spec-template.md`, `tasks-template.md`, project-local command files, and
|
||||
guidance docs so they reflect the current principles.
|
||||
|
||||
This propagation used to be built into `/constitution`; it was dropped when the command moved to the
|
||||
preset model. Installing this preset opts you back into it: you get the guidance materialized into
|
||||
reviewed, committed artifacts instead of relying on runtime resolution alone.
|
||||
preset model. Installing this preset opts you back into materialization: preset stack changes refresh
|
||||
the generated constitution, and `/constitution` propagates its guidance into reviewed, committed
|
||||
artifacts instead of relying on runtime resolution alone.
|
||||
|
||||
> **What you're opting into.** Propagation was removed deliberately — it duplicates the constitution
|
||||
> as the source of truth and can fight the composition stack (materialized edits get shadowed or
|
||||
@@ -28,7 +30,12 @@ versioned preset a core team maintains.
|
||||
|
||||
## What it does
|
||||
|
||||
Ships a single `wrap`-strategy override of `speckit.constitution`. It composes on top of the
|
||||
Its presence enables core's guarded install-time constitution reconciliation. Installing the preset
|
||||
materializes the currently resolved `constitution-template`; later stack changes re-materialize it
|
||||
only while the live file still matches its recorded generated-content hash. Human edits disable
|
||||
automatic replacement.
|
||||
|
||||
It also ships a single `wrap`-strategy override of `speckit.constitution`. It composes on top of the
|
||||
current core command (via `{CORE_TEMPLATE}`), so it stays forward-compatible with core changes, and
|
||||
appends a propagation pass that, after the constitution is written:
|
||||
|
||||
@@ -43,6 +50,8 @@ appends a propagation pass that, after the constitution is written:
|
||||
- It does **not** disable runtime resolution. `plan`, `tasks`, and `analyze` still read the live
|
||||
constitution every run; this preset adds materialized copies on top — it does not replace the
|
||||
source of truth.
|
||||
- It does **not** overwrite an authored or edited constitution. Install-time reconciliation only
|
||||
replaces content whose provenance proves it is an unchanged generated file.
|
||||
- It does **not** edit versioned, package-owned files — templates or command files provided or
|
||||
wrapped by another preset or extension. Those are recomposed from the resolution stack, so it
|
||||
only ever writes into your project's own `.specify/templates/` scaffolds and command files that
|
||||
|
||||
@@ -4,7 +4,7 @@ preset:
|
||||
id: "constitution-sync"
|
||||
name: "Constitution Template Sync"
|
||||
version: "1.0.0"
|
||||
description: "Opt-in: restores /constitution propagation of amended guidance into plan/spec/tasks templates and installed command files, for teams that treat materialized templates as reviewed artifacts."
|
||||
description: "Opt-in: restores guarded install-time constitution seeding and /constitution propagation for teams that treat materialized templates as reviewed artifacts."
|
||||
author: "github"
|
||||
repository: "https://github.com/github/spec-kit"
|
||||
license: "MIT"
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
[project]
|
||||
name = "specify-cli"
|
||||
version = "0.16.1"
|
||||
version = "0.16.2"
|
||||
description = "Specify CLI, part of GitHub Spec Kit. A tool to bootstrap your projects for Spec-Driven Development (SDD)."
|
||||
readme = "README.md"
|
||||
requires-python = ">=3.11"
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
# --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)
|
||||
# --template NAME Include composed template content in JSON output
|
||||
# --help, -h Show help message
|
||||
#
|
||||
# OUTPUTS:
|
||||
@@ -26,9 +27,10 @@ JSON_MODE=false
|
||||
REQUIRE_TASKS=false
|
||||
INCLUDE_TASKS=false
|
||||
PATHS_ONLY=false
|
||||
TEMPLATE_NAME=""
|
||||
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
while [[ $# -gt 0 ]]; do
|
||||
case "$1" in
|
||||
--json)
|
||||
JSON_MODE=true
|
||||
;;
|
||||
@@ -41,6 +43,14 @@ for arg in "$@"; do
|
||||
--paths-only)
|
||||
PATHS_ONLY=true
|
||||
;;
|
||||
--template)
|
||||
shift
|
||||
if [[ $# -eq 0 ]]; then
|
||||
echo "ERROR: --template requires a template name" >&2
|
||||
exit 1
|
||||
fi
|
||||
TEMPLATE_NAME="$1"
|
||||
;;
|
||||
--help|-h)
|
||||
cat << 'EOF'
|
||||
Usage: check-prerequisites.sh [OPTIONS]
|
||||
@@ -52,6 +62,7 @@ OPTIONS:
|
||||
--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)
|
||||
--template NAME Include composed template content in JSON output
|
||||
--help, -h Show this help message
|
||||
|
||||
EXAMPLES:
|
||||
@@ -68,10 +79,11 @@ EOF
|
||||
exit 0
|
||||
;;
|
||||
*)
|
||||
echo "ERROR: Unknown option '$arg'. Use --help for usage information." >&2
|
||||
echo "ERROR: Unknown option '$1'. Use --help for usage information." >&2
|
||||
exit 1
|
||||
;;
|
||||
esac
|
||||
shift
|
||||
done
|
||||
|
||||
# Source common functions
|
||||
@@ -156,6 +168,16 @@ if $INCLUDE_TASKS && [[ -f "$TASKS" ]]; then
|
||||
docs+=("tasks.md")
|
||||
fi
|
||||
|
||||
TEMPLATE_CONTENT=""
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
if TEMPLATE_CONTENT=$(resolve_template_content "$TEMPLATE_NAME" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
TEMPLATE_CONTENT="${TEMPLATE_CONTENT%x}"
|
||||
else
|
||||
echo "ERROR: Could not resolve required $TEMPLATE_NAME from the template override stack for $REPO_ROOT" >&2
|
||||
exit 1
|
||||
fi
|
||||
fi
|
||||
|
||||
# Output results
|
||||
if $JSON_MODE; then
|
||||
# Build JSON array of documents
|
||||
@@ -165,10 +187,18 @@ if $JSON_MODE; then
|
||||
else
|
||||
json_docs=$(printf '%s\n' "${docs[@]}" | jq -R . | jq -s .)
|
||||
fi
|
||||
jq -cn \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--argjson docs "$json_docs" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs}'
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
jq -cn \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--argjson docs "$json_docs" \
|
||||
--arg template_content "$TEMPLATE_CONTENT" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs,TEMPLATE_CONTENT:$template_content}'
|
||||
else
|
||||
jq -cn \
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--argjson docs "$json_docs" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs}'
|
||||
fi
|
||||
else
|
||||
if [[ ${#docs[@]} -eq 0 ]]; then
|
||||
json_docs="[]"
|
||||
@@ -176,7 +206,12 @@ if $JSON_MODE; then
|
||||
json_docs=$(for d in "${docs[@]}"; do printf '"%s",' "$(json_escape "$d")"; done)
|
||||
json_docs="[${json_docs%,}]"
|
||||
fi
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s}\n' "$(json_escape "$FEATURE_DIR")" "$json_docs"
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s,"TEMPLATE_CONTENT":"%s"}\n' \
|
||||
"$(json_escape "$FEATURE_DIR")" "$json_docs" "$(json_escape "$TEMPLATE_CONTENT")"
|
||||
else
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s}\n' "$(json_escape "$FEATURE_DIR")" "$json_docs"
|
||||
fi
|
||||
fi
|
||||
else
|
||||
# Text output
|
||||
|
||||
+322
-108
@@ -398,6 +398,101 @@ json_escape() {
|
||||
check_file() { [[ -f "$1" ]] && echo " ✓ $2" || echo " ✗ $2"; }
|
||||
check_dir() { [[ -d "$1" && -n $(ls -A "$1" 2>/dev/null) ]] && echo " ✓ $2" || echo " ✗ $2"; }
|
||||
|
||||
_python3_command() {
|
||||
if command -v python3 >/dev/null 2>&1 &&
|
||||
python3 -c 'import sys; raise SystemExit(sys.version_info.major != 3)' >/dev/null 2>&1; then
|
||||
printf '%s\n' "python3"
|
||||
elif command -v python >/dev/null 2>&1 &&
|
||||
python -c 'import sys; raise SystemExit(sys.version_info.major != 3)' >/dev/null 2>&1; then
|
||||
printf '%s\n' "python"
|
||||
elif command -v py >/dev/null 2>&1 &&
|
||||
py -3 -c 'import sys' >/dev/null 2>&1; then
|
||||
printf '%s\n' "py -3"
|
||||
else
|
||||
return 1
|
||||
fi
|
||||
}
|
||||
|
||||
_sorted_extension_ids() {
|
||||
local ext_dir="$1"
|
||||
local python_spec
|
||||
if python_spec=$(_python3_command); then
|
||||
local -a python_cmd
|
||||
read -r -a python_cmd <<< "$python_spec"
|
||||
local py_stderr sorted_ids
|
||||
py_stderr=$(mktemp)
|
||||
if sorted_ids=$(SPECKIT_EXTENSIONS="$ext_dir" "${python_cmd[@]}" -c "
|
||||
import json, os, re, sys
|
||||
from pathlib import Path
|
||||
|
||||
root = Path(os.environ['SPECKIT_EXTENSIONS'])
|
||||
registered = {}
|
||||
registry = root / '.registry'
|
||||
if os.path.lexists(registry):
|
||||
if not registry.is_file():
|
||||
print('registry_invalid: not a regular file', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
try:
|
||||
data = json.loads(registry.read_text(encoding='utf-8'))
|
||||
except Exception as exc:
|
||||
print('registry_invalid: ' + str(exc), file=sys.stderr)
|
||||
sys.exit(1)
|
||||
if not isinstance(data, dict):
|
||||
print('registry_invalid: root must be a mapping', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
raw_extensions = data.get('extensions', {})
|
||||
if not isinstance(raw_extensions, dict):
|
||||
print('registry_invalid: extensions must be a mapping', file=sys.stderr)
|
||||
sys.exit(1)
|
||||
registered = raw_extensions
|
||||
|
||||
def priority(value):
|
||||
if isinstance(value, bool):
|
||||
return 10
|
||||
try:
|
||||
parsed = int(value)
|
||||
return parsed if parsed >= 1 else 10
|
||||
except (TypeError, ValueError, OverflowError):
|
||||
return 10
|
||||
|
||||
ranked = []
|
||||
for ext_id, meta in registered.items():
|
||||
if isinstance(ext_id, str) and re.fullmatch(r'[a-z0-9-]+', ext_id) and isinstance(meta, dict) and bool(meta.get('enabled', True)):
|
||||
ranked.append((priority(meta.get('priority')), ext_id))
|
||||
for path in root.iterdir():
|
||||
if path.is_dir() and re.fullmatch(r'[a-z0-9-]+', path.name) and path.name not in registered:
|
||||
ranked.append((10, path.name))
|
||||
for _, ext_id in sorted(ranked):
|
||||
print(ext_id)
|
||||
" 2>"$py_stderr"); then
|
||||
rm -f "$py_stderr"
|
||||
printf '%s\n' "$sorted_ids"
|
||||
return 0
|
||||
else
|
||||
echo "Error: invalid extension registry $ext_dir/.registry" >&2
|
||||
rm -f "$py_stderr"
|
||||
return 1
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ -e "$ext_dir/.registry" ] || [ -L "$ext_dir/.registry" ]; then
|
||||
if [ ! -f "$ext_dir/.registry" ] || [ ! -r "$ext_dir/.registry" ]; then
|
||||
echo "Error: invalid extension registry $ext_dir/.registry" >&2
|
||||
return 1
|
||||
fi
|
||||
echo "Error: Python 3 is required to honor the extension registry" >&2
|
||||
return 2
|
||||
fi
|
||||
|
||||
local ext extension_id
|
||||
for ext in "$ext_dir"/*/; do
|
||||
[ -d "$ext" ] || continue
|
||||
extension_id=$(basename "$ext")
|
||||
case "$extension_id" in *[!a-z0-9-]*) continue ;; esac
|
||||
printf '%s\n' "$extension_id"
|
||||
done
|
||||
}
|
||||
|
||||
# Resolve a template name to a file path using the priority stack:
|
||||
# 1. .specify/templates/overrides/
|
||||
# 2. .specify/presets/<preset-id>/templates/ (sorted by priority from .registry)
|
||||
@@ -408,6 +503,8 @@ resolve_template() {
|
||||
local repo_root="$2"
|
||||
local base="$repo_root/.specify/templates"
|
||||
|
||||
case "$template_name" in ""|*[!a-z0-9-]*) return 1 ;; esac
|
||||
|
||||
# Priority 1: Project overrides
|
||||
local override="$base/overrides/${template_name}.md"
|
||||
[ -f "$override" ] && echo "$override" && return 0
|
||||
@@ -416,19 +513,32 @@ resolve_template() {
|
||||
local presets_dir="$repo_root/.specify/presets"
|
||||
if [ -d "$presets_dir" ]; then
|
||||
local registry_file="$presets_dir/.registry"
|
||||
if [ -f "$registry_file" ] && command -v python3 >/dev/null 2>&1; then
|
||||
local python_spec=""
|
||||
local -a python_cmd=()
|
||||
if python_spec=$(_python3_command); then
|
||||
read -r -a python_cmd <<< "$python_spec"
|
||||
fi
|
||||
if [ -f "$registry_file" ] && [ "${#python_cmd[@]}" -gt 0 ]; then
|
||||
# Read preset IDs sorted by priority (lower number = higher precedence).
|
||||
# The python3 call is wrapped in an if-condition so that set -e does not
|
||||
# abort the function when python3 exits non-zero (e.g. invalid JSON).
|
||||
local sorted_presets=""
|
||||
if sorted_presets=$(SPECKIT_REGISTRY="$registry_file" python3 -c "
|
||||
import json, sys, os
|
||||
if sorted_presets=$(SPECKIT_REGISTRY="$registry_file" "${python_cmd[@]}" -c "
|
||||
import json, re, sys, os
|
||||
try:
|
||||
with open(os.environ['SPECKIT_REGISTRY']) as f:
|
||||
with open(os.environ['SPECKIT_REGISTRY'], encoding='utf-8') as f:
|
||||
data = json.load(f)
|
||||
presets = data.get('presets', {})
|
||||
for pid, meta in sorted(presets.items(), key=lambda x: x[1].get('priority', 10) if isinstance(x[1], dict) else 10):
|
||||
if isinstance(meta, dict) and meta.get('enabled', True) is not False:
|
||||
def priority(meta):
|
||||
if not isinstance(meta, dict) or isinstance(meta.get('priority'), bool):
|
||||
return 10
|
||||
try:
|
||||
value = int(meta.get('priority', 10))
|
||||
return value if value >= 1 else 10
|
||||
except (TypeError, ValueError, OverflowError):
|
||||
return 10
|
||||
for pid, meta in sorted(presets.items(), key=lambda x: (priority(x[1]), x[0])):
|
||||
if isinstance(meta, dict) and bool(meta.get('enabled', True)) and re.fullmatch(r'[a-z0-9-]+', pid):
|
||||
print(pid)
|
||||
except Exception:
|
||||
sys.exit(1)
|
||||
@@ -438,6 +548,8 @@ except Exception:
|
||||
while IFS= read -r preset_id; do
|
||||
local candidate="$presets_dir/$preset_id/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
candidate="$presets_dir/$preset_id/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done <<< "$sorted_presets"
|
||||
fi
|
||||
# python3 succeeded but registry has no presets — nothing to search
|
||||
@@ -447,6 +559,8 @@ except Exception:
|
||||
[ -d "$preset" ] || continue
|
||||
local candidate="$preset/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
candidate="$preset/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done
|
||||
fi
|
||||
else
|
||||
@@ -455,6 +569,8 @@ except Exception:
|
||||
[ -d "$preset" ] || continue
|
||||
local candidate="$preset/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
candidate="$preset/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done
|
||||
fi
|
||||
fi
|
||||
@@ -462,13 +578,17 @@ except Exception:
|
||||
# Priority 3: Extension-provided templates
|
||||
local ext_dir="$repo_root/.specify/extensions"
|
||||
if [ -d "$ext_dir" ]; then
|
||||
for ext in "$ext_dir"/*/; do
|
||||
[ -d "$ext" ] || continue
|
||||
# Skip hidden directories (e.g. .backup, .cache)
|
||||
case "$(basename "$ext")" in .*) continue;; esac
|
||||
local sorted_extensions=""
|
||||
if ! sorted_extensions=$(_sorted_extension_ids "$ext_dir"); then
|
||||
return 2
|
||||
fi
|
||||
while IFS= read -r extension_id; do
|
||||
[ -n "$extension_id" ] || continue
|
||||
local ext="$ext_dir/$extension_id"
|
||||
local candidate="$ext/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] || candidate="$ext/${template_name}.md"
|
||||
[ -f "$candidate" ] && echo "$candidate" && return 0
|
||||
done
|
||||
done <<< "$sorted_extensions"
|
||||
fi
|
||||
|
||||
# Priority 4: Core templates
|
||||
@@ -492,6 +612,8 @@ resolve_template_content() {
|
||||
local repo_root="$2"
|
||||
local base="$repo_root/.specify/templates"
|
||||
|
||||
case "$template_name" in ""|*[!a-z0-9-]*) return 1 ;; esac
|
||||
|
||||
# Collect all layers (highest priority first)
|
||||
local -a layer_paths=()
|
||||
local -a layer_strategies=()
|
||||
@@ -499,133 +621,206 @@ resolve_template_content() {
|
||||
# Priority 1: Project overrides (always "replace")
|
||||
local override="$base/overrides/${template_name}.md"
|
||||
if [ -f "$override" ]; then
|
||||
layer_paths+=("$override")
|
||||
layer_strategies+=("replace")
|
||||
if ! cat "$override"; then
|
||||
echo "Error: failed to read template layer $override" >&2
|
||||
return 2
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
local effective_base_found=false
|
||||
|
||||
# Priority 2: Installed presets (sorted by priority from .registry)
|
||||
local presets_dir="$repo_root/.specify/presets"
|
||||
if [ -d "$presets_dir" ]; then
|
||||
local registry_file="$presets_dir/.registry"
|
||||
local sorted_presets=""
|
||||
if [ -f "$registry_file" ] && command -v python3 >/dev/null 2>&1; then
|
||||
if sorted_presets=$(SPECKIT_REGISTRY="$registry_file" python3 -c "
|
||||
import json, sys, os
|
||||
local registry_parsed=false
|
||||
local python_spec=""
|
||||
local -a python_cmd=()
|
||||
if python_spec=$(_python3_command); then
|
||||
read -r -a python_cmd <<< "$python_spec"
|
||||
fi
|
||||
if [ -f "$registry_file" ] && [ "${#python_cmd[@]}" -gt 0 ]; then
|
||||
if sorted_presets=$(SPECKIT_REGISTRY="$registry_file" "${python_cmd[@]}" -c "
|
||||
import json, re, sys, os
|
||||
try:
|
||||
with open(os.environ['SPECKIT_REGISTRY']) as f:
|
||||
with open(os.environ['SPECKIT_REGISTRY'], encoding='utf-8') as f:
|
||||
data = json.load(f)
|
||||
presets = data.get('presets', {})
|
||||
for pid, meta in sorted(presets.items(), key=lambda x: x[1].get('priority', 10) if isinstance(x[1], dict) else 10):
|
||||
if isinstance(meta, dict) and meta.get('enabled', True) is not False:
|
||||
def priority(meta):
|
||||
if not isinstance(meta, dict) or isinstance(meta.get('priority'), bool):
|
||||
return 10
|
||||
try:
|
||||
value = int(meta.get('priority', 10))
|
||||
return value if value >= 1 else 10
|
||||
except (TypeError, ValueError, OverflowError):
|
||||
return 10
|
||||
for pid, meta in sorted(presets.items(), key=lambda x: (priority(x[1]), x[0])):
|
||||
if isinstance(meta, dict) and bool(meta.get('enabled', True)) and re.fullmatch(r'[a-z0-9-]+', pid):
|
||||
print(pid)
|
||||
except Exception:
|
||||
sys.exit(1)
|
||||
" 2>/dev/null); then
|
||||
if [ -n "$sorted_presets" ]; then
|
||||
local yaml_warned=false
|
||||
while IFS= read -r preset_id; do
|
||||
# Read strategy and file path from preset manifest
|
||||
local strategy="replace"
|
||||
local manifest_file=""
|
||||
local manifest="$presets_dir/$preset_id/preset.yml"
|
||||
if [ -f "$manifest" ] && command -v python3 >/dev/null 2>&1; then
|
||||
# Requires PyYAML; falls back to replace/convention if unavailable
|
||||
local result
|
||||
local py_stderr
|
||||
py_stderr=$(mktemp)
|
||||
result=$(SPECKIT_MANIFEST="$manifest" SPECKIT_TMPL="$template_name" python3 -c "
|
||||
registry_parsed=true
|
||||
fi
|
||||
fi
|
||||
if [ "$registry_parsed" = false ]; then
|
||||
for preset in "$presets_dir"/*/; do
|
||||
[ -d "$preset" ] || continue
|
||||
local fallback_id
|
||||
fallback_id=$(basename "$preset")
|
||||
case "$fallback_id" in *[!a-z0-9-]*) continue ;; esac
|
||||
sorted_presets+="${sorted_presets:+$'\n'}$fallback_id"
|
||||
done
|
||||
fi
|
||||
|
||||
if [ -n "$sorted_presets" ]; then
|
||||
while IFS= read -r preset_id; do
|
||||
local strategy="replace"
|
||||
local manifest_file=""
|
||||
local manifest="$presets_dir/$preset_id/preset.yml"
|
||||
local manifest_declared=false
|
||||
if [ -f "$manifest" ]; then
|
||||
if [ "${#python_cmd[@]}" -eq 0 ]; then
|
||||
echo "Error: Python 3 and PyYAML are required to resolve preset template composition" >&2
|
||||
return 2
|
||||
fi
|
||||
local result
|
||||
local py_stderr
|
||||
local parse_status
|
||||
py_stderr=$(mktemp)
|
||||
if result=$(SPECKIT_MANIFEST="$manifest" SPECKIT_TMPL="$template_name" "${python_cmd[@]}" -c "
|
||||
import sys, os
|
||||
try:
|
||||
import yaml
|
||||
except ImportError:
|
||||
print('yaml_missing', file=sys.stderr)
|
||||
print('replace\t')
|
||||
sys.exit(0)
|
||||
sys.exit(2)
|
||||
try:
|
||||
with open(os.environ['SPECKIT_MANIFEST']) as f:
|
||||
with open(os.environ['SPECKIT_MANIFEST'], encoding='utf-8') as f:
|
||||
data = yaml.safe_load(f)
|
||||
for t in data.get('provides', {}).get('templates', []):
|
||||
if not isinstance(data, dict):
|
||||
raise ValueError('manifest root must be a mapping')
|
||||
if 'provides' not in data:
|
||||
raise ValueError('manifest missing provides section')
|
||||
provides = data['provides']
|
||||
if not isinstance(provides, dict):
|
||||
raise ValueError('manifest provides must be a mapping')
|
||||
if 'templates' not in provides:
|
||||
raise ValueError('manifest provides missing templates')
|
||||
templates = provides['templates']
|
||||
if not isinstance(templates, list):
|
||||
raise ValueError('manifest templates must be a list')
|
||||
if not templates:
|
||||
raise ValueError('manifest must provide at least one template')
|
||||
valid_types = ('template', 'command', 'script')
|
||||
valid_strategies = ('replace', 'prepend', 'append', 'wrap')
|
||||
for t in templates:
|
||||
if not isinstance(t, dict):
|
||||
raise ValueError('manifest template entries must be mappings')
|
||||
if 'type' not in t or 'name' not in t or 'file' not in t:
|
||||
raise ValueError('manifest template entry missing type, name, or file')
|
||||
for field in ('type', 'name', 'file'):
|
||||
if not isinstance(t[field], str):
|
||||
raise ValueError('manifest template ' + field + ' must be a string')
|
||||
if t['type'] not in valid_types:
|
||||
raise ValueError('invalid manifest template type')
|
||||
strategy = t.get('strategy', 'replace')
|
||||
if not isinstance(strategy, str):
|
||||
raise ValueError('manifest template strategy must be a string')
|
||||
strategy = strategy.lower()
|
||||
if strategy not in valid_strategies:
|
||||
raise ValueError('invalid manifest template strategy')
|
||||
if t['type'] == 'script' and strategy not in ('replace', 'wrap'):
|
||||
raise ValueError('invalid manifest script strategy')
|
||||
for t in templates:
|
||||
if t.get('name') == os.environ['SPECKIT_TMPL'] and t.get('type', 'template') == 'template':
|
||||
print(t.get('strategy', 'replace') + '\t' + t.get('file', ''))
|
||||
file_value = t.get('file', '')
|
||||
strategy = t.get('strategy', 'replace')
|
||||
print('found\t' + strategy + '\t' + file_value)
|
||||
sys.exit(0)
|
||||
print('replace\t')
|
||||
except Exception:
|
||||
print('replace\t')
|
||||
" 2>"$py_stderr")
|
||||
local parse_status=$?
|
||||
if [ $parse_status -eq 0 ] && [ -n "$result" ]; then
|
||||
IFS=$'\t' read -r strategy manifest_file <<< "$result"
|
||||
strategy=$(printf '%s' "$strategy" | tr '[:upper:]' '[:lower:]')
|
||||
fi
|
||||
if [ "$yaml_warned" = false ] && grep -q 'yaml_missing' "$py_stderr" 2>/dev/null; then
|
||||
echo "Warning: PyYAML not available; composition strategies may be ignored" >&2
|
||||
yaml_warned=true
|
||||
fi
|
||||
rm -f "$py_stderr"
|
||||
fi
|
||||
# Try manifest file path first, then convention path
|
||||
local candidate=""
|
||||
if [ -n "$manifest_file" ]; then
|
||||
# Reject absolute paths and parent traversal
|
||||
case "$manifest_file" in
|
||||
/*|*../*|../*) manifest_file="" ;;
|
||||
esac
|
||||
fi
|
||||
if [ -n "$manifest_file" ]; then
|
||||
local mf="$presets_dir/$preset_id/$manifest_file"
|
||||
[ -f "$mf" ] && candidate="$mf"
|
||||
fi
|
||||
if [ -z "$candidate" ]; then
|
||||
local cf="$presets_dir/$preset_id/templates/${template_name}.md"
|
||||
[ -f "$cf" ] && candidate="$cf"
|
||||
fi
|
||||
if [ -n "$candidate" ]; then
|
||||
layer_paths+=("$candidate")
|
||||
layer_strategies+=("$strategy")
|
||||
fi
|
||||
done <<< "$sorted_presets"
|
||||
fi
|
||||
else
|
||||
# python3 failed — fall back to unordered directory scan (replace only)
|
||||
for preset in "$presets_dir"/*/; do
|
||||
[ -d "$preset" ] || continue
|
||||
local candidate="$preset/templates/${template_name}.md"
|
||||
if [ -f "$candidate" ]; then
|
||||
layer_paths+=("$candidate")
|
||||
layer_strategies+=("replace")
|
||||
print('absent\treplace\t')
|
||||
except Exception as exc:
|
||||
print(f'manifest_invalid: {exc}', file=sys.stderr)
|
||||
sys.exit(3)
|
||||
" 2>"$py_stderr"); then
|
||||
parse_status=0
|
||||
else
|
||||
parse_status=$?
|
||||
fi
|
||||
done
|
||||
fi
|
||||
else
|
||||
# No python3 or registry — fall back to unordered directory scan (replace only)
|
||||
for preset in "$presets_dir"/*/; do
|
||||
[ -d "$preset" ] || continue
|
||||
local candidate="$preset/templates/${template_name}.md"
|
||||
if [ -f "$candidate" ]; then
|
||||
layer_paths+=("$candidate")
|
||||
layer_strategies+=("replace")
|
||||
if [ "$parse_status" -ne 0 ]; then
|
||||
if [ "$parse_status" -eq 2 ]; then
|
||||
echo "Error: PyYAML is required to resolve preset template composition" >&2
|
||||
else
|
||||
echo "Error: invalid preset manifest $manifest" >&2
|
||||
fi
|
||||
rm -f "$py_stderr"
|
||||
return 2
|
||||
fi
|
||||
if [ -n "$result" ]; then
|
||||
local declaration
|
||||
IFS=$'\t' read -r declaration strategy manifest_file <<< "$result"
|
||||
[ "$declaration" = "found" ] && manifest_declared=true
|
||||
strategy=$(printf '%s' "$strategy" | tr '[:upper:]' '[:lower:]')
|
||||
fi
|
||||
rm -f "$py_stderr"
|
||||
fi
|
||||
done
|
||||
|
||||
local candidate=""
|
||||
if [ -n "$manifest_file" ]; then
|
||||
case "$manifest_file" in
|
||||
/*|*../*|../*) manifest_file="" ;;
|
||||
esac
|
||||
fi
|
||||
if [ -n "$manifest_file" ]; then
|
||||
local mf="$presets_dir/$preset_id/$manifest_file"
|
||||
[ -f "$mf" ] && candidate="$mf"
|
||||
fi
|
||||
if [ -z "$candidate" ] && [ "$manifest_declared" = false ]; then
|
||||
local cf="$presets_dir/$preset_id/templates/${template_name}.md"
|
||||
[ -f "$cf" ] && candidate="$cf"
|
||||
if [ -z "$candidate" ]; then
|
||||
cf="$presets_dir/$preset_id/${template_name}.md"
|
||||
[ -f "$cf" ] && candidate="$cf"
|
||||
fi
|
||||
fi
|
||||
if [ -n "$candidate" ]; then
|
||||
layer_paths+=("$candidate")
|
||||
layer_strategies+=("$strategy")
|
||||
if [ "$strategy" = "replace" ]; then
|
||||
effective_base_found=true
|
||||
break
|
||||
fi
|
||||
fi
|
||||
done <<< "$sorted_presets"
|
||||
fi
|
||||
fi
|
||||
|
||||
# Priority 3: Extension-provided templates (always "replace")
|
||||
local ext_dir="$repo_root/.specify/extensions"
|
||||
if [ -d "$ext_dir" ]; then
|
||||
for ext in "$ext_dir"/*/; do
|
||||
[ -d "$ext" ] || continue
|
||||
case "$(basename "$ext")" in .*) continue;; esac
|
||||
if [ "$effective_base_found" = false ] && [ -d "$ext_dir" ]; then
|
||||
local sorted_extensions=""
|
||||
if ! sorted_extensions=$(_sorted_extension_ids "$ext_dir"); then
|
||||
return 2
|
||||
fi
|
||||
while IFS= read -r extension_id; do
|
||||
[ -n "$extension_id" ] || continue
|
||||
local ext="$ext_dir/$extension_id"
|
||||
local candidate="$ext/templates/${template_name}.md"
|
||||
[ -f "$candidate" ] || candidate="$ext/${template_name}.md"
|
||||
if [ -f "$candidate" ]; then
|
||||
layer_paths+=("$candidate")
|
||||
layer_strategies+=("replace")
|
||||
effective_base_found=true
|
||||
break
|
||||
fi
|
||||
done
|
||||
done <<< "$sorted_extensions"
|
||||
fi
|
||||
|
||||
# Priority 4: Core templates (always "replace")
|
||||
local core="$base/${template_name}.md"
|
||||
if [ -f "$core" ]; then
|
||||
if [ "$effective_base_found" = false ] && [ -f "$core" ]; then
|
||||
layer_paths+=("$core")
|
||||
layer_strategies+=("replace")
|
||||
fi
|
||||
@@ -642,12 +837,18 @@ except Exception:
|
||||
# If the top (highest-priority) layer is replace, it wins entirely —
|
||||
# lower layers are irrelevant regardless of their strategies.
|
||||
if [ "${layer_strategies[0]}" = "replace" ]; then
|
||||
cat "${layer_paths[0]}"
|
||||
if ! cat "${layer_paths[0]}"; then
|
||||
echo "Error: failed to read template layer ${layer_paths[0]}" >&2
|
||||
return 2
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
if [ "$has_composition" = false ]; then
|
||||
cat "${layer_paths[0]}"
|
||||
if ! cat "${layer_paths[0]}"; then
|
||||
echo "Error: failed to read template layer ${layer_paths[0]}" >&2
|
||||
return 2
|
||||
fi
|
||||
return 0
|
||||
fi
|
||||
|
||||
@@ -663,12 +864,16 @@ except Exception:
|
||||
done
|
||||
|
||||
if [ $base_idx -lt 0 ]; then
|
||||
return 1 # no base layer found
|
||||
echo "Error: template '$template_name' has composing layers but no replace base" >&2
|
||||
return 2
|
||||
fi
|
||||
|
||||
# Read the base content; compose layers above the base (higher priority)
|
||||
local content
|
||||
content=$(cat "${layer_paths[$base_idx]}"; printf x)
|
||||
if ! content=$(cat "${layer_paths[$base_idx]}"; status=$?; printf x; exit "$status"); then
|
||||
echo "Error: failed to read template layer ${layer_paths[$base_idx]}" >&2
|
||||
return 2
|
||||
fi
|
||||
content="${content%x}"
|
||||
|
||||
for (( i=base_idx-1; i>=0; i-- )); do
|
||||
@@ -676,17 +881,26 @@ except Exception:
|
||||
local strat="${layer_strategies[$i]}"
|
||||
local layer_content
|
||||
# Preserve trailing newlines
|
||||
layer_content=$(cat "$path"; printf x)
|
||||
if ! layer_content=$(cat "$path"; status=$?; printf x; exit "$status"); then
|
||||
echo "Error: failed to read template layer $path" >&2
|
||||
return 2
|
||||
fi
|
||||
layer_content="${layer_content%x}"
|
||||
|
||||
case "$strat" in
|
||||
replace) content="$layer_content" ;;
|
||||
prepend) content="$(printf '%s\n\n%s' "$layer_content" "$content")" ;;
|
||||
append) content="$(printf '%s\n\n%s' "$content" "$layer_content")" ;;
|
||||
prepend)
|
||||
content=$(printf '%s\n\n%s' "$layer_content" "$content"; printf x)
|
||||
content="${content%x}"
|
||||
;;
|
||||
append)
|
||||
content=$(printf '%s\n\n%s' "$content" "$layer_content"; printf x)
|
||||
content="${content%x}"
|
||||
;;
|
||||
wrap)
|
||||
case "$layer_content" in
|
||||
*'{CORE_TEMPLATE}'*) ;;
|
||||
*) echo "Error: wrap strategy missing {CORE_TEMPLATE} placeholder" >&2; return 1 ;;
|
||||
*) echo "Error: wrap strategy missing {CORE_TEMPLATE} placeholder" >&2; return 2 ;;
|
||||
esac
|
||||
while [[ "$layer_content" == *'{CORE_TEMPLATE}'* ]]; do
|
||||
local before="${layer_content%%\{CORE_TEMPLATE\}*}"
|
||||
@@ -695,7 +909,7 @@ except Exception:
|
||||
done
|
||||
content="$layer_content"
|
||||
;;
|
||||
*) echo "Error: unknown strategy '$strat'" >&2; return 1 ;;
|
||||
*) echo "Error: unknown strategy '$strat'" >&2; return 2 ;;
|
||||
esac
|
||||
done
|
||||
|
||||
|
||||
@@ -339,12 +339,27 @@ if [ "$DRY_RUN" != true ]; then
|
||||
exit 1
|
||||
fi
|
||||
|
||||
NEEDS_SPEC=false
|
||||
SPEC_TEMPLATE_FOUND=false
|
||||
SPEC_TEMPLATE_CONTENT=""
|
||||
if [ ! -f "$SPEC_FILE" ]; then
|
||||
NEEDS_SPEC=true
|
||||
if SPEC_TEMPLATE_CONTENT=$(resolve_template_content "spec-template" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
SPEC_TEMPLATE_CONTENT="${SPEC_TEMPLATE_CONTENT%x}"
|
||||
SPEC_TEMPLATE_FOUND=true
|
||||
else
|
||||
resolve_status=$?
|
||||
if [ "$resolve_status" -ne 1 ]; then
|
||||
exit "$resolve_status"
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
mkdir -p "$FEATURE_DIR"
|
||||
|
||||
if [ ! -f "$SPEC_FILE" ]; then
|
||||
TEMPLATE=$(resolve_template "spec-template" "$REPO_ROOT") || true
|
||||
if [ -n "$TEMPLATE" ] && [ -f "$TEMPLATE" ]; then
|
||||
cp "$TEMPLATE" "$SPEC_FILE"
|
||||
if [ "$NEEDS_SPEC" = true ]; then
|
||||
if [ "$SPEC_TEMPLATE_FOUND" = true ]; then
|
||||
printf '%s' "$SPEC_TEMPLATE_CONTENT" > "$SPEC_FILE"
|
||||
else
|
||||
echo "Warning: Spec template not found; created empty spec file" >&2
|
||||
touch "$SPEC_FILE"
|
||||
|
||||
@@ -0,0 +1,57 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
set -e
|
||||
|
||||
SCRIPT_DIR="$(CDPATH="" cd -- "$(dirname -- "${BASH_SOURCE[0]}")" && pwd)"
|
||||
source "$SCRIPT_DIR/common.sh"
|
||||
|
||||
JSON_MODE=false
|
||||
TEMPLATE_NAME=""
|
||||
|
||||
for arg in "$@"; do
|
||||
case "$arg" in
|
||||
--json) JSON_MODE=true ;;
|
||||
--help|-h)
|
||||
echo "Usage: $0 <template-name> [--json]"
|
||||
exit 0
|
||||
;;
|
||||
-*)
|
||||
echo "ERROR: Unknown option '$arg'" >&2
|
||||
exit 1
|
||||
;;
|
||||
*)
|
||||
if [[ -n "$TEMPLATE_NAME" ]]; then
|
||||
echo "ERROR: Unexpected argument '$arg'" >&2
|
||||
exit 1
|
||||
fi
|
||||
TEMPLATE_NAME="$arg"
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
if [[ -z "$TEMPLATE_NAME" ]]; then
|
||||
echo "ERROR: Template name is required" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
REPO_ROOT=$(get_repo_root)
|
||||
if TEMPLATE_CONTENT=$(resolve_template_content "$TEMPLATE_NAME" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
TEMPLATE_CONTENT="${TEMPLATE_CONTENT%x}"
|
||||
else
|
||||
echo "ERROR: Could not resolve required $TEMPLATE_NAME from the template override stack for $REPO_ROOT" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if $JSON_MODE; then
|
||||
if has_jq; then
|
||||
jq -cn \
|
||||
--arg template_name "$TEMPLATE_NAME" \
|
||||
--arg template_content "$TEMPLATE_CONTENT" \
|
||||
'{TEMPLATE_NAME:$template_name,TEMPLATE_CONTENT:$template_content}'
|
||||
else
|
||||
printf '{"TEMPLATE_NAME":"%s","TEMPLATE_CONTENT":"%s"}\n' \
|
||||
"$(json_escape "$TEMPLATE_NAME")" "$(json_escape "$TEMPLATE_CONTENT")"
|
||||
fi
|
||||
else
|
||||
printf '%s' "$TEMPLATE_CONTENT"
|
||||
fi
|
||||
@@ -43,21 +43,23 @@ if [[ -f "$IMPL_PLAN" ]]; then
|
||||
echo "Plan already exists at $IMPL_PLAN, skipping template copy"
|
||||
fi
|
||||
else
|
||||
TEMPLATE=$(resolve_template "plan-template" "$REPO_ROOT") || true
|
||||
if [[ -n "$TEMPLATE" ]] && [[ -f "$TEMPLATE" ]]; then
|
||||
cp "$TEMPLATE" "$IMPL_PLAN"
|
||||
if resolve_template_content "plan-template" "$REPO_ROOT" > "$IMPL_PLAN"; then
|
||||
if $JSON_MODE; then
|
||||
echo "Copied plan template to $IMPL_PLAN" >&2
|
||||
else
|
||||
echo "Copied plan template to $IMPL_PLAN"
|
||||
fi
|
||||
else
|
||||
resolve_status=$?
|
||||
rm -f "$IMPL_PLAN"
|
||||
if [ "$resolve_status" -ne 1 ]; then
|
||||
exit "$resolve_status"
|
||||
fi
|
||||
if $JSON_MODE; then
|
||||
echo "Warning: Plan template not found" >&2
|
||||
else
|
||||
echo "Warning: Plan template not found"
|
||||
fi
|
||||
# Create a basic plan file if template doesn't exist
|
||||
touch "$IMPL_PLAN"
|
||||
fi
|
||||
fi
|
||||
|
||||
@@ -51,7 +51,9 @@ fi
|
||||
|
||||
# Resolve tasks template through override stack
|
||||
TASKS_TEMPLATE=$(resolve_template "tasks-template" "$REPO_ROOT") || true
|
||||
if [[ -z "$TASKS_TEMPLATE" ]] || [[ ! -f "$TASKS_TEMPLATE" ]]; then
|
||||
if TASKS_TEMPLATE_CONTENT=$(resolve_template_content "tasks-template" "$REPO_ROOT"; status=$?; printf x; exit "$status"); then
|
||||
TASKS_TEMPLATE_CONTENT="${TASKS_TEMPLATE_CONTENT%x}"
|
||||
else
|
||||
echo "ERROR: Could not resolve required tasks-template from the template override stack for $REPO_ROOT" >&2
|
||||
echo "Template 'tasks-template' was not found in any supported location (overrides, presets, extensions, or shared core). Add an override at .specify/templates/overrides/tasks-template.md, or run 'specify init' / reinstall shared infra to restore the core .specify/templates/tasks-template.md template." >&2
|
||||
exit 1
|
||||
@@ -69,7 +71,8 @@ if $JSON_MODE; then
|
||||
--arg feature_dir "$FEATURE_DIR" \
|
||||
--argjson docs "$json_docs" \
|
||||
--arg tasks_template "${TASKS_TEMPLATE:-}" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs,TASKS_TEMPLATE:$tasks_template}'
|
||||
--arg tasks_template_content "$TASKS_TEMPLATE_CONTENT" \
|
||||
'{FEATURE_DIR:$feature_dir,AVAILABLE_DOCS:$docs,TASKS_TEMPLATE:$tasks_template,TASKS_TEMPLATE_CONTENT:$tasks_template_content}'
|
||||
else
|
||||
if [[ ${#docs[@]} -eq 0 ]]; then
|
||||
json_docs="[]"
|
||||
@@ -77,8 +80,8 @@ if $JSON_MODE; then
|
||||
json_docs=$(for d in "${docs[@]}"; do printf '"%s",' "$(json_escape "$d")"; done)
|
||||
json_docs="[${json_docs%,}]"
|
||||
fi
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s,"TASKS_TEMPLATE":"%s"}\n' \
|
||||
"$(json_escape "$FEATURE_DIR")" "$json_docs" "$(json_escape "${TASKS_TEMPLATE:-}")"
|
||||
printf '{"FEATURE_DIR":"%s","AVAILABLE_DOCS":%s,"TASKS_TEMPLATE":"%s","TASKS_TEMPLATE_CONTENT":"%s"}\n' \
|
||||
"$(json_escape "$FEATURE_DIR")" "$json_docs" "$(json_escape "${TASKS_TEMPLATE:-}")" "$(json_escape "$TASKS_TEMPLATE_CONTENT")"
|
||||
fi
|
||||
else
|
||||
echo "FEATURE_DIR: $FEATURE_DIR"
|
||||
|
||||
@@ -12,6 +12,7 @@
|
||||
# -RequireTasks Require tasks.md to exist (for implementation phase)
|
||||
# -IncludeTasks Include tasks.md in AVAILABLE_DOCS list
|
||||
# -PathsOnly Only output path variables (no validation)
|
||||
# -Template NAME Include composed template content in JSON output
|
||||
# -Help, -h Show help message
|
||||
|
||||
[CmdletBinding()]
|
||||
@@ -20,6 +21,7 @@ param(
|
||||
[switch]$RequireTasks,
|
||||
[switch]$IncludeTasks,
|
||||
[switch]$PathsOnly,
|
||||
[string]$Template,
|
||||
[switch]$Help
|
||||
)
|
||||
|
||||
@@ -37,6 +39,7 @@ OPTIONS:
|
||||
-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)
|
||||
-Template NAME Include composed template content in JSON output
|
||||
-Help, -h Show this help message
|
||||
|
||||
EXAMPLES:
|
||||
@@ -129,13 +132,26 @@ if ($IncludeTasks -and (Test-Path $paths.TASKS)) {
|
||||
$docs += 'tasks.md'
|
||||
}
|
||||
|
||||
$templateContent = $null
|
||||
if ($Template) {
|
||||
$templateContent = Resolve-TemplateContent -TemplateName $Template -RepoRoot $paths.REPO_ROOT
|
||||
if ($null -eq $templateContent) {
|
||||
[Console]::Error.WriteLine("ERROR: Could not resolve required $Template from the template override stack for $($paths.REPO_ROOT)")
|
||||
exit 1
|
||||
}
|
||||
}
|
||||
|
||||
# Output results
|
||||
if ($Json) {
|
||||
# JSON output
|
||||
[PSCustomObject]@{
|
||||
$result = [ordered]@{
|
||||
FEATURE_DIR = $paths.FEATURE_DIR
|
||||
AVAILABLE_DOCS = $docs
|
||||
} | ConvertTo-Json -Compress
|
||||
}
|
||||
if ($Template) {
|
||||
$result.TEMPLATE_CONTENT = $templateContent
|
||||
}
|
||||
[PSCustomObject]$result | ConvertTo-Json -Compress
|
||||
} else {
|
||||
# Text output
|
||||
Write-Output "FEATURE_DIR:$($paths.FEATURE_DIR)"
|
||||
|
||||
+239
-82
@@ -332,6 +332,82 @@ function Get-Python3Command {
|
||||
return $null
|
||||
}
|
||||
|
||||
function Get-NormalizedPriority {
|
||||
param($Value)
|
||||
|
||||
if ($Value -is [bool]) { return 10 }
|
||||
if ($Value -is [string]) {
|
||||
$integerText = $Value.Trim()
|
||||
if ($integerText -cnotmatch '^[+-]?[0-9]+(?:_[0-9]+)*$') { return 10 }
|
||||
$Value = $integerText.Replace('_', '')
|
||||
}
|
||||
try {
|
||||
$parsedPriority = [System.Numerics.BigInteger]$Value
|
||||
} catch {
|
||||
return 10
|
||||
}
|
||||
return $(if ($parsedPriority -ge 1) { $parsedPriority } else { 10 })
|
||||
}
|
||||
|
||||
function Get-SortedExtensionIds {
|
||||
param([Parameter(Mandatory=$true)][string]$ExtensionsDir)
|
||||
|
||||
$registeredNames = @()
|
||||
$ranked = @()
|
||||
$registryFile = Join-Path $ExtensionsDir '.registry'
|
||||
# Detect any filesystem entry at the registry path without following symlinks.
|
||||
# Test-Path follows links and reports $false for a dangling symlink, so a
|
||||
# broken .registry symlink would otherwise bypass this guard and let the
|
||||
# directory scan below enable every on-disk extension. Enumerating the parent
|
||||
# directory still observes a broken symlink as an entry.
|
||||
$registryEntry = Get-ChildItem -LiteralPath $ExtensionsDir -Force -ErrorAction SilentlyContinue |
|
||||
Where-Object { $_.Name -eq '.registry' } |
|
||||
Select-Object -First 1
|
||||
if ($registryEntry) {
|
||||
if (-not (Test-Path -LiteralPath $registryFile -PathType Leaf)) {
|
||||
throw "Invalid extension registry ${registryFile}: not a regular file"
|
||||
}
|
||||
try {
|
||||
$data = [System.IO.File]::ReadAllText($registryFile, [System.Text.Encoding]::UTF8) | ConvertFrom-Json
|
||||
} catch {
|
||||
throw "Invalid extension registry ${registryFile}: $($_.Exception.Message)"
|
||||
}
|
||||
if ($null -eq $data -or $data -isnot [PSCustomObject]) {
|
||||
throw "Invalid extension registry ${registryFile}: root must be a mapping"
|
||||
}
|
||||
$extensionsProperty = $data.PSObject.Properties['extensions']
|
||||
if ($extensionsProperty) {
|
||||
if ($extensionsProperty.Value -isnot [PSCustomObject]) {
|
||||
throw "Invalid extension registry ${registryFile}: 'extensions' must be a mapping"
|
||||
}
|
||||
$extensions = $extensionsProperty.Value
|
||||
} else {
|
||||
$extensions = [PSCustomObject]@{}
|
||||
}
|
||||
$registeredNames = @($extensions.PSObject.Properties | ForEach-Object { $_.Name })
|
||||
foreach ($entry in $extensions.PSObject.Properties) {
|
||||
if ($entry.Name -cnotmatch '^[a-z0-9-]+$' -or $entry.Value -isnot [PSCustomObject]) {
|
||||
continue
|
||||
}
|
||||
$enabledProperty = $entry.Value.PSObject.Properties['enabled']
|
||||
if ($enabledProperty -and -not [bool]$enabledProperty.Value) { continue }
|
||||
$priority = 10
|
||||
$priorityProperty = $entry.Value.PSObject.Properties['priority']
|
||||
if ($priorityProperty) {
|
||||
$priority = Get-NormalizedPriority -Value $priorityProperty.Value
|
||||
}
|
||||
$ranked += [PSCustomObject]@{ Priority = $priority; Id = $entry.Name }
|
||||
}
|
||||
}
|
||||
|
||||
foreach ($directory in Get-ChildItem -Path $ExtensionsDir -Directory -ErrorAction SilentlyContinue) {
|
||||
if ($directory.Name -cmatch '^[a-z0-9-]+$' -and $directory.Name -cnotin $registeredNames) {
|
||||
$ranked += [PSCustomObject]@{ Priority = 10; Id = $directory.Name }
|
||||
}
|
||||
}
|
||||
return $ranked | Sort-Object Priority, Id | ForEach-Object { $_.Id }
|
||||
}
|
||||
|
||||
# Resolve a template name to a file path using the priority stack:
|
||||
# 1. .specify/templates/overrides/
|
||||
# 2. .specify/presets/<preset-id>/templates/ (sorted by priority from .registry)
|
||||
@@ -343,6 +419,8 @@ function Resolve-Template {
|
||||
[Parameter(Mandatory=$true)][string]$RepoRoot
|
||||
)
|
||||
|
||||
if ($TemplateName -cnotmatch '^[a-z0-9-]+$') { return $null }
|
||||
|
||||
$base = Join-Path $RepoRoot '.specify/templates'
|
||||
|
||||
# Priority 1: Project overrides
|
||||
@@ -357,7 +435,7 @@ function Resolve-Template {
|
||||
$registryParsed = $false
|
||||
if (Test-Path $registryFile) {
|
||||
try {
|
||||
$registryData = Get-Content $registryFile -Raw | ConvertFrom-Json
|
||||
$registryData = [System.IO.File]::ReadAllText($registryFile, [System.Text.Encoding]::UTF8) | ConvertFrom-Json
|
||||
if ($null -eq $registryData -or $registryData -isnot [PSCustomObject]) {
|
||||
throw 'Registry root must be an object'
|
||||
}
|
||||
@@ -372,30 +450,20 @@ function Resolve-Template {
|
||||
param($Entry)
|
||||
if ($Entry.Value -is [PSCustomObject]) {
|
||||
$priorityProperty = $Entry.Value.PSObject.Properties['priority']
|
||||
if ($priorityProperty) { return $priorityProperty.Value }
|
||||
if ($priorityProperty) {
|
||||
return Get-NormalizedPriority -Value $priorityProperty.Value
|
||||
}
|
||||
}
|
||||
return 10
|
||||
}
|
||||
if ($presetEntries.Count -gt 1) {
|
||||
$allNumeric = $true
|
||||
$allStrings = $true
|
||||
foreach ($entry in $presetEntries) {
|
||||
$priority = & $priorityFor $entry
|
||||
if ($null -eq $priority -or $priority -isnot [ValueType]) {
|
||||
$allNumeric = $false
|
||||
}
|
||||
if ($null -eq $priority -or $priority -isnot [string]) {
|
||||
$allStrings = $false
|
||||
}
|
||||
}
|
||||
if (-not $allNumeric -and -not $allStrings) {
|
||||
throw 'Registry priorities are not mutually orderable'
|
||||
}
|
||||
}
|
||||
$sortedPresets = $presetEntries |
|
||||
Where-Object { $_.Value -is [PSCustomObject] } |
|
||||
Where-Object { $null -eq $_.Value.enabled -or $_.Value.enabled -ne $false } |
|
||||
Sort-Object { & $priorityFor $_ } |
|
||||
Where-Object {
|
||||
$enabled = $_.Value.PSObject.Properties['enabled']
|
||||
-not $enabled -or [bool]$enabled.Value
|
||||
} |
|
||||
Where-Object { $_.Name -cmatch '^[a-z0-9-]+$' } |
|
||||
Sort-Object @{ Expression = { & $priorityFor $_ } }, @{ Expression = { $_.Name } } |
|
||||
ForEach-Object { $_.Name }
|
||||
}
|
||||
$registryParsed = $true
|
||||
@@ -408,12 +476,16 @@ function Resolve-Template {
|
||||
foreach ($presetId in $sortedPresets) {
|
||||
$candidate = Join-Path $presetsDir "$presetId/templates/$TemplateName.md"
|
||||
if (Test-Path $candidate) { return $candidate }
|
||||
$candidate = Join-Path $presetsDir "$presetId/$TemplateName.md"
|
||||
if (Test-Path $candidate) { return $candidate }
|
||||
}
|
||||
} else {
|
||||
# Fallback: alphabetical directory order
|
||||
foreach ($preset in Get-ChildItem -Path $presetsDir -Directory -ErrorAction SilentlyContinue | Where-Object { $_.Name -notlike '.*' } | Sort-Object Name) {
|
||||
$candidate = Join-Path $preset.FullName "templates/$TemplateName.md"
|
||||
if (Test-Path $candidate) { return $candidate }
|
||||
$candidate = Join-Path $preset.FullName "$TemplateName.md"
|
||||
if (Test-Path $candidate) { return $candidate }
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -421,8 +493,11 @@ function Resolve-Template {
|
||||
# Priority 3: Extension-provided templates
|
||||
$extDir = Join-Path $RepoRoot '.specify/extensions'
|
||||
if (Test-Path $extDir) {
|
||||
foreach ($ext in Get-ChildItem -Path $extDir -Directory -ErrorAction SilentlyContinue | Where-Object { $_.Name -notlike '.*' } | Sort-Object Name) {
|
||||
$candidate = Join-Path $ext.FullName "templates/$TemplateName.md"
|
||||
foreach ($extensionId in Get-SortedExtensionIds -ExtensionsDir $extDir) {
|
||||
$candidate = Join-Path $extDir "$extensionId/templates/$TemplateName.md"
|
||||
if (-not (Test-Path $candidate)) {
|
||||
$candidate = Join-Path $extDir "$extensionId/$TemplateName.md"
|
||||
}
|
||||
if (Test-Path $candidate) { return $candidate }
|
||||
}
|
||||
}
|
||||
@@ -443,6 +518,10 @@ function Resolve-TemplateContent {
|
||||
[Parameter(Mandatory=$true)][string]$RepoRoot
|
||||
)
|
||||
|
||||
if ($TemplateName -cnotmatch '^[a-z0-9-]+$') {
|
||||
return $null
|
||||
}
|
||||
|
||||
$base = Join-Path $RepoRoot '.specify/templates'
|
||||
|
||||
# Collect all layers (highest priority first)
|
||||
@@ -452,49 +531,77 @@ function Resolve-TemplateContent {
|
||||
# Priority 1: Project overrides (always "replace")
|
||||
$override = Join-Path $base "overrides/$TemplateName.md"
|
||||
if (Test-Path $override) {
|
||||
$layerPaths += $override
|
||||
$layerStrategies += 'replace'
|
||||
return [System.IO.File]::ReadAllText(
|
||||
$override,
|
||||
[System.Text.Encoding]::UTF8
|
||||
)
|
||||
}
|
||||
|
||||
$effectiveBaseFound = $false
|
||||
|
||||
# Priority 2: Installed presets (sorted by priority from .registry)
|
||||
$presetsDir = Join-Path $RepoRoot '.specify/presets'
|
||||
if (Test-Path $presetsDir) {
|
||||
$registryFile = Join-Path $presetsDir '.registry'
|
||||
$sortedPresets = @()
|
||||
$registryParsed = $false
|
||||
if (Test-Path $registryFile) {
|
||||
try {
|
||||
$registryData = Get-Content $registryFile -Raw | ConvertFrom-Json
|
||||
$presets = $registryData.presets
|
||||
if ($presets) {
|
||||
$sortedPresets = $presets.PSObject.Properties |
|
||||
Where-Object { $null -eq $_.Value.enabled -or $_.Value.enabled -ne $false } |
|
||||
Sort-Object { if ($null -ne $_.Value.priority) { $_.Value.priority } else { 10 } } |
|
||||
$registryData = [System.IO.File]::ReadAllText($registryFile, [System.Text.Encoding]::UTF8) | ConvertFrom-Json
|
||||
if ($null -eq $registryData -or $registryData -isnot [PSCustomObject]) {
|
||||
throw 'Registry root must be an object'
|
||||
}
|
||||
$presetsProperty = $registryData.PSObject.Properties['presets']
|
||||
if ($presetsProperty) {
|
||||
$presets = $presetsProperty.Value
|
||||
if ($null -eq $presets -or $presets -isnot [PSCustomObject]) {
|
||||
throw 'Registry presets must be an object'
|
||||
}
|
||||
$presetEntries = @($presets.PSObject.Properties)
|
||||
$priorityFor = {
|
||||
param($Entry)
|
||||
if ($Entry.Value -is [PSCustomObject]) {
|
||||
$priorityProperty = $Entry.Value.PSObject.Properties['priority']
|
||||
if ($priorityProperty) {
|
||||
return Get-NormalizedPriority -Value $priorityProperty.Value
|
||||
}
|
||||
}
|
||||
return 10
|
||||
}
|
||||
$sortedPresets = $presetEntries |
|
||||
Where-Object { $_.Value -is [PSCustomObject] } |
|
||||
Where-Object {
|
||||
$enabled = $_.Value.PSObject.Properties['enabled']
|
||||
-not $enabled -or [bool]$enabled.Value
|
||||
} |
|
||||
Where-Object { $_.Name -cmatch '^[a-z0-9-]+$' } |
|
||||
Sort-Object @{ Expression = { & $priorityFor $_ } }, @{ Expression = { $_.Name } } |
|
||||
ForEach-Object { $_.Name }
|
||||
}
|
||||
$registryParsed = $true
|
||||
} catch {
|
||||
$sortedPresets = @()
|
||||
$registryParsed = $false
|
||||
}
|
||||
}
|
||||
|
||||
if ($sortedPresets.Count -gt 0) {
|
||||
$pyCmd = Get-Python3Command
|
||||
if (-not $pyCmd) {
|
||||
# Check if any preset has strategy fields that would be ignored
|
||||
foreach ($pid in $sortedPresets) {
|
||||
$mf = Join-Path $presetsDir "$pid/preset.yml"
|
||||
if ((Test-Path $mf) -and (Select-String -Path $mf -Pattern 'strategy:' -Quiet -ErrorAction SilentlyContinue)) {
|
||||
Write-Warning "No Python 3 found; preset composition strategies will be ignored"
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
$yamlWarned = $false
|
||||
foreach ($presetId in $sortedPresets) {
|
||||
if (-not $registryParsed) {
|
||||
$sortedPresets = Get-ChildItem -Path $presetsDir -Directory -ErrorAction SilentlyContinue |
|
||||
Where-Object { $_.Name -cmatch '^[a-z0-9-]+$' } |
|
||||
Sort-Object Name |
|
||||
ForEach-Object { $_.Name }
|
||||
}
|
||||
|
||||
$pyCmd = @(Get-Python3Command)
|
||||
foreach ($presetId in $sortedPresets) {
|
||||
# Read strategy and file path from preset manifest
|
||||
$strategy = 'replace'
|
||||
$manifestFilePath = ''
|
||||
$manifestDeclared = $false
|
||||
$manifest = Join-Path $presetsDir "$presetId/preset.yml"
|
||||
if ((Test-Path $manifest) -and $pyCmd) {
|
||||
if ((Test-Path $manifest) -and -not $pyCmd) {
|
||||
throw "Python 3 and PyYAML are required to resolve preset template composition"
|
||||
}
|
||||
if (Test-Path $manifest) {
|
||||
try {
|
||||
# Use Python to parse YAML manifest for strategy and file path
|
||||
$pyArgs = if ($pyCmd.Count -gt 1) { $pyCmd[1..($pyCmd.Count-1)] } else { @() }
|
||||
@@ -505,32 +612,71 @@ try:
|
||||
import yaml
|
||||
except ImportError:
|
||||
print('yaml_missing', file=sys.stderr)
|
||||
print('replace\t')
|
||||
sys.exit(0)
|
||||
sys.exit(2)
|
||||
try:
|
||||
with open(sys.argv[1]) as f:
|
||||
with open(sys.argv[1], encoding='utf-8') as f:
|
||||
data = yaml.safe_load(f)
|
||||
for t in data.get('provides', {}).get('templates', []):
|
||||
if not isinstance(data, dict):
|
||||
raise ValueError('manifest root must be a mapping')
|
||||
if 'provides' not in data:
|
||||
raise ValueError('manifest missing provides section')
|
||||
provides = data['provides']
|
||||
if not isinstance(provides, dict):
|
||||
raise ValueError('manifest provides must be a mapping')
|
||||
if 'templates' not in provides:
|
||||
raise ValueError('manifest provides missing templates')
|
||||
templates = provides['templates']
|
||||
if not isinstance(templates, list):
|
||||
raise ValueError('manifest templates must be a list')
|
||||
if not templates:
|
||||
raise ValueError('manifest must provide at least one template')
|
||||
valid_types = ('template', 'command', 'script')
|
||||
valid_strategies = ('replace', 'prepend', 'append', 'wrap')
|
||||
for t in templates:
|
||||
if not isinstance(t, dict):
|
||||
raise ValueError('manifest template entries must be mappings')
|
||||
if 'type' not in t or 'name' not in t or 'file' not in t:
|
||||
raise ValueError('manifest template entry missing type, name, or file')
|
||||
for field in ('type', 'name', 'file'):
|
||||
if not isinstance(t[field], str):
|
||||
raise ValueError('manifest template ' + field + ' must be a string')
|
||||
if t['type'] not in valid_types:
|
||||
raise ValueError('invalid manifest template type')
|
||||
strategy = t.get('strategy', 'replace')
|
||||
if not isinstance(strategy, str):
|
||||
raise ValueError('manifest template strategy must be a string')
|
||||
strategy = strategy.lower()
|
||||
if strategy not in valid_strategies:
|
||||
raise ValueError('invalid manifest template strategy')
|
||||
if t['type'] == 'script' and strategy not in ('replace', 'wrap'):
|
||||
raise ValueError('invalid manifest script strategy')
|
||||
for t in templates:
|
||||
if t.get('name') == sys.argv[2] and t.get('type', 'template') == 'template':
|
||||
print(t.get('strategy', 'replace') + '\t' + t.get('file', ''))
|
||||
file_value = t.get('file', '')
|
||||
strategy = t.get('strategy', 'replace')
|
||||
print('found\t' + strategy + '\t' + file_value)
|
||||
sys.exit(0)
|
||||
print('replace\t')
|
||||
except Exception:
|
||||
print('replace\t')
|
||||
print('absent\treplace\t')
|
||||
except Exception as exc:
|
||||
print(f'manifest_invalid: {exc}', file=sys.stderr)
|
||||
sys.exit(3)
|
||||
"@ $manifest $TemplateName 2>$pyStderrFile
|
||||
if ($LASTEXITCODE -ne 0) {
|
||||
if ($LASTEXITCODE -eq 2) {
|
||||
throw "PyYAML is required to resolve preset template composition"
|
||||
}
|
||||
throw "Invalid preset manifest $manifest"
|
||||
}
|
||||
if ($stratResult) {
|
||||
$parts = $stratResult.Trim() -split "`t", 2
|
||||
$strategy = $parts[0].ToLowerInvariant()
|
||||
if ($parts.Count -gt 1 -and $parts[1]) { $manifestFilePath = $parts[1] }
|
||||
}
|
||||
if (-not $yamlWarned -and (Test-Path $pyStderrFile) -and (Get-Content $pyStderrFile -Raw -ErrorAction SilentlyContinue) -match 'yaml_missing') {
|
||||
Write-Warning "PyYAML not available; composition strategies may be ignored"
|
||||
$yamlWarned = $true
|
||||
$parts = $stratResult.Trim() -split "`t", 3
|
||||
$manifestDeclared = $parts[0] -eq 'found'
|
||||
$strategy = $parts[1].ToLowerInvariant()
|
||||
if ($parts.Count -gt 2 -and $parts[2]) { $manifestFilePath = $parts[2] }
|
||||
}
|
||||
Remove-Item $pyStderrFile -Force -ErrorAction SilentlyContinue
|
||||
} catch {
|
||||
$strategy = 'replace'
|
||||
if ($pyStderrFile) { Remove-Item $pyStderrFile -Force -ErrorAction SilentlyContinue }
|
||||
throw
|
||||
}
|
||||
}
|
||||
# Try manifest file path first, then convention path
|
||||
@@ -545,42 +691,45 @@ except Exception:
|
||||
$mf = Join-Path $presetsDir "$presetId/$manifestFilePath"
|
||||
if (Test-Path $mf) { $candidate = $mf }
|
||||
}
|
||||
if (-not $candidate) {
|
||||
if (-not $candidate -and -not $manifestDeclared) {
|
||||
$cf = Join-Path $presetsDir "$presetId/templates/$TemplateName.md"
|
||||
if (Test-Path $cf) { $candidate = $cf }
|
||||
if (-not $candidate) {
|
||||
$cf = Join-Path $presetsDir "$presetId/$TemplateName.md"
|
||||
if (Test-Path $cf) { $candidate = $cf }
|
||||
}
|
||||
}
|
||||
if ($candidate) {
|
||||
$layerPaths += $candidate
|
||||
$layerStrategies += $strategy
|
||||
if ($strategy -eq 'replace') {
|
||||
$effectiveBaseFound = $true
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
} else {
|
||||
# Fallback: alphabetical directory order (no registry or parse failure)
|
||||
foreach ($preset in Get-ChildItem -Path $presetsDir -Directory -ErrorAction SilentlyContinue | Where-Object { $_.Name -notlike '.*' }) {
|
||||
$candidate = Join-Path $preset.FullName "templates/$TemplateName.md"
|
||||
if (Test-Path $candidate) {
|
||||
$layerPaths += $candidate
|
||||
$layerStrategies += 'replace'
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Priority 3: Extension-provided templates (always "replace")
|
||||
$extDir = Join-Path $RepoRoot '.specify/extensions'
|
||||
if (Test-Path $extDir) {
|
||||
foreach ($ext in Get-ChildItem -Path $extDir -Directory -ErrorAction SilentlyContinue | Where-Object { $_.Name -notlike '.*' } | Sort-Object Name) {
|
||||
$candidate = Join-Path $ext.FullName "templates/$TemplateName.md"
|
||||
if (-not $effectiveBaseFound -and (Test-Path $extDir)) {
|
||||
foreach ($extensionId in Get-SortedExtensionIds -ExtensionsDir $extDir) {
|
||||
$candidate = Join-Path $extDir "$extensionId/templates/$TemplateName.md"
|
||||
if (-not (Test-Path $candidate)) {
|
||||
$candidate = Join-Path $extDir "$extensionId/$TemplateName.md"
|
||||
}
|
||||
if (Test-Path $candidate) {
|
||||
$layerPaths += $candidate
|
||||
$layerStrategies += 'replace'
|
||||
$effectiveBaseFound = $true
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
# Priority 4: Core templates (always "replace")
|
||||
$core = Join-Path $base "$TemplateName.md"
|
||||
if (Test-Path $core) {
|
||||
if (-not $effectiveBaseFound -and (Test-Path $core)) {
|
||||
$layerPaths += $core
|
||||
$layerStrategies += 'replace'
|
||||
}
|
||||
@@ -590,7 +739,7 @@ except Exception:
|
||||
# If the top (highest-priority) layer is replace, it wins entirely --
|
||||
# lower layers are irrelevant regardless of their strategies.
|
||||
if ($layerStrategies[0] -eq 'replace') {
|
||||
return (Get-Content $layerPaths[0] -Raw)
|
||||
return [System.IO.File]::ReadAllText($layerPaths[0], [System.Text.Encoding]::UTF8)
|
||||
}
|
||||
|
||||
# Check if any layer uses a non-replace strategy
|
||||
@@ -600,7 +749,7 @@ except Exception:
|
||||
}
|
||||
|
||||
if (-not $hasComposition) {
|
||||
return (Get-Content $layerPaths[0] -Raw)
|
||||
return [System.IO.File]::ReadAllText($layerPaths[0], [System.Text.Encoding]::UTF8)
|
||||
}
|
||||
|
||||
# Find the effective base: scan from highest priority (index 0) downward
|
||||
@@ -612,14 +761,22 @@ except Exception:
|
||||
break
|
||||
}
|
||||
}
|
||||
if ($baseIdx -lt 0) { return $null }
|
||||
if ($baseIdx -lt 0) {
|
||||
throw "Template '$TemplateName' has composing layers but no replace base"
|
||||
}
|
||||
|
||||
$content = Get-Content $layerPaths[$baseIdx] -Raw
|
||||
$content = [System.IO.File]::ReadAllText(
|
||||
$layerPaths[$baseIdx],
|
||||
[System.Text.Encoding]::UTF8
|
||||
)
|
||||
|
||||
for ($i = $baseIdx - 1; $i -ge 0; $i--) {
|
||||
$path = $layerPaths[$i]
|
||||
$strat = $layerStrategies[$i]
|
||||
$layerContent = Get-Content $path -Raw
|
||||
$layerContent = [System.IO.File]::ReadAllText(
|
||||
$path,
|
||||
[System.Text.Encoding]::UTF8
|
||||
)
|
||||
|
||||
switch ($strat) {
|
||||
'replace' { $content = $layerContent }
|
||||
|
||||
@@ -262,13 +262,16 @@ if (-not $DryRun) {
|
||||
exit 1
|
||||
}
|
||||
|
||||
$needsSpec = -not (Test-Path -PathType Leaf $specFile)
|
||||
$content = $null
|
||||
if ($needsSpec) {
|
||||
$content = Resolve-TemplateContent -TemplateName 'spec-template' -RepoRoot $repoRoot
|
||||
}
|
||||
|
||||
New-Item -ItemType Directory -Path $featureDir -Force | Out-Null
|
||||
|
||||
if (-not (Test-Path -PathType Leaf $specFile)) {
|
||||
$template = Resolve-Template -TemplateName 'spec-template' -RepoRoot $repoRoot
|
||||
if ($template -and (Test-Path $template)) {
|
||||
# Read the template content and write it to the spec file with UTF-8 encoding without BOM
|
||||
$content = [System.IO.File]::ReadAllText($template)
|
||||
if ($needsSpec) {
|
||||
if ($null -ne $content) {
|
||||
$utf8NoBom = New-Object System.Text.UTF8Encoding($false)
|
||||
[System.IO.File]::WriteAllText($specFile, $content, $utf8NoBom)
|
||||
} else {
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
#!/usr/bin/env pwsh
|
||||
|
||||
param(
|
||||
[Parameter(Position=0)]
|
||||
[string]$TemplateName,
|
||||
[switch]$Json,
|
||||
[switch]$Help
|
||||
)
|
||||
|
||||
$ErrorActionPreference = 'Stop'
|
||||
|
||||
if ($Help) {
|
||||
Write-Output "Usage: resolve-template.ps1 <template-name> [-Json]"
|
||||
exit 0
|
||||
}
|
||||
|
||||
if (-not $TemplateName) {
|
||||
[Console]::Error.WriteLine("ERROR: Template name is required")
|
||||
exit 1
|
||||
}
|
||||
|
||||
. "$PSScriptRoot/common.ps1"
|
||||
|
||||
$repoRoot = Get-RepoRoot
|
||||
$templateContent = Resolve-TemplateContent -TemplateName $TemplateName -RepoRoot $repoRoot
|
||||
if ($null -eq $templateContent) {
|
||||
[Console]::Error.WriteLine("ERROR: Could not resolve required $TemplateName from the template override stack for $repoRoot")
|
||||
exit 1
|
||||
}
|
||||
|
||||
if ($Json) {
|
||||
[PSCustomObject]@{
|
||||
TEMPLATE_NAME = $TemplateName
|
||||
TEMPLATE_CONTENT = $templateContent
|
||||
} | ConvertTo-Json -Compress
|
||||
} else {
|
||||
[Console]::Out.Write($templateContent)
|
||||
}
|
||||
@@ -41,10 +41,8 @@ if (Test-Path $paths.IMPL_PLAN -PathType Leaf) {
|
||||
Write-Output "Plan already exists at $($paths.IMPL_PLAN), skipping template copy"
|
||||
}
|
||||
} else {
|
||||
$template = Resolve-Template -TemplateName 'plan-template' -RepoRoot $paths.REPO_ROOT
|
||||
if ($template -and (Test-Path $template)) {
|
||||
# Read the template content and write it to the implementation plan file with UTF-8 encoding without BOM
|
||||
$content = [System.IO.File]::ReadAllText($template)
|
||||
$content = Resolve-TemplateContent -TemplateName 'plan-template' -RepoRoot $paths.REPO_ROOT
|
||||
if ($null -ne $content) {
|
||||
$utf8NoBom = New-Object System.Text.UTF8Encoding($false)
|
||||
[System.IO.File]::WriteAllText($paths.IMPL_PLAN, $content, $utf8NoBom)
|
||||
# Emit the copy status like the bash twin (setup-plan.sh); route to stderr
|
||||
|
||||
@@ -57,12 +57,17 @@ if (Test-Path $paths.QUICKSTART) { $docs += 'quickstart.md' }
|
||||
|
||||
# Resolve tasks template through override stack
|
||||
$tasksTemplate = Resolve-Template -TemplateName 'tasks-template' -RepoRoot $paths.REPO_ROOT
|
||||
if (-not $tasksTemplate -or -not (Test-Path -LiteralPath $tasksTemplate -PathType Leaf)) {
|
||||
$tasksTemplateContent = Resolve-TemplateContent -TemplateName 'tasks-template' -RepoRoot $paths.REPO_ROOT
|
||||
if ($null -eq $tasksTemplateContent) {
|
||||
[Console]::Error.WriteLine("ERROR: Could not resolve required tasks-template from the template override stack for $($paths.REPO_ROOT)")
|
||||
[Console]::Error.WriteLine("Template 'tasks-template' was not found in any supported location (overrides, presets, extensions, or shared core). Add an override at .specify/templates/overrides/tasks-template.md, or run 'specify init' / reinstall shared infra to restore the core .specify/templates/tasks-template.md template.")
|
||||
exit 1
|
||||
}
|
||||
$tasksTemplate = (Resolve-Path -LiteralPath $tasksTemplate).Path
|
||||
if ($tasksTemplate -and (Test-Path -LiteralPath $tasksTemplate -PathType Leaf)) {
|
||||
$tasksTemplate = (Resolve-Path -LiteralPath $tasksTemplate).Path
|
||||
} else {
|
||||
$tasksTemplate = ''
|
||||
}
|
||||
|
||||
# Output results
|
||||
if ($Json) {
|
||||
@@ -70,6 +75,7 @@ if ($Json) {
|
||||
FEATURE_DIR = $paths.FEATURE_DIR
|
||||
AVAILABLE_DOCS = $docs
|
||||
TASKS_TEMPLATE = $tasksTemplate
|
||||
TASKS_TEMPLATE_CONTENT = $tasksTemplateContent
|
||||
} | ConvertTo-Json -Compress
|
||||
} else {
|
||||
Write-Output "FEATURE_DIR: $($paths.FEATURE_DIR)"
|
||||
|
||||
@@ -9,10 +9,22 @@ from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
try:
|
||||
from common import FeaturePaths, format_speckit_command, get_feature_paths
|
||||
from common import (
|
||||
FeaturePaths,
|
||||
TemplateResolutionError,
|
||||
format_speckit_command,
|
||||
get_feature_paths,
|
||||
resolve_template_content,
|
||||
)
|
||||
except ImportError: # pragma: no cover - direct execution from unusual cwd
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
from common import FeaturePaths, format_speckit_command, get_feature_paths
|
||||
from common import (
|
||||
FeaturePaths,
|
||||
TemplateResolutionError,
|
||||
format_speckit_command,
|
||||
get_feature_paths,
|
||||
resolve_template_content,
|
||||
)
|
||||
|
||||
|
||||
def _json_line(payload: object) -> str:
|
||||
@@ -28,6 +40,7 @@ OPTIONS:
|
||||
--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)
|
||||
--template NAME Include composed template content in JSON output
|
||||
--help, -h Show this help message
|
||||
|
||||
EXAMPLES:
|
||||
@@ -49,6 +62,7 @@ class Args:
|
||||
require_tasks: bool = False
|
||||
include_tasks: bool = False
|
||||
paths_only: bool = False
|
||||
template_name: str | None = None
|
||||
|
||||
|
||||
def _parse_args(argv: list[str]) -> Args:
|
||||
@@ -56,8 +70,11 @@ def _parse_args(argv: list[str]) -> Args:
|
||||
require_tasks = False
|
||||
include_tasks = False
|
||||
paths_only = False
|
||||
template_name = None
|
||||
|
||||
for arg in argv:
|
||||
index = 0
|
||||
while index < len(argv):
|
||||
arg = argv[index]
|
||||
if arg == "--json":
|
||||
json_mode = True
|
||||
elif arg == "--require-tasks":
|
||||
@@ -66,6 +83,15 @@ def _parse_args(argv: list[str]) -> Args:
|
||||
include_tasks = True
|
||||
elif arg == "--paths-only":
|
||||
paths_only = True
|
||||
elif arg == "--template":
|
||||
index += 1
|
||||
if index >= len(argv):
|
||||
print(
|
||||
"ERROR: --template requires a template name",
|
||||
file=sys.stderr,
|
||||
)
|
||||
raise SystemExit(1)
|
||||
template_name = argv[index]
|
||||
elif arg in {"--help", "-h"}:
|
||||
sys.stdout.write(HELP_TEXT)
|
||||
raise SystemExit(0)
|
||||
@@ -75,12 +101,14 @@ def _parse_args(argv: list[str]) -> Args:
|
||||
file=sys.stderr,
|
||||
)
|
||||
raise SystemExit(1)
|
||||
index += 1
|
||||
|
||||
return Args(
|
||||
json_mode=json_mode,
|
||||
require_tasks=require_tasks,
|
||||
include_tasks=include_tasks,
|
||||
paths_only=paths_only,
|
||||
template_name=template_name,
|
||||
)
|
||||
|
||||
|
||||
@@ -211,9 +239,32 @@ def main(argv: list[str] | None = None) -> int:
|
||||
return 1
|
||||
|
||||
docs = _available_docs(paths, args.include_tasks)
|
||||
template_content = None
|
||||
if args.template_name:
|
||||
try:
|
||||
template_content = resolve_template_content(
|
||||
args.template_name, paths.repo_root
|
||||
)
|
||||
except TemplateResolutionError as exc:
|
||||
print(f"ERROR: {exc}", file=sys.stderr)
|
||||
return 1
|
||||
if template_content is None:
|
||||
print(
|
||||
f"ERROR: Could not resolve required {args.template_name} from "
|
||||
f"the template override stack for {paths.repo_root}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 1
|
||||
|
||||
if args.json_mode:
|
||||
payload: dict[str, object] = {
|
||||
"FEATURE_DIR": str(paths.feature_dir),
|
||||
"AVAILABLE_DOCS": docs,
|
||||
}
|
||||
if args.template_name:
|
||||
payload["TEMPLATE_CONTENT"] = template_content
|
||||
sys.stdout.write(
|
||||
_json_line({"FEATURE_DIR": str(paths.feature_dir), "AVAILABLE_DOCS": docs})
|
||||
_json_line(payload)
|
||||
)
|
||||
else:
|
||||
_print_text_results(paths, args.include_tasks)
|
||||
|
||||
+280
-19
@@ -4,6 +4,7 @@ from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import re
|
||||
import sys
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
@@ -182,12 +183,30 @@ def get_feature_paths(
|
||||
)
|
||||
|
||||
|
||||
_SAFE_COMPONENT_PATTERN = re.compile(r"[a-z0-9-]+")
|
||||
|
||||
|
||||
def _is_safe_component(value: object) -> bool:
|
||||
return (
|
||||
isinstance(value, str)
|
||||
and _SAFE_COMPONENT_PATTERN.fullmatch(value) is not None
|
||||
)
|
||||
|
||||
|
||||
def _normalize_priority(value: object) -> int:
|
||||
if isinstance(value, bool):
|
||||
return 10
|
||||
try:
|
||||
priority = int(value)
|
||||
except (TypeError, ValueError, OverflowError):
|
||||
return 10
|
||||
return priority if priority >= 1 else 10
|
||||
|
||||
|
||||
def _sorted_preset_ids(presets_dir: Path) -> list[str]:
|
||||
registry = presets_dir / ".registry"
|
||||
if registry.is_file():
|
||||
# Mirrors bash: any failure while reading or sorting the registry
|
||||
# (invalid JSON, non-dict shapes, unorderable priority values) falls
|
||||
# back to the directory scan below.
|
||||
# Invalid JSON or registry shapes fall back to the directory scan below.
|
||||
try:
|
||||
data = json.loads(registry.read_text(encoding="utf-8"))
|
||||
presets = data.get("presets", {})
|
||||
@@ -195,11 +214,18 @@ def _sorted_preset_ids(presets_dir: Path) -> list[str]:
|
||||
pid
|
||||
for pid, meta in sorted(
|
||||
presets.items(),
|
||||
key=lambda kv: kv[1].get("priority", 10)
|
||||
if isinstance(kv[1], dict)
|
||||
else 10,
|
||||
key=lambda kv: (
|
||||
_normalize_priority(kv[1].get("priority"))
|
||||
if isinstance(kv[1], dict)
|
||||
else 10,
|
||||
kv[0],
|
||||
),
|
||||
)
|
||||
if (
|
||||
_is_safe_component(pid)
|
||||
and isinstance(meta, dict)
|
||||
and bool(meta.get("enabled", True))
|
||||
)
|
||||
if isinstance(meta, dict) and meta.get("enabled", True) is not False
|
||||
]
|
||||
except Exception:
|
||||
pass
|
||||
@@ -207,12 +233,78 @@ def _sorted_preset_ids(presets_dir: Path) -> list[str]:
|
||||
return sorted(
|
||||
p.name
|
||||
for p in presets_dir.iterdir()
|
||||
if p.is_dir() and not p.name.startswith(".")
|
||||
if p.is_dir() and _is_safe_component(p.name)
|
||||
)
|
||||
except OSError:
|
||||
return []
|
||||
|
||||
|
||||
def _sorted_extension_ids(extensions_dir: Path) -> list[str]:
|
||||
registry = extensions_dir / ".registry"
|
||||
registered_ids: set[str] = set()
|
||||
extensions: dict[object, object] = {}
|
||||
if os.path.lexists(registry):
|
||||
if not registry.is_file():
|
||||
raise TemplateResolutionError(
|
||||
f"Invalid extension registry {registry}: not a regular file"
|
||||
)
|
||||
try:
|
||||
data = json.loads(registry.read_text(encoding="utf-8"))
|
||||
except (OSError, UnicodeError, json.JSONDecodeError) as exc:
|
||||
raise TemplateResolutionError(
|
||||
f"Failed to parse extension registry {registry}: {exc}"
|
||||
) from exc
|
||||
if not isinstance(data, dict):
|
||||
raise TemplateResolutionError(
|
||||
f"Invalid extension registry {registry}: root must be a mapping"
|
||||
)
|
||||
raw_extensions = data.get("extensions", {})
|
||||
if not isinstance(raw_extensions, dict):
|
||||
raise TemplateResolutionError(
|
||||
f"Invalid extension registry {registry}: "
|
||||
"'extensions' must be a mapping"
|
||||
)
|
||||
extensions = raw_extensions
|
||||
registered_ids = {
|
||||
ext_id for ext_id in extensions if isinstance(ext_id, str)
|
||||
}
|
||||
|
||||
ranked: list[tuple[int, str]] = []
|
||||
for ext_id, metadata in extensions.items():
|
||||
if (
|
||||
_is_safe_component(ext_id)
|
||||
and isinstance(metadata, dict)
|
||||
and bool(metadata.get("enabled", True))
|
||||
):
|
||||
ranked.append((_normalize_priority(metadata.get("priority")), ext_id))
|
||||
|
||||
try:
|
||||
ranked.extend(
|
||||
(10, path.name)
|
||||
for path in extensions_dir.iterdir()
|
||||
if (
|
||||
path.is_dir()
|
||||
and _is_safe_component(path.name)
|
||||
and path.name not in registered_ids
|
||||
)
|
||||
)
|
||||
except OSError:
|
||||
pass
|
||||
return [ext_id for _, ext_id in sorted(ranked)]
|
||||
|
||||
|
||||
def _conventional_template(
|
||||
base_dir: Path, template_name: str
|
||||
) -> Path | None:
|
||||
for candidate in (
|
||||
base_dir / "templates" / f"{template_name}.md",
|
||||
base_dir / f"{template_name}.md",
|
||||
):
|
||||
if candidate.is_file():
|
||||
return candidate
|
||||
return None
|
||||
|
||||
|
||||
def resolve_template(template_name: str, repo_root: Path) -> Path | None:
|
||||
"""Resolve a template name to a file path using the priority stack.
|
||||
|
||||
@@ -222,6 +314,9 @@ def resolve_template(template_name: str, repo_root: Path) -> Path | None:
|
||||
3. .specify/extensions/<ext-id>/templates/ (hidden directories skipped)
|
||||
4. .specify/templates/ (core)
|
||||
"""
|
||||
if not _is_safe_component(template_name):
|
||||
return None
|
||||
|
||||
base = repo_root / ".specify" / "templates"
|
||||
|
||||
override = base / "overrides" / f"{template_name}.md"
|
||||
@@ -231,21 +326,18 @@ def resolve_template(template_name: str, repo_root: Path) -> Path | None:
|
||||
presets_dir = repo_root / ".specify" / "presets"
|
||||
if presets_dir.is_dir():
|
||||
for preset_id in _sorted_preset_ids(presets_dir):
|
||||
candidate = presets_dir / preset_id / "templates" / f"{template_name}.md"
|
||||
if candidate.is_file():
|
||||
candidate = _conventional_template(
|
||||
presets_dir / preset_id, template_name
|
||||
)
|
||||
if candidate is not None:
|
||||
return candidate
|
||||
|
||||
ext_dir = repo_root / ".specify" / "extensions"
|
||||
if ext_dir.is_dir():
|
||||
try:
|
||||
extensions = sorted(p for p in ext_dir.iterdir() if p.is_dir())
|
||||
except OSError:
|
||||
extensions = []
|
||||
for ext in extensions:
|
||||
if ext.name.startswith("."):
|
||||
continue
|
||||
candidate = ext / "templates" / f"{template_name}.md"
|
||||
if candidate.is_file():
|
||||
for extension_id in _sorted_extension_ids(ext_dir):
|
||||
ext = ext_dir / extension_id
|
||||
candidate = _conventional_template(ext, template_name)
|
||||
if candidate is not None:
|
||||
return candidate
|
||||
|
||||
core = base / f"{template_name}.md"
|
||||
@@ -254,6 +346,175 @@ def resolve_template(template_name: str, repo_root: Path) -> Path | None:
|
||||
return None
|
||||
|
||||
|
||||
class TemplateResolutionError(RuntimeError):
|
||||
"""Raised when template layers exist but cannot be composed safely."""
|
||||
|
||||
|
||||
# Mirror the canonical PresetManifest contract (see src/specify_cli/presets)
|
||||
# so runtime resolution rejects the same structurally malformed manifests.
|
||||
_VALID_TEMPLATE_TYPES = ("template", "command", "script")
|
||||
_VALID_TEMPLATE_STRATEGIES = ("replace", "prepend", "append", "wrap")
|
||||
_VALID_SCRIPT_STRATEGIES = ("replace", "wrap")
|
||||
|
||||
|
||||
def _validate_manifest_template_entry(entry: object) -> None:
|
||||
"""Validate a single manifest template entry against the canonical rules."""
|
||||
if not isinstance(entry, dict):
|
||||
raise ValueError("manifest template entries must be mappings")
|
||||
if "type" not in entry or "name" not in entry or "file" not in entry:
|
||||
raise ValueError("manifest template entry missing type, name, or file")
|
||||
for field in ("type", "name", "file"):
|
||||
if not isinstance(entry[field], str):
|
||||
raise ValueError(f"manifest template {field} must be a string")
|
||||
if entry["type"] not in _VALID_TEMPLATE_TYPES:
|
||||
raise ValueError(f"invalid manifest template type '{entry['type']}'")
|
||||
strategy = entry.get("strategy", "replace")
|
||||
if not isinstance(strategy, str):
|
||||
raise ValueError("manifest template strategy must be a string")
|
||||
strategy = strategy.lower()
|
||||
if strategy not in _VALID_TEMPLATE_STRATEGIES:
|
||||
raise ValueError(f"invalid manifest template strategy '{strategy}'")
|
||||
if entry["type"] == "script" and strategy not in _VALID_SCRIPT_STRATEGIES:
|
||||
raise ValueError(
|
||||
f"invalid manifest script strategy '{strategy}'"
|
||||
)
|
||||
|
||||
|
||||
def _preset_template_layer(
|
||||
preset_dir: Path, template_name: str
|
||||
) -> tuple[Path, str] | None:
|
||||
"""Return the preset template path and composition strategy."""
|
||||
manifest_path = preset_dir / "preset.yml"
|
||||
conventional = _conventional_template(preset_dir, template_name)
|
||||
|
||||
try:
|
||||
import yaml
|
||||
except ImportError as exc:
|
||||
if manifest_path.is_file():
|
||||
raise TemplateResolutionError(
|
||||
"PyYAML is required to resolve preset template composition"
|
||||
) from exc
|
||||
return (conventional, "replace") if conventional is not None else None
|
||||
|
||||
if manifest_path.is_file():
|
||||
try:
|
||||
manifest = yaml.safe_load(manifest_path.read_text(encoding="utf-8"))
|
||||
if not isinstance(manifest, dict):
|
||||
raise ValueError("manifest root must be a mapping")
|
||||
if "provides" not in manifest:
|
||||
raise ValueError("manifest missing provides section")
|
||||
provides = manifest["provides"]
|
||||
if not isinstance(provides, dict):
|
||||
raise ValueError("manifest provides must be a mapping")
|
||||
if "templates" not in provides:
|
||||
raise ValueError("manifest provides missing templates")
|
||||
templates = provides["templates"]
|
||||
if not isinstance(templates, list):
|
||||
raise ValueError("manifest templates must be a list")
|
||||
if not templates:
|
||||
raise ValueError("manifest must provide at least one template")
|
||||
for entry in templates:
|
||||
_validate_manifest_template_entry(entry)
|
||||
for entry in templates:
|
||||
if (
|
||||
entry.get("name") != template_name
|
||||
or entry.get("type", "template") != "template"
|
||||
):
|
||||
continue
|
||||
file_value = entry.get("file", "")
|
||||
strategy = entry.get("strategy", "replace")
|
||||
relative = Path(file_value)
|
||||
if (
|
||||
not relative
|
||||
or relative.is_absolute()
|
||||
or ".." in relative.parts
|
||||
):
|
||||
return None
|
||||
candidate = preset_dir / relative
|
||||
if not candidate.is_file():
|
||||
return None
|
||||
return candidate, strategy.lower()
|
||||
except (OSError, UnicodeError, ValueError, yaml.YAMLError) as exc:
|
||||
raise TemplateResolutionError(
|
||||
f"Failed to parse preset manifest {manifest_path}: {exc}"
|
||||
) from exc
|
||||
|
||||
return (conventional, "replace") if conventional is not None else None
|
||||
|
||||
|
||||
def resolve_template_content(template_name: str, repo_root: Path) -> str | None:
|
||||
"""Resolve and compose template content through the project layer stack."""
|
||||
if not _is_safe_component(template_name):
|
||||
return None
|
||||
|
||||
layers: list[tuple[Path, str]] = []
|
||||
|
||||
def compose_from_base() -> str:
|
||||
try:
|
||||
content = layers[-1][0].read_bytes().decode("utf-8")
|
||||
for path, strategy in reversed(layers[:-1]):
|
||||
layer_content = path.read_bytes().decode("utf-8")
|
||||
if strategy == "prepend":
|
||||
content = f"{layer_content}\n\n{content}"
|
||||
elif strategy == "append":
|
||||
content = f"{content}\n\n{layer_content}"
|
||||
elif strategy == "wrap":
|
||||
placeholder = "{CORE_TEMPLATE}"
|
||||
if placeholder not in layer_content:
|
||||
raise TemplateResolutionError(
|
||||
f"Wrap layer {path} is missing {placeholder}"
|
||||
)
|
||||
content = layer_content.replace(placeholder, content)
|
||||
else:
|
||||
raise TemplateResolutionError(
|
||||
f"Unknown template composition strategy '{strategy}' in {path}"
|
||||
)
|
||||
except (OSError, UnicodeError) as exc:
|
||||
raise TemplateResolutionError(
|
||||
f"Failed to read template layer for '{template_name}': {exc}"
|
||||
) from exc
|
||||
return content
|
||||
|
||||
override = (
|
||||
repo_root
|
||||
/ ".specify"
|
||||
/ "templates"
|
||||
/ "overrides"
|
||||
/ f"{template_name}.md"
|
||||
)
|
||||
if override.is_file():
|
||||
layers.append((override, "replace"))
|
||||
return compose_from_base()
|
||||
|
||||
presets_dir = repo_root / ".specify" / "presets"
|
||||
for preset_id in _sorted_preset_ids(presets_dir):
|
||||
layer = _preset_template_layer(presets_dir / preset_id, template_name)
|
||||
if layer is not None:
|
||||
layers.append(layer)
|
||||
if layer[1] == "replace":
|
||||
return compose_from_base()
|
||||
|
||||
extensions_dir = repo_root / ".specify" / "extensions"
|
||||
for extension_id in _sorted_extension_ids(extensions_dir):
|
||||
extension_dir = extensions_dir / extension_id
|
||||
candidate = _conventional_template(extension_dir, template_name)
|
||||
if candidate is not None:
|
||||
layers.append((candidate, "replace"))
|
||||
return compose_from_base()
|
||||
|
||||
core = repo_root / ".specify" / "templates" / f"{template_name}.md"
|
||||
if core.is_file():
|
||||
layers.append((core, "replace"))
|
||||
return compose_from_base()
|
||||
|
||||
if not layers:
|
||||
return None
|
||||
|
||||
raise TemplateResolutionError(
|
||||
f"Template '{template_name}' has composing layers but no replace base"
|
||||
)
|
||||
|
||||
|
||||
def get_invoke_separator(repo_root: Path) -> str:
|
||||
integration_json = repo_root / ".specify" / "integration.json"
|
||||
if not integration_json.is_file():
|
||||
|
||||
@@ -7,16 +7,25 @@ import datetime
|
||||
import json
|
||||
import re
|
||||
import shlex
|
||||
import shutil
|
||||
import sys
|
||||
from dataclasses import dataclass
|
||||
from pathlib import Path
|
||||
|
||||
try:
|
||||
from common import get_repo_root, persist_feature_json, resolve_template
|
||||
from common import (
|
||||
TemplateResolutionError,
|
||||
get_repo_root,
|
||||
persist_feature_json,
|
||||
resolve_template_content,
|
||||
)
|
||||
except ImportError: # pragma: no cover - direct execution from unusual cwd
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
from common import get_repo_root, persist_feature_json, resolve_template
|
||||
from common import (
|
||||
TemplateResolutionError,
|
||||
get_repo_root,
|
||||
persist_feature_json,
|
||||
resolve_template_content,
|
||||
)
|
||||
|
||||
|
||||
def _json_line(payload: object) -> str:
|
||||
@@ -374,12 +383,22 @@ def main(argv: list[str] | None = None) -> int:
|
||||
)
|
||||
return 1
|
||||
|
||||
template_content = None
|
||||
needs_spec = not spec_file.is_file()
|
||||
if needs_spec:
|
||||
try:
|
||||
template_content = resolve_template_content(
|
||||
"spec-template", repo_root
|
||||
)
|
||||
except TemplateResolutionError as exc:
|
||||
print(f"Error: {exc}", file=sys.stderr)
|
||||
return 1
|
||||
|
||||
feature_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
if not spec_file.is_file():
|
||||
template = resolve_template("spec-template", repo_root)
|
||||
if template is not None and template.is_file():
|
||||
shutil.copy(template, spec_file)
|
||||
if needs_spec:
|
||||
if template_content is not None:
|
||||
spec_file.write_bytes(template_content.encode("utf-8"))
|
||||
else:
|
||||
print(
|
||||
"Warning: Spec template not found; created empty spec file",
|
||||
|
||||
@@ -0,0 +1,63 @@
|
||||
#!/usr/bin/env python3
|
||||
"""Resolve composed template content from the project template stack."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import argparse
|
||||
import json
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
try:
|
||||
from common import (
|
||||
TemplateResolutionError,
|
||||
get_repo_root,
|
||||
resolve_template_content,
|
||||
)
|
||||
except ImportError: # pragma: no cover - direct execution from unusual cwd
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
from common import (
|
||||
TemplateResolutionError,
|
||||
get_repo_root,
|
||||
resolve_template_content,
|
||||
)
|
||||
|
||||
|
||||
def main(argv: list[str] | None = None) -> int:
|
||||
parser = argparse.ArgumentParser()
|
||||
parser.add_argument("template_name")
|
||||
parser.add_argument("--json", action="store_true")
|
||||
args = parser.parse_args(argv)
|
||||
|
||||
repo_root = get_repo_root(Path(__file__))
|
||||
try:
|
||||
content = resolve_template_content(args.template_name, repo_root)
|
||||
except TemplateResolutionError as exc:
|
||||
print(f"ERROR: {exc}", file=sys.stderr)
|
||||
return 1
|
||||
if content is None:
|
||||
print(
|
||||
f"ERROR: Could not resolve required {args.template_name} from the "
|
||||
f"template override stack for {repo_root}",
|
||||
file=sys.stderr,
|
||||
)
|
||||
return 1
|
||||
|
||||
if args.json:
|
||||
print(
|
||||
json.dumps(
|
||||
{
|
||||
"TEMPLATE_NAME": args.template_name,
|
||||
"TEMPLATE_CONTENT": content,
|
||||
},
|
||||
ensure_ascii=False,
|
||||
separators=(",", ":"),
|
||||
)
|
||||
)
|
||||
else:
|
||||
sys.stdout.write(content)
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
@@ -4,15 +4,22 @@
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import shutil
|
||||
import sys
|
||||
from pathlib import Path
|
||||
|
||||
try:
|
||||
from common import get_feature_paths, resolve_template
|
||||
from common import (
|
||||
TemplateResolutionError,
|
||||
get_feature_paths,
|
||||
resolve_template_content,
|
||||
)
|
||||
except ImportError: # pragma: no cover - direct execution from unusual cwd
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
from common import get_feature_paths, resolve_template
|
||||
from common import (
|
||||
TemplateResolutionError,
|
||||
get_feature_paths,
|
||||
resolve_template_content,
|
||||
)
|
||||
|
||||
|
||||
def _json_line(payload: object) -> str:
|
||||
@@ -55,9 +62,13 @@ def main(argv: list[str] | None = None) -> int:
|
||||
file=status_stream,
|
||||
)
|
||||
else:
|
||||
template = resolve_template("plan-template", paths.repo_root)
|
||||
if template is not None and template.is_file():
|
||||
shutil.copy(template, paths.impl_plan)
|
||||
try:
|
||||
template_content = resolve_template_content("plan-template", paths.repo_root)
|
||||
except TemplateResolutionError as exc:
|
||||
print(f"Error: {exc}", file=sys.stderr)
|
||||
return 1
|
||||
if template_content is not None:
|
||||
paths.impl_plan.write_bytes(template_content.encode("utf-8"))
|
||||
print(f"Copied plan template to {paths.impl_plan}", file=status_stream)
|
||||
else:
|
||||
print("Warning: Plan template not found", file=status_stream)
|
||||
|
||||
@@ -10,17 +10,21 @@ from pathlib import Path
|
||||
try:
|
||||
from common import (
|
||||
FeaturePaths,
|
||||
TemplateResolutionError,
|
||||
format_speckit_command,
|
||||
get_feature_paths,
|
||||
resolve_template,
|
||||
resolve_template_content,
|
||||
)
|
||||
except ImportError: # pragma: no cover - direct execution from unusual cwd
|
||||
sys.path.insert(0, str(Path(__file__).resolve().parent))
|
||||
from common import (
|
||||
FeaturePaths,
|
||||
TemplateResolutionError,
|
||||
format_speckit_command,
|
||||
get_feature_paths,
|
||||
resolve_template,
|
||||
resolve_template_content,
|
||||
)
|
||||
|
||||
|
||||
@@ -120,8 +124,14 @@ def main(argv: list[str] | None = None) -> int:
|
||||
|
||||
docs = _available_docs(paths)
|
||||
|
||||
tasks_template = resolve_template("tasks-template", paths.repo_root)
|
||||
if tasks_template is None or not tasks_template.is_file():
|
||||
try:
|
||||
tasks_template_content = resolve_template_content(
|
||||
"tasks-template", paths.repo_root
|
||||
)
|
||||
except TemplateResolutionError as exc:
|
||||
print(f"ERROR: {exc}", file=sys.stderr)
|
||||
return 1
|
||||
if tasks_template_content is None:
|
||||
print(
|
||||
"ERROR: Could not resolve required tasks-template from the template "
|
||||
f"override stack for {paths.repo_root}",
|
||||
@@ -138,18 +148,21 @@ def main(argv: list[str] | None = None) -> int:
|
||||
return 1
|
||||
|
||||
if json_mode:
|
||||
tasks_template = resolve_template("tasks-template", paths.repo_root)
|
||||
sys.stdout.write(
|
||||
_json_line(
|
||||
{
|
||||
"FEATURE_DIR": str(paths.feature_dir),
|
||||
"AVAILABLE_DOCS": docs,
|
||||
"TASKS_TEMPLATE": str(tasks_template),
|
||||
"TASKS_TEMPLATE": str(tasks_template) if tasks_template else "",
|
||||
"TASKS_TEMPLATE_CONTENT": tasks_template_content,
|
||||
}
|
||||
)
|
||||
)
|
||||
else:
|
||||
tasks_template = resolve_template("tasks-template", paths.repo_root)
|
||||
print(f"FEATURE_DIR: {paths.feature_dir}")
|
||||
print(f"TASKS_TEMPLATE: {tasks_template}")
|
||||
print(f"TASKS_TEMPLATE: {tasks_template or 'not found'}")
|
||||
print("AVAILABLE_DOCS:")
|
||||
_check_file(paths.research, "research.md")
|
||||
_check_file(paths.data_model, "data-model.md")
|
||||
|
||||
@@ -9,7 +9,7 @@ and ``specify init``'s next-steps output stay consistent.
|
||||
from __future__ import annotations
|
||||
|
||||
# Agents that render $speckit-<name> (chat invocation) when in skills mode.
|
||||
DOLLAR_SKILLS_AGENTS: frozenset[str] = frozenset({"codex", "zcode"})
|
||||
DOLLAR_SKILLS_AGENTS: frozenset[str] = frozenset({"codex", "zcode", "command-code"})
|
||||
|
||||
# Agents that always render /speckit-<name>, regardless of ai_skills.
|
||||
ALWAYS_SLASH_AGENTS: frozenset[str] = frozenset({"devin", "droid", "grok", "trae", "zed"})
|
||||
|
||||
@@ -45,7 +45,12 @@ def _fail(message: str) -> None:
|
||||
"""Print an actionable error to stderr and exit non-zero."""
|
||||
# Use the stderr console so the error never lands on stdout, which under
|
||||
# ``--json`` carries the machine-readable payload and must stay parseable.
|
||||
err_console.print(f"[red]Error:[/red] {message}", style=None)
|
||||
# Escape the message: every caller passes ``str(exc)`` from a BundlerError
|
||||
# that interpolates untrusted data (a CLI argument, a catalog url, a
|
||||
# bundle.yml field), so a '[...]' in it would be parsed as a Rich style tag
|
||||
# -- silently swallowing the text, or raising MarkupError on an unbalanced
|
||||
# closer and replacing the whole message with a traceback.
|
||||
err_console.print(f"[red]Error:[/red] {_escape_markup(message)}", style=None)
|
||||
raise typer.Exit(code=1)
|
||||
|
||||
|
||||
@@ -332,9 +337,10 @@ def bundle_list(
|
||||
console.print("\n[bold cyan]Installed bundles:[/bold cyan]\n")
|
||||
for record in records:
|
||||
console.print(
|
||||
f" [bold]{record.bundle_id}[/bold] v{record.version} "
|
||||
f" [bold]{_escape_markup(str(record.bundle_id))}[/bold] "
|
||||
f"v{_escape_markup(str(record.version))} "
|
||||
f"[dim]({len(record.contributed_components)} components, "
|
||||
f"installed {record.installed_at})[/dim]"
|
||||
f"installed {_escape_markup(str(record.installed_at))})[/dim]"
|
||||
)
|
||||
|
||||
|
||||
@@ -394,13 +400,13 @@ def bundle_install(
|
||||
)
|
||||
console.print(
|
||||
f"[cyan]No Spec Kit project here; initializing with integration "
|
||||
f"'{init_integration}'…[/cyan]"
|
||||
f"'{_escape_markup(str(init_integration))}'…[/cyan]"
|
||||
)
|
||||
_run_init(init_integration, script_type=_default_script_type(), offline=offline)
|
||||
project_root = require_project_root()
|
||||
|
||||
for overlap in _bundle_overlaps(project_root, manifest, offline=offline):
|
||||
console.print(f"[yellow]![/yellow] {overlap}")
|
||||
console.print(f"[yellow]![/yellow] {_escape_markup(str(overlap))}")
|
||||
|
||||
# For an already-initialized project, the project's recorded active
|
||||
# integration is authoritative — an explicit --integration must not be
|
||||
@@ -415,7 +421,7 @@ def bundle_install(
|
||||
integration_explicit=bool(integration) and detected is None,
|
||||
)
|
||||
for warning in plan.warnings:
|
||||
console.print(f"[yellow]![/yellow] {warning}")
|
||||
console.print(f"[yellow]![/yellow] {_escape_markup(str(warning))}")
|
||||
|
||||
result = install_bundle(
|
||||
project_root,
|
||||
@@ -428,7 +434,7 @@ def bundle_install(
|
||||
return
|
||||
|
||||
console.print(
|
||||
f"[green]✓[/green] Installed '{result.bundle_id}' "
|
||||
f"[green]✓[/green] Installed '{_escape_markup(str(result.bundle_id))}' "
|
||||
f"({len(result.installed)} added, {len(result.skipped)} already present)."
|
||||
)
|
||||
|
||||
@@ -480,7 +486,10 @@ def bundle_update(
|
||||
integration_explicit=bool(integration) and detected is None,
|
||||
)
|
||||
install_bundle(project_root, plan, installer, manifest=manifest, refresh=True)
|
||||
console.print(f"[green]✓[/green] Updated '{target}' to v{plan.version}.")
|
||||
console.print(
|
||||
f"[green]✓[/green] Updated '{_escape_markup(str(target))}' "
|
||||
f"to v{_escape_markup(str(plan.version))}."
|
||||
)
|
||||
except BundlerError as exc:
|
||||
_fail(str(exc))
|
||||
return
|
||||
@@ -502,7 +511,7 @@ def bundle_remove(
|
||||
return
|
||||
|
||||
console.print(
|
||||
f"[green]✓[/green] Removed '{result.bundle_id}' "
|
||||
f"[green]✓[/green] Removed '{_escape_markup(str(result.bundle_id))}' "
|
||||
f"({len(result.uninstalled)} uninstalled, {len(result.skipped)} kept for other bundles)."
|
||||
)
|
||||
|
||||
@@ -542,13 +551,16 @@ def bundle_validate(
|
||||
return
|
||||
|
||||
for warning in report.warnings:
|
||||
console.print(f"[yellow]![/yellow] {warning}")
|
||||
console.print(f"[yellow]![/yellow] {_escape_markup(str(warning))}")
|
||||
if not report.ok:
|
||||
console.print("[red]Manifest is invalid:[/red]")
|
||||
for error in report.errors:
|
||||
console.print(f" [red]-[/red] {error}")
|
||||
console.print(f" [red]-[/red] {_escape_markup(str(error))}")
|
||||
raise typer.Exit(code=1)
|
||||
console.print(f"[green]✓[/green] {manifest.bundle.id} is well-formed and valid.")
|
||||
console.print(
|
||||
f"[green]✓[/green] {_escape_markup(str(manifest.bundle.id))} "
|
||||
"is well-formed and valid."
|
||||
)
|
||||
|
||||
|
||||
@bundle_app.command("build")
|
||||
@@ -571,8 +583,9 @@ def bundle_build(
|
||||
return
|
||||
|
||||
console.print(
|
||||
f"[green]✓[/green] Built {result.artifact_path.name} "
|
||||
f"({result.file_count} files) → {result.artifact_path}"
|
||||
f"[green]✓[/green] Built {_escape_markup(result.artifact_path.name)} "
|
||||
f"({result.file_count} files) → "
|
||||
f"{_escape_markup(str(result.artifact_path))}"
|
||||
)
|
||||
|
||||
|
||||
@@ -591,7 +604,7 @@ def bundle_init(
|
||||
init_integration = _resolve_init_integration(integration, None)
|
||||
console.print(
|
||||
f"[cyan]Initializing a Spec Kit project with integration "
|
||||
f"'{init_integration}'…[/cyan]"
|
||||
f"'{_escape_markup(str(init_integration))}'…[/cyan]"
|
||||
)
|
||||
_run_init(init_integration, script_type=_default_script_type(), offline=offline)
|
||||
project_root = require_project_root()
|
||||
@@ -599,7 +612,10 @@ def bundle_init(
|
||||
_fail(str(exc))
|
||||
return
|
||||
|
||||
console.print(f"[green]✓[/green] Spec Kit project ready at {project_root}.")
|
||||
console.print(
|
||||
f"[green]✓[/green] Spec Kit project ready at "
|
||||
f"{_escape_markup(str(project_root))}."
|
||||
)
|
||||
if bundle:
|
||||
bundle_install(bundle, integration=integration, offline=offline)
|
||||
|
||||
@@ -623,10 +639,11 @@ def catalog_list() -> None:
|
||||
only_builtin = all(s.scope == Scope.BUILTIN for s in sources)
|
||||
for source in sources:
|
||||
console.print(
|
||||
f" [bold]{source.id}[/bold] priority={source.priority} "
|
||||
f" [bold]{_escape_markup(str(source.id))}[/bold] "
|
||||
f"priority={source.priority} "
|
||||
f"policy={source.install_policy.value} scope={source.scope.value}"
|
||||
)
|
||||
console.print(f" [dim]{source.url}[/dim]")
|
||||
console.print(f" [dim]{_escape_markup(str(source.url))}[/dim]")
|
||||
if only_builtin:
|
||||
console.print("\n[dim]Using the built-in default stack.[/dim]")
|
||||
|
||||
@@ -651,7 +668,7 @@ def catalog_add(
|
||||
return
|
||||
|
||||
console.print(
|
||||
f"[green]✓[/green] Added catalog '{source.id}' "
|
||||
f"[green]✓[/green] Added catalog '{_escape_markup(str(source.id))}' "
|
||||
f"(priority {source.priority}, {source.install_policy.value})."
|
||||
)
|
||||
|
||||
@@ -670,7 +687,10 @@ def catalog_remove(
|
||||
_fail(str(exc))
|
||||
return
|
||||
|
||||
console.print(f"[green]✓[/green] Removed catalog source '{removed}'.")
|
||||
console.print(
|
||||
f"[green]✓[/green] Removed catalog source "
|
||||
f"'{_escape_markup(str(removed))}'."
|
||||
)
|
||||
|
||||
|
||||
# ZIP magic-byte signatures used to detect .zip payloads from REST API asset
|
||||
|
||||
@@ -61,6 +61,13 @@ _FALLBACK_CORE_COMMAND_NAMES = frozenset(
|
||||
)
|
||||
EXTENSION_COMMAND_NAME_PATTERN = re.compile(r"^speckit\.([a-z0-9-]+)\.([a-z0-9-]+)$")
|
||||
|
||||
# Naming pattern for provides.templates / provides.scripts entries. Unlike
|
||||
# commands, these are not namespaced (they aren't invoked via a command
|
||||
# name), so they follow the same plain slug pattern as extension.id.
|
||||
VALID_EXTENSION_ARTIFACT_NAME_PATTERN = re.compile(r"^[a-z0-9-]+$")
|
||||
|
||||
VALID_SCRIPT_RUNTIMES = frozenset({"bash", "powershell", "python"})
|
||||
|
||||
VALID_EFFECTS = frozenset({"read-only", "read-write"})
|
||||
|
||||
DEFAULT_HOOK_PRIORITY = 10
|
||||
@@ -368,11 +375,17 @@ class ExtensionManifest:
|
||||
f"Invalid provides: expected a mapping, got {type(provides).__name__}"
|
||||
)
|
||||
commands = provides.get("commands", [])
|
||||
templates = provides.get("templates", [])
|
||||
scripts = provides.get("scripts", [])
|
||||
hooks = self.data.get("hooks")
|
||||
events = self.data.get("events")
|
||||
|
||||
if "commands" in provides and not isinstance(commands, list):
|
||||
raise ValidationError("Invalid provides.commands: expected a list")
|
||||
if "templates" in provides and not isinstance(templates, list):
|
||||
raise ValidationError("Invalid provides.templates: expected a list")
|
||||
if "scripts" in provides and not isinstance(scripts, list):
|
||||
raise ValidationError("Invalid provides.scripts: expected a list")
|
||||
if "hooks" in self.data and not isinstance(hooks, dict):
|
||||
raise ValidationError("Invalid hooks: expected a mapping")
|
||||
if "events" in self.data:
|
||||
@@ -382,9 +395,17 @@ class ExtensionManifest:
|
||||
has_commands = bool(commands)
|
||||
has_hooks = bool(hooks)
|
||||
has_events = bool(events)
|
||||
has_templates = bool(templates)
|
||||
has_scripts = bool(scripts)
|
||||
|
||||
if not has_commands and not has_hooks and not has_events:
|
||||
raise ValidationError("Extension must provide at least one command, hook, or event")
|
||||
if not has_commands and not has_hooks and not has_events and not has_templates and not has_scripts:
|
||||
raise ValidationError(
|
||||
"Extension must provide at least one command, hook, or event "
|
||||
"(or a declared template/script)"
|
||||
)
|
||||
|
||||
self._validate_provided_artifacts(templates, section="templates", singular="template")
|
||||
self._validate_provided_artifacts(scripts, section="scripts", singular="script")
|
||||
|
||||
# Validate hook values (if present).
|
||||
# Each event is a single mapping or a list of mappings.
|
||||
@@ -545,6 +566,80 @@ class ExtensionManifest:
|
||||
f"The extension author should update the manifest."
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def _validate_provided_artifacts(entries: List[Any], section: str, singular: str) -> None:
|
||||
"""Validate provides.templates / provides.scripts entries.
|
||||
|
||||
Mirrors the shape/path-safety checks PresetManifest applies to its
|
||||
non-command templates, minus 'type' (the section name already
|
||||
distinguishes template vs script) and 'strategy' (extension-provided
|
||||
artifacts are always 'replace' -- see the forced-replace resolver
|
||||
behavior for extension layers in presets/__init__.py). A present
|
||||
'strategy' key is rejected rather than silently ignored, so an author
|
||||
who copies a preset-style entry gets a clear error instead of a
|
||||
silently-dropped field. Duplicate names within a section are also
|
||||
rejected: the resolver returns the first matching entry by name
|
||||
(``PresetResolver._extension_manifest_declared_template``), so a
|
||||
later duplicate would be silently unreachable while still being
|
||||
exposed by ``ExtensionManifest.templates``/``.scripts``.
|
||||
"""
|
||||
seen_names: set[str] = set()
|
||||
for entry in entries:
|
||||
if not isinstance(entry, dict):
|
||||
raise ValidationError(
|
||||
f"Each entry in 'provides.{section}' must be a mapping"
|
||||
)
|
||||
if "name" not in entry or "file" not in entry:
|
||||
raise ValidationError(f"{singular.capitalize()} missing 'name' or 'file'")
|
||||
|
||||
name = entry["name"]
|
||||
if not isinstance(name, str):
|
||||
raise ValidationError(
|
||||
f"Invalid {singular} name: expected a string, got {type(name).__name__}"
|
||||
)
|
||||
if not VALID_EXTENSION_ARTIFACT_NAME_PATTERN.match(name):
|
||||
raise ValidationError(
|
||||
f"Invalid {singular} name '{name}': "
|
||||
"must be lowercase alphanumeric with hyphens only"
|
||||
)
|
||||
if name in seen_names:
|
||||
raise ValidationError(
|
||||
f"Duplicate {singular} name '{name}' in 'provides.{section}'"
|
||||
)
|
||||
seen_names.add(name)
|
||||
|
||||
file_value = entry["file"]
|
||||
reason = relative_extension_path_violation(file_value)
|
||||
if reason:
|
||||
label = repr(file_value) if isinstance(file_value, str) else f"for {singular} '{name}'"
|
||||
raise ValidationError(f"Invalid {singular} 'file' {label}: {reason}")
|
||||
|
||||
if "description" in entry and not isinstance(entry["description"], str):
|
||||
raise ValidationError(
|
||||
f"Invalid {singular} description for '{name}': expected a string"
|
||||
)
|
||||
|
||||
if "strategy" in entry:
|
||||
raise ValidationError(
|
||||
f"Invalid {singular} entry '{name}': 'strategy' is not authorable for "
|
||||
"extension-provided artifacts, which always use 'replace' semantics"
|
||||
)
|
||||
|
||||
if section == "scripts" and "runtimes" in entry:
|
||||
runtimes = entry["runtimes"]
|
||||
if not isinstance(runtimes, list) or not all(
|
||||
isinstance(r, str) for r in runtimes
|
||||
):
|
||||
raise ValidationError(
|
||||
f"Invalid runtimes for script '{name}': expected a list of strings"
|
||||
)
|
||||
invalid = sorted(set(runtimes) - VALID_SCRIPT_RUNTIMES)
|
||||
if invalid:
|
||||
raise ValidationError(
|
||||
f"Invalid runtimes {invalid} for script '{name}': "
|
||||
f"must be one of {sorted(VALID_SCRIPT_RUNTIMES)}"
|
||||
)
|
||||
|
||||
@staticmethod
|
||||
def _try_correct_command_name(name: str, ext_id: str) -> Optional[str]:
|
||||
"""Try to auto-correct a non-conforming command name to the required pattern.
|
||||
@@ -615,6 +710,16 @@ class ExtensionManifest:
|
||||
return []
|
||||
return raw
|
||||
|
||||
@property
|
||||
def templates(self) -> List[Dict[str, Any]]:
|
||||
"""Get list of declared templates (provides.templates)."""
|
||||
return self.data.get("provides", {}).get("templates", [])
|
||||
|
||||
@property
|
||||
def scripts(self) -> List[Dict[str, Any]]:
|
||||
"""Get list of declared scripts (provides.scripts)."""
|
||||
return self.data.get("provides", {}).get("scripts", [])
|
||||
|
||||
@property
|
||||
def hooks(self) -> Dict[str, Any]:
|
||||
"""Get hook definitions."""
|
||||
@@ -650,6 +755,13 @@ class ExtensionRegistry:
|
||||
if not self.registry_path.exists():
|
||||
return {"schema_version": self.SCHEMA_VERSION, "extensions": {}}
|
||||
|
||||
# A non-regular file (e.g. a directory at the registry path) is not a
|
||||
# readable registry. Recover to empty so construction — used by the
|
||||
# install/enable/disable flows — does not crash. Resolution paths that
|
||||
# must fail closed consult is_corrupt() instead of relying on this.
|
||||
if not self.registry_path.is_file():
|
||||
return {"schema_version": self.SCHEMA_VERSION, "extensions": {}}
|
||||
|
||||
try:
|
||||
with open(self.registry_path, "r", encoding="utf-8") as f:
|
||||
data = json.load(f)
|
||||
@@ -669,6 +781,38 @@ class ExtensionRegistry:
|
||||
# starting fresh would let a later _save() wipe it.
|
||||
return {"schema_version": self.SCHEMA_VERSION, "extensions": {}}
|
||||
|
||||
def is_corrupt(self) -> bool:
|
||||
"""Report whether an existing registry file is present but unreadable.
|
||||
|
||||
``_load`` deliberately recovers from a corrupt registry by normalizing
|
||||
it to an empty mapping so install/enable/disable flows keep working.
|
||||
Resolution paths, however, must fail closed: a corrupt registry that
|
||||
normalizes to ``{}`` would otherwise cause every on-disk extension
|
||||
directory to be admitted as an unregistered, enabled extension. This
|
||||
probe lets those callers distinguish "no registry" (safe) from
|
||||
"registry exists but is invalid" (unsafe) without changing recovery
|
||||
behavior. An absent registry returns ``False``; a directory, broken
|
||||
or dangling symlink, non-regular file, unreadable file, non-mapping
|
||||
root, or non-mapping ``extensions`` value returns ``True``.
|
||||
"""
|
||||
# os.path.lexists (not Path.exists) so a dangling symlink is detected
|
||||
# rather than followed to a non-existent target and mistaken for an
|
||||
# absent registry — which would reopen the fail-open directory scan.
|
||||
if not os.path.lexists(self.registry_path):
|
||||
return False
|
||||
if not self.registry_path.is_file():
|
||||
return True
|
||||
try:
|
||||
with open(self.registry_path, "r", encoding="utf-8") as f:
|
||||
data = json.load(f)
|
||||
except (json.JSONDecodeError, OSError, UnicodeDecodeError):
|
||||
return True
|
||||
if not isinstance(data, dict):
|
||||
return True
|
||||
if "extensions" in data and not isinstance(data["extensions"], dict):
|
||||
return True
|
||||
return False
|
||||
|
||||
def _save(self):
|
||||
"""Save registry to disk."""
|
||||
self.extensions_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
@@ -56,6 +56,7 @@ def _register_builtins() -> None:
|
||||
from .cline import ClineIntegration
|
||||
from .codebuddy import CodebuddyIntegration
|
||||
from .codex import CodexIntegration
|
||||
from .command_code import CommandCodeIntegration
|
||||
from .copilot import CopilotIntegration
|
||||
from .cursor_agent import CursorAgentIntegration
|
||||
from .devin import DevinIntegration
|
||||
@@ -95,6 +96,7 @@ def _register_builtins() -> None:
|
||||
_register(ClineIntegration())
|
||||
_register(CodebuddyIntegration())
|
||||
_register(CodexIntegration())
|
||||
_register(CommandCodeIntegration())
|
||||
_register(CopilotIntegration())
|
||||
_register(CursorAgentIntegration())
|
||||
_register(DevinIntegration())
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
"""Command Code integration — skills-based agent.
|
||||
|
||||
Command Code loads agent skills from ``.commandcode/skills/speckit-<name>/SKILL.md``
|
||||
(project) or ``~/.commandcode/skills/`` (personal). Skills are invoked in chat
|
||||
with ``$speckit-<name>``.
|
||||
"""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
from ..base import IntegrationOption, SkillsIntegration
|
||||
|
||||
|
||||
class CommandCodeIntegration(SkillsIntegration):
|
||||
"""Integration for Command Code CLI."""
|
||||
|
||||
key = "command-code"
|
||||
config = {
|
||||
"name": "Command Code",
|
||||
"folder": ".commandcode/",
|
||||
"commands_subdir": "skills",
|
||||
"install_url": "https://commandcode.ai/docs",
|
||||
"requires_cli": True,
|
||||
}
|
||||
registrar_config = {
|
||||
"dir": ".commandcode/skills",
|
||||
"format": "markdown",
|
||||
"args": "$ARGUMENTS",
|
||||
"extension": "/SKILL.md",
|
||||
}
|
||||
multi_install_safe = True
|
||||
|
||||
@classmethod
|
||||
def options(cls) -> list[IntegrationOption]:
|
||||
return [
|
||||
IntegrationOption(
|
||||
"--skills",
|
||||
is_flag=True,
|
||||
default=True,
|
||||
help="Install as agent skills (default for Command Code)",
|
||||
),
|
||||
]
|
||||
@@ -56,6 +56,7 @@ from ..shared_infra import (
|
||||
|
||||
|
||||
_CONSTITUTION_PROVENANCE_FILE = ".constitution-template.json"
|
||||
_CONSTITUTION_SYNC_PRESET_ID = "constitution-sync"
|
||||
|
||||
|
||||
def _content_sha256(content: bytes) -> str:
|
||||
@@ -178,7 +179,7 @@ def _substitute_core_template(
|
||||
by the core template body and core_frontmatter holds the core template's parsed
|
||||
frontmatter (so callers can inherit scripts/agent_scripts from it). Both are
|
||||
unchanged / empty when the placeholder is absent or the core template file does
|
||||
not exist.
|
||||
not exist or cannot be read.
|
||||
"""
|
||||
if "{CORE_TEMPLATE}" not in body:
|
||||
return body, {}
|
||||
@@ -208,7 +209,23 @@ def _substitute_core_template(
|
||||
if core_file is None:
|
||||
return body, {}
|
||||
|
||||
core_frontmatter, core_body = registrar.parse_frontmatter(core_file.read_text(encoding="utf-8"))
|
||||
# Treat an unreadable/undecodable core template like a missing one so a
|
||||
# single corrupted project override cannot crash command registration —
|
||||
# the wrap-strategy callers already skip an unreadable preset source with
|
||||
# a warning (CommandRegistrar.register_pack).
|
||||
try:
|
||||
core_content = core_file.read_text(encoding="utf-8")
|
||||
except (OSError, UnicodeDecodeError) as exc:
|
||||
import warnings
|
||||
|
||||
warnings.warn(
|
||||
f"Ignoring core template for command '{cmd_name}': could not read "
|
||||
f"'{core_file.name}' ({exc.__class__.__name__}: {exc}).",
|
||||
stacklevel=2,
|
||||
)
|
||||
return body, {}
|
||||
|
||||
core_frontmatter, core_body = registrar.parse_frontmatter(core_content)
|
||||
return body.replace("{CORE_TEMPLATE}", core_body), core_frontmatter
|
||||
|
||||
|
||||
@@ -2743,7 +2760,7 @@ class PresetManager:
|
||||
if frontmatter.get("strategy") == "wrap":
|
||||
body, core_frontmatter = _substitute_core_template(body, cmd_name, self.project_root, registrar)
|
||||
frontmatter = dict(frontmatter)
|
||||
for key in ("scripts", "agent_scripts"):
|
||||
for key in ("scripts", "agent_scripts", "argument-hint"):
|
||||
if key not in frontmatter and key in core_frontmatter:
|
||||
frontmatter[key] = core_frontmatter[key]
|
||||
|
||||
@@ -3251,6 +3268,30 @@ class PresetManager:
|
||||
if source in owned_sources:
|
||||
shutil.rmtree(skill_subdir)
|
||||
|
||||
@staticmethod
|
||||
def _warn_unrestored_skill(
|
||||
skill_name: str, source_file: Path, exc: BaseException
|
||||
) -> None:
|
||||
"""Warn that a skill kept preset content because its restore source is unreadable.
|
||||
|
||||
Skipping the restore is the safe recovery — the alternative branch
|
||||
deletes the skill outright — but it is still a partial removal: the
|
||||
preset directory and registry entry go away while this ``SKILL.md``
|
||||
keeps the removed preset's content, and reconciliation never revisits
|
||||
it because the name is left out of ``mutated_names``. Name the skill
|
||||
and the source so the condition is actionable instead of silent.
|
||||
"""
|
||||
import warnings
|
||||
|
||||
warnings.warn(
|
||||
f"Skill '{skill_name}' still contains the removed preset's content: "
|
||||
f"its restore source '{source_file}' could not be read "
|
||||
f"({exc.__class__.__name__}: {exc}). The skill was left in place "
|
||||
f"rather than deleted. Fix or remove that file and re-run "
|
||||
f"'specify preset add'/'specify preset remove' to refresh it.",
|
||||
stacklevel=2,
|
||||
)
|
||||
|
||||
def _unregister_skills_in_dir(
|
||||
self,
|
||||
skill_names: List[str],
|
||||
@@ -3377,8 +3418,20 @@ class PresetManager:
|
||||
core_file = None
|
||||
|
||||
if core_file:
|
||||
# Restore from core template
|
||||
content = core_file.read_text(encoding="utf-8")
|
||||
# Restore from core template. An unreadable/undecodable
|
||||
# source cannot produce restored content, so leave the
|
||||
# existing skill untouched rather than leaking a raw
|
||||
# OSError/UnicodeDecodeError out of `preset remove` — and
|
||||
# rather than falling through to the rmtree below, which
|
||||
# would delete a skill precisely when its replacement
|
||||
# cannot be generated. Matches the `continue` guards above
|
||||
# (unsafe name, missing subdir, foreign owner), which also
|
||||
# skip without recording the name as mutated.
|
||||
try:
|
||||
content = core_file.read_text(encoding="utf-8")
|
||||
except (OSError, UnicodeDecodeError) as exc:
|
||||
self._warn_unrestored_skill(skill_name, core_file, exc)
|
||||
continue
|
||||
frontmatter, body = registrar.parse_frontmatter(content)
|
||||
if isinstance(selected_ai, str):
|
||||
body = registrar.resolve_skill_placeholders(
|
||||
@@ -3419,7 +3472,16 @@ class PresetManager:
|
||||
continue
|
||||
|
||||
if extension_restore:
|
||||
content = extension_restore["source_file"].read_text(encoding="utf-8")
|
||||
# Same boundary as the core-template branch above: an
|
||||
# unreadable extension source leaves the skill in place
|
||||
# instead of crashing or being deleted.
|
||||
try:
|
||||
content = extension_restore["source_file"].read_text(encoding="utf-8")
|
||||
except (OSError, UnicodeDecodeError) as exc:
|
||||
self._warn_unrestored_skill(
|
||||
skill_name, extension_restore["source_file"], exc
|
||||
)
|
||||
continue
|
||||
frontmatter, body = registrar.parse_frontmatter(content)
|
||||
# Mirror the register-time rewrite (#2101): resolve
|
||||
# extension-relative subdir references (agents/,
|
||||
@@ -3586,13 +3648,10 @@ class PresetManager:
|
||||
stacklevel=2,
|
||||
)
|
||||
|
||||
# Seed/re-seed memory/constitution.md from a preset-provided
|
||||
# constitution-template. The constitution is the only template that is
|
||||
# materialized to a live file rather than resolved on demand, so a
|
||||
# preset that ships one (e.g. strategy: replace with a ratified
|
||||
# constitution) must be propagated here. Guard against clobbering an
|
||||
# already-authored constitution by only replacing a file whose recorded
|
||||
# hash (or exact legacy core-template content) proves it was generated.
|
||||
# Materialize constitution-template changes only for projects that opt
|
||||
# into the constitution-sync preset. The core /constitution command
|
||||
# resolves this template on demand; constitution-sync preserves the
|
||||
# previous install-time behavior for teams that want reviewed snapshots.
|
||||
self._seed_constitution_from_preset(manifest, dest_dir)
|
||||
|
||||
return manifest
|
||||
@@ -3600,14 +3659,13 @@ class PresetManager:
|
||||
def _seed_constitution_from_preset(
|
||||
self, manifest: PresetManifest, preset_dir: Path
|
||||
) -> None:
|
||||
"""Seed memory/constitution.md from a preset constitution-template.
|
||||
"""Seed memory/constitution.md when constitution-sync opts into snapshots.
|
||||
|
||||
Only runs when the preset declares a ``type: template`` entry named
|
||||
``constitution-template`` or provides one at a convention path, and the
|
||||
live memory file is either missing or is an unchanged generated file.
|
||||
Authored constitutions are never overwritten.
|
||||
Installing constitution-sync itself materializes the currently resolved
|
||||
stack. Later preset installs only reconcile when they provide a
|
||||
``constitution-template``. Authored constitutions are never overwritten.
|
||||
"""
|
||||
provides_constitution = any(
|
||||
provides_constitution = manifest.id == _CONSTITUTION_SYNC_PRESET_ID or any(
|
||||
t.get("type") == "template" and t.get("name") == "constitution-template"
|
||||
for t in manifest.templates
|
||||
) or any(
|
||||
@@ -3628,7 +3686,7 @@ class PresetManager:
|
||||
def reconcile_constitution(
|
||||
self, failure_context: str, *, create_if_missing: bool = False
|
||||
) -> None:
|
||||
"""Reconcile generated constitution content without failing a persisted change."""
|
||||
"""Reconcile an opted-in generated constitution without failing a change."""
|
||||
try:
|
||||
self._reconcile_constitution(create_if_missing=create_if_missing)
|
||||
except (OSError, UnicodeDecodeError, PresetValidationError, ValueError) as exc:
|
||||
@@ -3640,7 +3698,11 @@ class PresetManager:
|
||||
)
|
||||
|
||||
def _reconcile_constitution(self, *, create_if_missing: bool = False) -> None:
|
||||
"""Materialize the winning constitution layer when the live file is generated."""
|
||||
"""Materialize the winning layer when constitution-sync is enabled."""
|
||||
sync_metadata = self.registry.get(_CONSTITUTION_SYNC_PRESET_ID)
|
||||
if sync_metadata is None or not sync_metadata.get("enabled", True):
|
||||
return
|
||||
|
||||
memory_constitution = (
|
||||
self.project_root / ".specify" / "memory" / "constitution.md"
|
||||
)
|
||||
@@ -4946,6 +5008,18 @@ class PresetResolver:
|
||||
self._manifest_cache[key] = None
|
||||
return self._manifest_cache[key]
|
||||
|
||||
@staticmethod
|
||||
def _is_safe_registry_id(value: object) -> bool:
|
||||
return isinstance(value, str) and re.fullmatch(r"[a-z0-9-]+", value) is not None
|
||||
|
||||
def _get_all_presets_by_priority(self) -> List[tuple[str, dict]]:
|
||||
registry = PresetRegistry(self.presets_dir)
|
||||
return [
|
||||
(pack_id, metadata)
|
||||
for pack_id, metadata in registry.list_by_priority()
|
||||
if self._is_safe_registry_id(pack_id)
|
||||
]
|
||||
|
||||
def _manifest_declared_template(
|
||||
self, pack_dir: Path, template_name: str, template_type: str
|
||||
) -> tuple[dict | None, Path | None]:
|
||||
@@ -4979,6 +5053,64 @@ class PresetResolver:
|
||||
return tmpl, None
|
||||
return None, None
|
||||
|
||||
def _extension_manifest_declared_template(
|
||||
self, ext_dir: Path, template_name: str, template_type: str
|
||||
) -> tuple[dict | None, Path | None]:
|
||||
"""Resolve an extension's manifest-declared command/template/script entry and usable file.
|
||||
|
||||
Mirrors ``_manifest_declared_template`` (for presets): returns ``(entry, candidate)``
|
||||
where ``entry`` is the matching ``provides.<type>`` mapping, or ``None`` if the
|
||||
extension has no (valid) manifest or doesn't declare this ``(name, type)``.
|
||||
``candidate`` is the declared ``file:`` resolved under ``ext_dir`` IFF it is a
|
||||
regular file that stays within ``ext_dir`` (guards against path traversal via a
|
||||
malformed manifest, mirroring ``resolve_extension_command_via_manifest``);
|
||||
``None`` otherwise.
|
||||
|
||||
The manifest is authoritative: when ``entry`` is not ``None`` but ``candidate`` is
|
||||
``None``, callers must NOT fall back to convention-based lookup — that would mask
|
||||
a typo or pick up an undeclared file. Shared by ``resolve()`` and
|
||||
``collect_all_layers()`` so their manifest-first resolution cannot silently
|
||||
diverge (the divergence flagged in review on #4012).
|
||||
"""
|
||||
if template_type not in ("command", "template", "script"):
|
||||
return None, None
|
||||
ext_manifest_path = ext_dir / "extension.yml"
|
||||
if not ext_manifest_path.exists():
|
||||
return None, None
|
||||
from ..extensions import ExtensionManifest, ValidationError as ExtValidationError
|
||||
|
||||
try:
|
||||
ext_manifest = ExtensionManifest(ext_manifest_path)
|
||||
except (ExtValidationError, yaml.YAMLError, OSError, TypeError, AttributeError):
|
||||
return None, None
|
||||
if template_type == "command":
|
||||
entries = ext_manifest.commands
|
||||
elif template_type == "template":
|
||||
entries = ext_manifest.templates
|
||||
else:
|
||||
entries = ext_manifest.scripts
|
||||
for entry in entries:
|
||||
if entry.get("name") != template_name:
|
||||
continue
|
||||
file_rel = entry.get("file")
|
||||
if not file_rel:
|
||||
return entry, None
|
||||
rel_path = Path(file_rel)
|
||||
if rel_path.is_absolute():
|
||||
return entry, None
|
||||
candidate = ext_dir / rel_path
|
||||
try:
|
||||
# Resolve only for the containment check, not for the
|
||||
# returned path -- resolving the returned path would follow
|
||||
# symlinks in ext_dir's ancestors (e.g. a symlinked tmp dir
|
||||
# on macOS) and diverge from the unresolved paths convention
|
||||
# lookup returns for the same directory.
|
||||
candidate.resolve().relative_to(ext_dir.resolve()) # raises ValueError if outside
|
||||
except (OSError, ValueError):
|
||||
return entry, None
|
||||
return entry, (candidate if candidate.is_file() else None)
|
||||
return None, None
|
||||
|
||||
def _get_all_extensions_by_priority(self) -> list[tuple[int, str, dict | None]]:
|
||||
"""Build unified list of registered and unregistered extensions sorted by priority.
|
||||
|
||||
@@ -4993,6 +5125,16 @@ class PresetResolver:
|
||||
return []
|
||||
|
||||
registry = ExtensionRegistry(self.extensions_dir)
|
||||
# Fail closed on a corrupt registry. ExtensionRegistry._load() recovers
|
||||
# by normalizing an unreadable registry to an empty mapping, which would
|
||||
# otherwise cause the directory scan below to admit every on-disk
|
||||
# directory as an unregistered, enabled extension — a fail-open path
|
||||
# that could supply constitution content from an invalid registry state.
|
||||
if registry.is_corrupt():
|
||||
raise PresetValidationError(
|
||||
f"Invalid extension registry {registry.registry_path}: "
|
||||
"refusing to enumerate extensions"
|
||||
)
|
||||
# Use keys() to track ALL extensions (including corrupted entries) without deep copy
|
||||
# This prevents corrupted entries from being picked up as "unregistered" dirs
|
||||
registered_extension_ids = registry.keys()
|
||||
@@ -5004,6 +5146,8 @@ class PresetResolver:
|
||||
|
||||
# Only include enabled extensions in the result
|
||||
for ext_id, metadata in all_registered:
|
||||
if not self._is_safe_registry_id(ext_id):
|
||||
continue
|
||||
# Skip disabled extensions
|
||||
if not metadata.get("enabled", True):
|
||||
continue
|
||||
@@ -5012,7 +5156,7 @@ class PresetResolver:
|
||||
|
||||
# Add unregistered directories with implicit priority=10
|
||||
for ext_dir in self.extensions_dir.iterdir():
|
||||
if not ext_dir.is_dir() or ext_dir.name.startswith("."):
|
||||
if not ext_dir.is_dir() or not self._is_safe_registry_id(ext_dir.name):
|
||||
continue
|
||||
if ext_dir.name not in registered_extension_ids:
|
||||
all_extensions.append((10, ext_dir.name, None))
|
||||
@@ -5078,8 +5222,7 @@ class PresetResolver:
|
||||
|
||||
# Priority 2: Installed presets (sorted by priority — lower number wins)
|
||||
if not skip_presets and self.presets_dir.exists():
|
||||
registry = PresetRegistry(self.presets_dir)
|
||||
for pack_id, _metadata in registry.list_by_priority():
|
||||
for pack_id, _metadata in self._get_all_presets_by_priority():
|
||||
pack_dir = self.presets_dir / pack_id
|
||||
# The preset manifest is authoritative: if it declares this
|
||||
# template with an explicit ``file:``, resolve to that path —
|
||||
@@ -5115,6 +5258,16 @@ class PresetResolver:
|
||||
ext_dir = self.extensions_dir / ext_id
|
||||
if not ext_dir.is_dir():
|
||||
continue
|
||||
# The extension manifest is authoritative, same as preset manifests
|
||||
# above: check it before convention-based lookup so a declared entry
|
||||
# at a non-conventional path wins over a stale conventional file.
|
||||
entry, manifest_candidate = self._extension_manifest_declared_template(
|
||||
ext_dir, template_name, template_type
|
||||
)
|
||||
if manifest_candidate is not None:
|
||||
return manifest_candidate
|
||||
if entry is not None:
|
||||
continue
|
||||
for subdir in subdirs:
|
||||
if subdir:
|
||||
candidate = ext_dir / subdir / f"{template_name}{ext}"
|
||||
@@ -5272,13 +5425,11 @@ class PresetResolver:
|
||||
return {"path": resolved_str, "source": "project override"}
|
||||
|
||||
if str(self.presets_dir) in resolved_str and self.presets_dir.exists():
|
||||
registry = PresetRegistry(self.presets_dir)
|
||||
for pack_id, _metadata in registry.list_by_priority():
|
||||
for pack_id, metadata in self._get_all_presets_by_priority():
|
||||
pack_dir = self.presets_dir / pack_id
|
||||
try:
|
||||
resolved.relative_to(pack_dir)
|
||||
meta = registry.get(pack_id)
|
||||
version = meta.get("version", "?") if meta else "?"
|
||||
version = metadata.get("version", "?")
|
||||
return {
|
||||
"path": resolved_str,
|
||||
"source": f"{pack_id} v{version}",
|
||||
@@ -5364,8 +5515,7 @@ class PresetResolver:
|
||||
|
||||
# Priority 2: Installed presets (sorted by priority — lower number = higher precedence)
|
||||
if self.presets_dir.exists():
|
||||
registry = PresetRegistry(self.presets_dir)
|
||||
for pack_id, metadata in registry.list_by_priority():
|
||||
for pack_id, metadata in self._get_all_presets_by_priority():
|
||||
pack_dir = self.presets_dir / pack_id
|
||||
# Read strategy and manifest file path from preset manifest
|
||||
strategy = "replace"
|
||||
@@ -5424,27 +5574,15 @@ class PresetResolver:
|
||||
ext_dir = self.extensions_dir / ext_id
|
||||
if not ext_dir.is_dir():
|
||||
continue
|
||||
# Try convention-based lookup first
|
||||
candidate = _find_in_subdirs(ext_dir)
|
||||
# If not found and this is a command, check extension manifest
|
||||
if candidate is None and template_type == "command":
|
||||
ext_manifest_path = ext_dir / "extension.yml"
|
||||
if ext_manifest_path.exists():
|
||||
try:
|
||||
from ..extensions import ExtensionManifest, ValidationError as ExtValidationError
|
||||
ext_manifest = ExtensionManifest(ext_manifest_path)
|
||||
for cmd in ext_manifest.commands:
|
||||
if cmd.get("name") == template_name:
|
||||
cmd_file = cmd.get("file")
|
||||
if cmd_file:
|
||||
c = ext_dir / cmd_file
|
||||
if c.exists():
|
||||
candidate = c
|
||||
break
|
||||
except (ExtValidationError, yaml.YAMLError):
|
||||
# Invalid extension manifest — fall back to
|
||||
# convention-based lookup (already attempted above).
|
||||
pass
|
||||
# The extension manifest is authoritative, same as preset manifests
|
||||
# above: check it before convention-based lookup so a declared entry
|
||||
# at a non-conventional path wins over a stale conventional file, and
|
||||
# a declared-but-missing file isn't silently masked by convention.
|
||||
entry, candidate = self._extension_manifest_declared_template(
|
||||
ext_dir, template_name, template_type
|
||||
)
|
||||
if entry is None:
|
||||
candidate = _find_in_subdirs(ext_dir)
|
||||
if candidate:
|
||||
if ext_meta:
|
||||
version = ext_meta.get("version", "?")
|
||||
@@ -5742,7 +5880,7 @@ class PresetResolver:
|
||||
# Inherit scripts/agent_scripts from base frontmatter if missing
|
||||
if base_frontmatter_text and base_frontmatter_text != top_frontmatter_text:
|
||||
base_fm = _parse_fm_yaml(base_frontmatter_text)
|
||||
for key in ("scripts", "agent_scripts"):
|
||||
for key in ("scripts", "agent_scripts", "argument-hint"):
|
||||
if key not in top_fm and key in base_fm:
|
||||
top_fm[key] = base_fm[key]
|
||||
|
||||
|
||||
@@ -9,6 +9,7 @@ keeps working.
|
||||
from __future__ import annotations
|
||||
|
||||
import os
|
||||
import re
|
||||
from pathlib import Path
|
||||
|
||||
import typer
|
||||
@@ -352,9 +353,26 @@ def preset_resolve(
|
||||
from .. import _require_specify_project
|
||||
from . import PresetResolver
|
||||
|
||||
is_command = "." in template_name
|
||||
valid_name = (
|
||||
re.fullmatch(r"[a-z0-9-]+(?:\.[a-z0-9-]+)+", template_name)
|
||||
if is_command
|
||||
else re.fullmatch(r"[a-z0-9-]+", template_name)
|
||||
)
|
||||
if valid_name is None:
|
||||
typer.echo(
|
||||
f"Error: invalid template name '{template_name}'; "
|
||||
"use lowercase letters, digits, and hyphens, with non-empty "
|
||||
"dot-separated segments for commands",
|
||||
err=True,
|
||||
)
|
||||
raise typer.Exit(1)
|
||||
|
||||
project_root = _require_specify_project()
|
||||
resolver = PresetResolver(project_root)
|
||||
layers = resolver.collect_all_layers(template_name)
|
||||
template_type = "command" if is_command else "template"
|
||||
|
||||
layers = resolver.collect_all_layers(template_name, template_type)
|
||||
safe_template_name = _escape_markup(str(template_name))
|
||||
|
||||
if layers:
|
||||
@@ -377,7 +395,7 @@ def preset_resolve(
|
||||
if has_composition:
|
||||
# Verify composition is actually possible
|
||||
try:
|
||||
composed = resolver.resolve_content(template_name)
|
||||
composed = resolver.resolve_content(template_name, template_type)
|
||||
except Exception as exc:
|
||||
composed = None
|
||||
console.print(
|
||||
@@ -416,7 +434,7 @@ def preset_resolve(
|
||||
)
|
||||
else:
|
||||
# No layers found — fall back to resolve_with_source for non-composition cases
|
||||
result = resolver.resolve_with_source(template_name)
|
||||
result = resolver.resolve_with_source(template_name, template_type)
|
||||
if result:
|
||||
console.print(
|
||||
f" [bold]{safe_template_name}[/bold]: "
|
||||
@@ -800,8 +818,8 @@ def preset_catalog_remove(
|
||||
|
||||
try:
|
||||
config = yaml.safe_load(config_path.read_text(encoding="utf-8")) or {}
|
||||
except Exception:
|
||||
console.print("[red]Error:[/red] Failed to read preset catalog config.")
|
||||
except Exception as e:
|
||||
console.print(f"[red]Error:[/red] Failed to read preset catalog config: {e}")
|
||||
raise typer.Exit(1)
|
||||
|
||||
catalogs = config.get("catalogs", [])
|
||||
|
||||
@@ -671,8 +671,20 @@ def evaluate_condition(condition: str, context: Any) -> bool:
|
||||
result = evaluate_expression(condition, context)
|
||||
# Treat plain "false"/"true" strings as booleans so that
|
||||
# condition: "false" (without {{ }}) behaves as expected.
|
||||
#
|
||||
# Strip before matching: the string a condition resolves to is most often
|
||||
# captured command output, and a ``shell`` step stores ``proc.stdout``
|
||||
# verbatim, so ``run: echo false`` resolves to ``"false\n"``. Without the
|
||||
# strip that trailing newline matches neither branch and falls through to
|
||||
# ``bool("false\n")`` -> True, silently taking an ``if`` step's ``then``
|
||||
# branch (and keeping a ``while``/``do-while`` looping) on a step that
|
||||
# printed "false". A workflow cannot strip it itself -- the registered
|
||||
# filters are default/join/map/contains/from_json, there is no ``trim``.
|
||||
# ``InitStep._resolve_bool`` and the catalog readers already strip before
|
||||
# matching boolean text. ``bool(result)`` below still sees the raw string,
|
||||
# so no non-boolean text changes truthiness.
|
||||
if isinstance(result, str):
|
||||
lower = result.lower()
|
||||
lower = result.strip().lower()
|
||||
if lower == "false":
|
||||
return False
|
||||
if lower == "true":
|
||||
|
||||
@@ -87,7 +87,12 @@ def _parse_edit(edit_raw: dict[str, Any], idx: int) -> tuple[OverlayEdit | None,
|
||||
else:
|
||||
return None, f"Edit at index {idx} has no operation; expected one of {sorted(VALID_OPERATIONS)}."
|
||||
|
||||
if operation not in VALID_OPERATIONS:
|
||||
# ``operation`` comes straight from hand-edited YAML, so it may be an
|
||||
# unhashable mapping/sequence (``operation: {insert_after: a}`` when the
|
||||
# shorthand form is nested by mistake). Membership-testing an unhashable
|
||||
# value against the frozenset raises TypeError, which would escape this
|
||||
# never-raising validator; check the type first, like 'anchor' below.
|
||||
if not isinstance(operation, str) or operation not in VALID_OPERATIONS:
|
||||
return None, f"Edit at index {idx} has invalid operation {operation!r}."
|
||||
|
||||
if not isinstance(anchor, str) or not anchor:
|
||||
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
description: Generate a custom checklist for the current feature based on user requirements.
|
||||
scripts:
|
||||
sh: scripts/bash/check-prerequisites.sh --json
|
||||
ps: scripts/powershell/check-prerequisites.ps1 -Json
|
||||
py: scripts/python/check_prerequisites.py --json
|
||||
sh: scripts/bash/check-prerequisites.sh --json --template checklist-template
|
||||
ps: scripts/powershell/check-prerequisites.ps1 -Json -Template checklist-template
|
||||
py: scripts/python/check_prerequisites.py --json --template checklist-template
|
||||
---
|
||||
|
||||
## Checklist Purpose: "Unit Tests for English"
|
||||
@@ -72,7 +72,7 @@ You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Execution Steps
|
||||
|
||||
1. **Setup**: Run `{SCRIPT}` from repo root and parse JSON for FEATURE_DIR and AVAILABLE_DOCS list.
|
||||
1. **Setup**: Run `{SCRIPT}` from repo root and parse JSON for FEATURE_DIR, AVAILABLE_DOCS list, and TEMPLATE_CONTENT.
|
||||
- All file paths must be absolute.
|
||||
- For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
||||
|
||||
@@ -127,7 +127,7 @@ You **MUST** consider the user input before proceeding (if not empty).
|
||||
- Use progressive disclosure: add follow-on retrieval only if gaps detected
|
||||
- If source docs are large, generate interim summary items instead of embedding raw text
|
||||
|
||||
6. **Generate checklist** - Create "Unit Tests for Requirements":
|
||||
6. **Generate checklist** - Use TEMPLATE_CONTENT as the structural template and create "Unit Tests for Requirements":
|
||||
- Create `FEATURE_DIR/checklists/` directory if it doesn't exist
|
||||
- Generate unique checklist filename:
|
||||
- Use short, descriptive name based on domain (e.g., `ux.md`, `api.md`, `security.md`)
|
||||
|
||||
@@ -4,6 +4,10 @@ handoffs:
|
||||
- label: Build Specification
|
||||
agent: speckit.specify
|
||||
prompt: Implement the feature specification based on the updated constitution. I want to build...
|
||||
scripts:
|
||||
sh: scripts/bash/resolve-template.sh constitution-template --json
|
||||
ps: scripts/powershell/resolve-template.ps1 constitution-template -Json
|
||||
py: scripts/python/resolve_template.py constitution-template --json
|
||||
---
|
||||
|
||||
## User Input
|
||||
@@ -70,13 +74,22 @@ and commands read the constitution at runtime and are not modified here.
|
||||
|
||||
## Outline
|
||||
|
||||
You are updating the project constitution at `.specify/memory/constitution.md`. This file is a TEMPLATE containing placeholder tokens in square brackets (e.g. `[PROJECT_NAME]`, `[PRINCIPLE_1_NAME]`). Your job is to (a) collect/derive concrete values and (b) fill the template precisely.
|
||||
|
||||
**Note**: If `.specify/memory/constitution.md` does not exist yet, it should have been initialized from `.specify/templates/constitution-template.md` during project setup. If it's missing, copy the template first.
|
||||
You are updating the project constitution at `.specify/memory/constitution.md`. The active
|
||||
constitution scaffold is resolved at command time from `constitution-template` through the Spec Kit
|
||||
preset/template resolution stack.
|
||||
|
||||
Follow this execution flow:
|
||||
|
||||
1. Load the existing constitution at `.specify/memory/constitution.md`.
|
||||
1. Run `{SCRIPT}` from the repository root and parse `TEMPLATE_CONTENT` as the active template.
|
||||
- The shared resolver applies project overrides, composing preset layers, and extension layers
|
||||
before the core template fallback. It MUST succeed before continuing.
|
||||
- If it fails, stop and report the resolution error; do not continue with only one contributing
|
||||
template layer.
|
||||
- If `.specify/memory/constitution.md` exists, load it as the source of current project-specific
|
||||
values and amendments. Preserve information that is still applicable when applying the newly
|
||||
resolved scaffold.
|
||||
- If it does not exist, use the resolved template as the initial document.
|
||||
- Do not write back to any versioned template layer.
|
||||
- Identify every placeholder token of the form `[ALL_CAPS_IDENTIFIER]`.
|
||||
**IMPORTANT**: The user might require less or more principles than the ones used in the template. If a number is specified, respect that - follow the general template. You will update the doc accordingly.
|
||||
|
||||
@@ -90,7 +103,7 @@ Follow this execution flow:
|
||||
- PATCH: Clarifications, wording, typo fixes, non-semantic refinements.
|
||||
- If version bump type ambiguous, propose reasoning before finalizing.
|
||||
|
||||
3. Draft the updated constitution content:
|
||||
3. Draft the updated constitution content using the resolved template as the required structure:
|
||||
- Replace every placeholder with concrete text (no bracketed tokens left except intentionally retained template slots that the project has chosen not to define yet—explicitly justify any left).
|
||||
- Preserve heading hierarchy and comments can be removed once replaced unless they still add clarifying guidance.
|
||||
- Ensure each Principle section: succinct name line, paragraph (or bullet list) capturing non‑negotiable rules, explicit rationale if not obvious.
|
||||
@@ -128,7 +141,7 @@ If the user supplies partial updates (e.g., only one principle revision), still
|
||||
|
||||
If critical info missing (e.g., ratification date truly unknown), insert `TODO(<FIELD_NAME>): explanation` and include in the Sync Impact Report under deferred items.
|
||||
|
||||
Do not create a new template; always operate on the existing `.specify/memory/constitution.md` file.
|
||||
Write only `.specify/memory/constitution.md`; do not create or modify template source files.
|
||||
|
||||
## Post-Execution Checks
|
||||
|
||||
|
||||
@@ -60,7 +60,7 @@ You **MUST** consider the user input before proceeding (if not empty).
|
||||
|
||||
## Outline
|
||||
|
||||
1. **Setup**: Run `{SCRIPT}` from repo root and parse FEATURE_DIR, TASKS_TEMPLATE, and AVAILABLE_DOCS list. `FEATURE_DIR` and `TASKS_TEMPLATE` must be absolute paths when provided. `AVAILABLE_DOCS` is a list of document names/relative paths available under `FEATURE_DIR` (for example `research.md` or `contracts/`). For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
||||
1. **Setup**: Run `{SCRIPT}` from repo root and parse FEATURE_DIR, TASKS_TEMPLATE_CONTENT, TASKS_TEMPLATE, and AVAILABLE_DOCS list. `FEATURE_DIR` and `TASKS_TEMPLATE` must be absolute paths when provided. `AVAILABLE_DOCS` is a list of document names/relative paths available under `FEATURE_DIR` (for example `research.md` or `contracts/`). For single quotes in args like "I'm Groot", use escape syntax: e.g 'I'\''m Groot' (or double-quote if possible: "I'm Groot").
|
||||
|
||||
2. **Load design documents**: Read from FEATURE_DIR:
|
||||
- **Required**: plan.md (tech stack, libraries, structure), spec.md (user stories with priorities)
|
||||
@@ -79,7 +79,7 @@ You **MUST** consider the user input before proceeding (if not empty).
|
||||
- Create parallel execution examples per user story
|
||||
- Validate task completeness (each user story has all needed tasks, independently testable)
|
||||
|
||||
4. **Generate tasks.md**: Read the tasks template from TASKS_TEMPLATE (from the JSON output above) and use it as structure. If TASKS_TEMPLATE is empty, fall back to `.specify/templates/tasks-template.md`. Fill with:
|
||||
4. **Generate tasks.md**: Use TASKS_TEMPLATE_CONTENT (from the JSON output above) as the structure. For compatibility with older setup scripts that omit TASKS_TEMPLATE_CONTENT, read TASKS_TEMPLATE instead. Fill with:
|
||||
- Correct feature name from plan.md
|
||||
- Phase 1: Setup tasks (project initialization)
|
||||
- Phase 2: Foundational tasks (blocking prerequisites for all user stories)
|
||||
|
||||
@@ -217,6 +217,31 @@ def test_catalog_remove_builtin_is_refused(project: Path):
|
||||
assert "built-in" in result.output
|
||||
|
||||
|
||||
# Every ``bundle`` error path funnels through ``_fail(str(exc))``, and the
|
||||
# BundlerError messages interpolate untrusted data -- including the command's
|
||||
# own argument. An unbalanced closer used to raise MarkupError instead of the
|
||||
# error, leaving the user with a traceback and no message at all.
|
||||
@pytest.mark.parametrize(
|
||||
"argv, expected",
|
||||
[
|
||||
(
|
||||
["bundle", "catalog", "add", "ssh://ex[/red]ample.com/c.json"],
|
||||
"ssh://ex[/red]ample.com/c.json",
|
||||
),
|
||||
(["bundle", "catalog", "remove", "no[/red]such"], "no[/red]such"),
|
||||
(["bundle", "update", "no[/red]such"], "no[/red]such"),
|
||||
(["bundle", "remove", "no[/red]such"], "no[/red]such"),
|
||||
],
|
||||
)
|
||||
def test_error_paths_escape_rich_markup(project: Path, argv: list, expected: str):
|
||||
result = runner.invoke(app, argv)
|
||||
|
||||
assert result.exit_code == 1
|
||||
# A MarkupError would surface here as an exception rather than a clean exit.
|
||||
assert isinstance(result.exception, SystemExit)
|
||||
assert expected in strip_ansi(result.output)
|
||||
|
||||
|
||||
def test_validate_reports_invalid_manifest(project: Path):
|
||||
data = valid_manifest_dict()
|
||||
del data["bundle"]["license"]
|
||||
@@ -237,6 +262,33 @@ def test_validate_accepts_valid_manifest(project: Path):
|
||||
assert "valid" in result.output
|
||||
|
||||
|
||||
def test_validate_escapes_manifest_markup_in_errors(project: Path):
|
||||
data = valid_manifest_dict()
|
||||
# An invalid constraint is echoed back inside the validation error.
|
||||
data["requires"] = {"speckit_version": ">=1.0[/bold]"}
|
||||
(project / "bundle.yml").write_text(yaml.safe_dump(data), encoding="utf-8")
|
||||
|
||||
result = runner.invoke(app, ["bundle", "validate", "--offline"])
|
||||
|
||||
assert result.exit_code == 1
|
||||
assert isinstance(result.exception, SystemExit)
|
||||
assert ">=1.0[/bold]" in strip_ansi(result.output)
|
||||
|
||||
|
||||
def test_validate_escapes_manifest_markup_in_warnings(project: Path):
|
||||
data = valid_manifest_dict()
|
||||
# Step ids are not charset-validated, and the unresolved-reference warning
|
||||
# echoes them -- so an otherwise *valid* manifest crashed just as readily as
|
||||
# an invalid one, on the success path.
|
||||
data["provides"]["steps"] = [{"id": "step[/bold]a"}]
|
||||
(project / "bundle.yml").write_text(yaml.safe_dump(data), encoding="utf-8")
|
||||
|
||||
result = runner.invoke(app, ["bundle", "validate", "--offline"])
|
||||
|
||||
assert result.exit_code == 0, repr(result.exception)
|
||||
assert "step[/bold]a" in strip_ansi(result.output)
|
||||
|
||||
|
||||
def test_validate_rejects_broken_reference(project: Path):
|
||||
# Synthetic component ids resolve to nothing in any catalog → hard failure.
|
||||
(project / "bundle.yml").write_text(
|
||||
@@ -267,6 +319,65 @@ def test_build_produces_artifact(project: Path):
|
||||
assert len(artifacts) == 1
|
||||
|
||||
|
||||
def test_build_escapes_markup_in_output_path(project: Path):
|
||||
"""The build success line echoes a caller-supplied ``--output`` path.
|
||||
|
||||
Brackets are legal in a directory name on both POSIX and Windows, so the
|
||||
artifact is built and *then* misreported: ``[bold]`` is consumed as a style
|
||||
tag, and the success line names a path that does not exist on disk.
|
||||
|
||||
A closing tag (``[/red]``) would raise MarkupError outright, but ``/`` is a
|
||||
path separator on Windows, so this uses the silent-swallow form to keep the
|
||||
fixture portable.
|
||||
"""
|
||||
(project / "bundle.yml").write_text(
|
||||
yaml.safe_dump(valid_manifest_dict()), encoding="utf-8"
|
||||
)
|
||||
(project / "README.md").write_text("# Demo", encoding="utf-8")
|
||||
out_dir = project / "dist[bold]out"
|
||||
|
||||
result = runner.invoke(app, ["bundle", "build", "--output", str(out_dir)])
|
||||
|
||||
assert result.exit_code == 0, repr(result.exception)
|
||||
assert list(out_dir.glob("*.zip")), "the artifact should still be built"
|
||||
assert "dist[bold]out" in strip_ansi(result.output), (
|
||||
"the reported path must match the directory actually written"
|
||||
)
|
||||
|
||||
|
||||
def test_list_escapes_markup_in_records(project: Path):
|
||||
"""``bundle list`` renders record fields that are never charset-validated.
|
||||
|
||||
``InstalledBundleRecord.from_dict`` accepts any non-empty string for
|
||||
``bundle_id``/``version`` and any string for ``installed_at``, so a records
|
||||
file that *loads cleanly* could still crash the command that displays it.
|
||||
"""
|
||||
(project / ".specify" / "bundle-records.json").write_text(
|
||||
json.dumps(
|
||||
{
|
||||
"schema_version": "1.0",
|
||||
"bundles": [
|
||||
{
|
||||
"bundle_id": "demo[/red]id",
|
||||
"version": "1.0.0[/bold]",
|
||||
"installed_at": "2026-01-01T00:00:00Z[/dim]",
|
||||
"contributed_components": [],
|
||||
}
|
||||
],
|
||||
}
|
||||
),
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
result = runner.invoke(app, ["bundle", "list"])
|
||||
|
||||
assert result.exit_code == 0, repr(result.exception)
|
||||
output = strip_ansi(result.output)
|
||||
assert "demo[/red]id" in output
|
||||
assert "1.0.0[/bold]" in output
|
||||
assert "2026-01-01T00:00:00Z[/dim]" in output
|
||||
|
||||
|
||||
def _mock_manifest_download(monkeypatch, source_path: Path) -> None:
|
||||
"""Mock the HTTPS manifest fetch to return a locally-authored manifest.
|
||||
|
||||
|
||||
@@ -242,11 +242,11 @@ class MarkdownIntegrationTests:
|
||||
|
||||
if script_variant == "sh":
|
||||
for name in ["check-prerequisites.sh", "common.sh", "create-new-feature.sh",
|
||||
"setup-plan.sh", "setup-tasks.sh"]:
|
||||
"resolve-template.sh", "setup-plan.sh", "setup-tasks.sh"]:
|
||||
files.append(f".specify/scripts/bash/{name}")
|
||||
else:
|
||||
for name in ["check-prerequisites.ps1", "common.ps1", "create-new-feature.ps1",
|
||||
"setup-plan.ps1", "setup-tasks.ps1"]:
|
||||
"resolve-template.ps1", "setup-plan.ps1", "setup-tasks.ps1"]:
|
||||
files.append(f".specify/scripts/powershell/{name}")
|
||||
|
||||
for name in ["checklist-template.md",
|
||||
|
||||
@@ -494,6 +494,7 @@ class SkillsIntegrationTests:
|
||||
".specify/scripts/bash/check-prerequisites.sh",
|
||||
".specify/scripts/bash/common.sh",
|
||||
".specify/scripts/bash/create-new-feature.sh",
|
||||
".specify/scripts/bash/resolve-template.sh",
|
||||
".specify/scripts/bash/setup-plan.sh",
|
||||
".specify/scripts/bash/setup-tasks.sh",
|
||||
]
|
||||
@@ -502,6 +503,7 @@ class SkillsIntegrationTests:
|
||||
".specify/scripts/powershell/check-prerequisites.ps1",
|
||||
".specify/scripts/powershell/common.ps1",
|
||||
".specify/scripts/powershell/create-new-feature.ps1",
|
||||
".specify/scripts/powershell/resolve-template.ps1",
|
||||
".specify/scripts/powershell/setup-plan.ps1",
|
||||
".specify/scripts/powershell/setup-tasks.ps1",
|
||||
]
|
||||
|
||||
@@ -495,6 +495,7 @@ class TomlIntegrationTests:
|
||||
"check-prerequisites.sh",
|
||||
"common.sh",
|
||||
"create-new-feature.sh",
|
||||
"resolve-template.sh",
|
||||
"setup-plan.sh",
|
||||
"setup-tasks.sh",
|
||||
]:
|
||||
@@ -504,6 +505,7 @@ class TomlIntegrationTests:
|
||||
"check-prerequisites.ps1",
|
||||
"common.ps1",
|
||||
"create-new-feature.ps1",
|
||||
"resolve-template.ps1",
|
||||
"setup-plan.ps1",
|
||||
"setup-tasks.ps1",
|
||||
]:
|
||||
|
||||
@@ -409,6 +409,7 @@ class YamlIntegrationTests:
|
||||
"check-prerequisites.sh",
|
||||
"common.sh",
|
||||
"create-new-feature.sh",
|
||||
"resolve-template.sh",
|
||||
"setup-plan.sh",
|
||||
"setup-tasks.sh",
|
||||
]:
|
||||
@@ -418,6 +419,7 @@ class YamlIntegrationTests:
|
||||
"check-prerequisites.ps1",
|
||||
"common.ps1",
|
||||
"create-new-feature.ps1",
|
||||
"resolve-template.ps1",
|
||||
"setup-plan.ps1",
|
||||
"setup-tasks.ps1",
|
||||
]:
|
||||
|
||||
@@ -192,6 +192,7 @@ class TestClineIntegration(MarkdownIntegrationTests):
|
||||
"check-prerequisites.sh",
|
||||
"common.sh",
|
||||
"create-new-feature.sh",
|
||||
"resolve-template.sh",
|
||||
"setup-plan.sh",
|
||||
"setup-tasks.sh",
|
||||
]:
|
||||
@@ -201,6 +202,7 @@ class TestClineIntegration(MarkdownIntegrationTests):
|
||||
"check-prerequisites.ps1",
|
||||
"common.ps1",
|
||||
"create-new-feature.ps1",
|
||||
"resolve-template.ps1",
|
||||
"setup-plan.ps1",
|
||||
"setup-tasks.ps1",
|
||||
]:
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
"""Tests for CommandCodeIntegration — skills-based integration (Command Code)."""
|
||||
|
||||
from .test_integration_base_skills import SkillsIntegrationTests
|
||||
|
||||
|
||||
class TestCommandCodeIntegration(SkillsIntegrationTests):
|
||||
KEY = "command-code"
|
||||
FOLDER = ".commandcode/"
|
||||
COMMANDS_SUBDIR = "skills"
|
||||
REGISTRAR_DIR = ".commandcode/skills"
|
||||
|
||||
|
||||
class TestCommandCodeInvocation:
|
||||
"""Command Code renders $speckit-* chat invocations (like Codex/ZCode)."""
|
||||
|
||||
def test_next_steps_show_dollar_skill_invocation(self, tmp_path):
|
||||
import os
|
||||
|
||||
from typer.testing import CliRunner
|
||||
|
||||
from specify_cli import app
|
||||
|
||||
project = tmp_path / "command-code-next-steps"
|
||||
project.mkdir()
|
||||
old_cwd = os.getcwd()
|
||||
try:
|
||||
os.chdir(project)
|
||||
runner = CliRunner()
|
||||
result = runner.invoke(
|
||||
app,
|
||||
[
|
||||
"init",
|
||||
"--here",
|
||||
"--integration",
|
||||
"command-code",
|
||||
"--ignore-agent-tools",
|
||||
"--script",
|
||||
"sh",
|
||||
],
|
||||
catch_exceptions=False,
|
||||
)
|
||||
finally:
|
||||
os.chdir(old_cwd)
|
||||
|
||||
assert result.exit_code == 0
|
||||
assert "$speckit-constitution" in result.output
|
||||
assert "/speckit.constitution" not in result.output
|
||||
@@ -278,6 +278,7 @@ class TestCopilotCommandsMode:
|
||||
".specify/scripts/bash/check-prerequisites.sh",
|
||||
".specify/scripts/bash/common.sh",
|
||||
".specify/scripts/bash/create-new-feature.sh",
|
||||
".specify/scripts/bash/resolve-template.sh",
|
||||
".specify/scripts/bash/setup-plan.sh",
|
||||
".specify/scripts/bash/setup-tasks.sh",
|
||||
".specify/templates/checklist-template.md",
|
||||
@@ -342,6 +343,7 @@ class TestCopilotCommandsMode:
|
||||
".specify/scripts/powershell/check-prerequisites.ps1",
|
||||
".specify/scripts/powershell/common.ps1",
|
||||
".specify/scripts/powershell/create-new-feature.ps1",
|
||||
".specify/scripts/powershell/resolve-template.ps1",
|
||||
".specify/scripts/powershell/setup-plan.ps1",
|
||||
".specify/scripts/powershell/setup-tasks.ps1",
|
||||
".specify/templates/checklist-template.md",
|
||||
@@ -854,6 +856,7 @@ class TestCopilotSkillsMode:
|
||||
".specify/scripts/bash/check-prerequisites.sh",
|
||||
".specify/scripts/bash/common.sh",
|
||||
".specify/scripts/bash/create-new-feature.sh",
|
||||
".specify/scripts/bash/resolve-template.sh",
|
||||
".specify/scripts/bash/setup-plan.sh",
|
||||
".specify/scripts/bash/setup-tasks.sh",
|
||||
# Templates
|
||||
|
||||
@@ -348,6 +348,7 @@ class TestGenericIntegration:
|
||||
".specify/scripts/bash/check-prerequisites.sh",
|
||||
".specify/scripts/bash/common.sh",
|
||||
".specify/scripts/bash/create-new-feature.sh",
|
||||
".specify/scripts/bash/resolve-template.sh",
|
||||
".specify/scripts/bash/setup-plan.sh",
|
||||
".specify/scripts/bash/setup-tasks.sh",
|
||||
".specify/templates/checklist-template.md",
|
||||
@@ -406,6 +407,7 @@ class TestGenericIntegration:
|
||||
".specify/scripts/powershell/check-prerequisites.ps1",
|
||||
".specify/scripts/powershell/common.ps1",
|
||||
".specify/scripts/powershell/create-new-feature.ps1",
|
||||
".specify/scripts/powershell/resolve-template.ps1",
|
||||
".specify/scripts/powershell/setup-plan.ps1",
|
||||
".specify/scripts/powershell/setup-tasks.ps1",
|
||||
".specify/templates/checklist-template.md",
|
||||
|
||||
@@ -28,7 +28,7 @@ ALL_INTEGRATION_KEYS = [
|
||||
"gemini", "tabnine",
|
||||
# Stage 5 — skills, generic & option-driven integrations
|
||||
"codex", "kimi", "agy", "zed", "generic",
|
||||
"droid",
|
||||
"droid", "command-code",
|
||||
]
|
||||
|
||||
|
||||
|
||||
@@ -109,6 +109,67 @@ def write_feature_json(
|
||||
)
|
||||
|
||||
|
||||
def install_composition_stack(
|
||||
repo: Path, template_name: str, core_content: str
|
||||
) -> str:
|
||||
"""Install wrap/prepend/append presets over a core template."""
|
||||
templates = repo / ".specify" / "templates"
|
||||
templates.mkdir(parents=True, exist_ok=True)
|
||||
(templates / f"{template_name}.md").write_text(core_content, encoding="utf-8")
|
||||
|
||||
layers = [
|
||||
("wrap-pack", 1, "wrap", "## Wrapper\n{CORE_TEMPLATE}\n## End\n"),
|
||||
("prepend-pack", 2, "prepend", "# Prepended\n"),
|
||||
("append-pack", 3, "append", "# Appended\n"),
|
||||
]
|
||||
registry: dict[str, object] = {"presets": {}}
|
||||
registry_presets = registry["presets"]
|
||||
assert isinstance(registry_presets, dict)
|
||||
|
||||
for preset_id, priority, strategy, content in layers:
|
||||
preset_dir = repo / ".specify" / "presets" / preset_id
|
||||
template_dir = preset_dir / "templates"
|
||||
template_dir.mkdir(parents=True)
|
||||
(template_dir / f"{template_name}.md").write_text(content, encoding="utf-8")
|
||||
(preset_dir / "preset.yml").write_text(
|
||||
"provides:\n"
|
||||
" templates:\n"
|
||||
" - type: template\n"
|
||||
f" name: {template_name}\n"
|
||||
f" file: templates/{template_name}.md\n"
|
||||
f" strategy: {strategy}\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
registry_presets[preset_id] = {
|
||||
"enabled": True,
|
||||
"priority": priority,
|
||||
}
|
||||
|
||||
(repo / ".specify" / "presets" / ".registry").write_text(
|
||||
json.dumps(registry, separators=(",", ":")) + "\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
appended = "# Appended\n"
|
||||
prepended = "# Prepended\n"
|
||||
wrapper = "## Wrapper\n{CORE_TEMPLATE}\n## End\n"
|
||||
composed = f"{core_content}\n\n{appended}"
|
||||
composed = f"{prepended}\n\n{composed}"
|
||||
return wrapper.replace("{CORE_TEMPLATE}", composed)
|
||||
|
||||
|
||||
def break_wrap_layer(repo: Path, template_name: str) -> None:
|
||||
"""Replace the installed wrap layer with one missing its placeholder."""
|
||||
(
|
||||
repo
|
||||
/ ".specify"
|
||||
/ "presets"
|
||||
/ "wrap-pack"
|
||||
/ "templates"
|
||||
/ f"{template_name}.md"
|
||||
).write_text("# Broken wrapper\n", encoding="utf-8")
|
||||
|
||||
|
||||
def normalize_repo_paths(text: str, repo: Path) -> str:
|
||||
"""Replace the repo path with a placeholder so two-repo runs compare equal."""
|
||||
repo_paths = sorted({str(repo), str(repo.resolve())}, key=len, reverse=True)
|
||||
|
||||
@@ -21,6 +21,7 @@ ISSUE_TEMPLATE_AGENT_KEYS = [
|
||||
"cline",
|
||||
"codebuddy",
|
||||
"codex",
|
||||
"command-code",
|
||||
"cursor-agent",
|
||||
"devin",
|
||||
"droid",
|
||||
|
||||
@@ -12,6 +12,7 @@ from pathlib import Path
|
||||
import pytest
|
||||
|
||||
from tests.conftest import requires_bash
|
||||
from tests.parity_helpers import install_composition_stack
|
||||
|
||||
PROJECT_ROOT = Path(__file__).resolve().parent.parent
|
||||
COMMON_SH = PROJECT_ROOT / "scripts" / "bash" / "common.sh"
|
||||
@@ -136,6 +137,87 @@ def _normalize_help_text(text: str) -> str:
|
||||
return "\n".join("" if not line.strip() else line for line in normalized.split("\n"))
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize("missing", [False, True], ids=["composed", "missing"])
|
||||
def test_all_variants_resolve_requested_template(
|
||||
prereq_repo: Path, missing: bool
|
||||
) -> None:
|
||||
_write_feature_json(prereq_repo)
|
||||
feature = prereq_repo / "specs" / "001-my-feature"
|
||||
feature.mkdir(parents=True)
|
||||
(feature / "plan.md").write_text("# Plan\n", encoding="utf-8")
|
||||
template_name = "missing-template" if missing else "checklist-template"
|
||||
expected = install_composition_stack(
|
||||
prereq_repo, "checklist-template", "# Checklist\n"
|
||||
)
|
||||
|
||||
results = [
|
||||
_run(
|
||||
_bash_cmd(prereq_repo, "--json", "--template", template_name),
|
||||
prereq_repo,
|
||||
),
|
||||
_run(
|
||||
_py_cmd(prereq_repo, "--json", "--template", template_name),
|
||||
prereq_repo,
|
||||
),
|
||||
]
|
||||
if HAS_PWSH or _WINDOWS_POWERSHELL:
|
||||
results.append(
|
||||
_run(
|
||||
_ps_cmd(prereq_repo, "-Json", "-Template", template_name),
|
||||
prereq_repo,
|
||||
)
|
||||
)
|
||||
|
||||
expected_status = 1 if missing else 0
|
||||
assert all(result.returncode == expected_status for result in results)
|
||||
if missing:
|
||||
assert all(result.stdout == "" for result in results)
|
||||
else:
|
||||
assert all(
|
||||
_json_stdout(result)["TEMPLATE_CONTENT"] == expected
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize("missing", [False, True], ids=["composed", "missing"])
|
||||
def test_all_variants_validate_requested_template_in_text_mode(
|
||||
prereq_repo: Path, missing: bool
|
||||
) -> None:
|
||||
_write_feature_json(prereq_repo)
|
||||
feature = prereq_repo / "specs" / "001-my-feature"
|
||||
feature.mkdir(parents=True)
|
||||
(feature / "plan.md").write_text("# Plan\n", encoding="utf-8")
|
||||
template_name = "missing-template" if missing else "checklist-template"
|
||||
install_composition_stack(
|
||||
prereq_repo, "checklist-template", "# Checklist\n"
|
||||
)
|
||||
|
||||
results = [
|
||||
_run(
|
||||
_bash_cmd(prereq_repo, "--template", template_name),
|
||||
prereq_repo,
|
||||
),
|
||||
_run(
|
||||
_py_cmd(prereq_repo, "--template", template_name),
|
||||
prereq_repo,
|
||||
),
|
||||
]
|
||||
if HAS_PWSH or _WINDOWS_POWERSHELL:
|
||||
results.append(
|
||||
_run(
|
||||
_ps_cmd(prereq_repo, "-Template", template_name),
|
||||
prereq_repo,
|
||||
)
|
||||
)
|
||||
|
||||
expected_status = 1 if missing else 0
|
||||
assert all(result.returncode == expected_status for result in results)
|
||||
if missing:
|
||||
assert all(result.stdout == "" for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
"args",
|
||||
|
||||
@@ -79,7 +79,7 @@ def test_template_renders_python_invocation(name: str):
|
||||
result = IntegrationBase.process_template(content, "agent", "py")
|
||||
assert "{SCRIPT}" not in result
|
||||
assert re.search(
|
||||
r"python3 \.specify/scripts/python/\w+\.py(?: --[\w-]+)*", result
|
||||
r"python3 \.specify/scripts/python/\w+\.py(?: [\w-]+)*", result
|
||||
), f"{name} did not render a Python invocation"
|
||||
|
||||
|
||||
|
||||
@@ -13,6 +13,8 @@ from tests.conftest import requires_bash
|
||||
from tests.parity_helpers import (
|
||||
HAS_POWERSHELL,
|
||||
bash_cmd,
|
||||
break_wrap_layer,
|
||||
install_composition_stack,
|
||||
install_scripts,
|
||||
json_stdout,
|
||||
make_repo,
|
||||
@@ -382,12 +384,108 @@ def test_python_full_run_matches_bash(repo_pair: tuple[Path, Path]) -> None:
|
||||
branch = json_stdout(py)["BRANCH_NAME"]
|
||||
for repo in repo_pair:
|
||||
spec = repo / "specs" / branch / "spec.md"
|
||||
assert spec.read_text(encoding="utf-8") == TEMPLATE_BODY
|
||||
assert spec.read_bytes() == TEMPLATE_BODY.encode("utf-8")
|
||||
assert (repo_b / ".specify" / "feature.json").read_bytes() == (
|
||||
repo_a / ".specify" / "feature.json"
|
||||
).read_bytes()
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_materialize_composed_spec_template(tmp_path: Path) -> None:
|
||||
repos = [
|
||||
_setup_repo(tmp_path, "bash"),
|
||||
_setup_repo(tmp_path, "powershell"),
|
||||
_setup_repo(tmp_path, "python"),
|
||||
]
|
||||
expected = ""
|
||||
for current in repos:
|
||||
expected = install_composition_stack(
|
||||
current, "spec-template", TEMPLATE_BODY
|
||||
)
|
||||
|
||||
bash = run(
|
||||
bash_cmd(
|
||||
repos[0],
|
||||
SCRIPT,
|
||||
"--json",
|
||||
"--number",
|
||||
"1",
|
||||
"--short-name",
|
||||
"composed",
|
||||
"x",
|
||||
),
|
||||
repos[0],
|
||||
)
|
||||
py = run(
|
||||
py_cmd(
|
||||
repos[2],
|
||||
SCRIPT,
|
||||
"--json",
|
||||
"--number",
|
||||
"1",
|
||||
"--short-name",
|
||||
"composed",
|
||||
"x",
|
||||
),
|
||||
repos[2],
|
||||
)
|
||||
results = [bash, py]
|
||||
checked_repos = [repos[0], repos[2]]
|
||||
if HAS_POWERSHELL:
|
||||
results.insert(
|
||||
1,
|
||||
run(
|
||||
ps_cmd(
|
||||
repos[1],
|
||||
SCRIPT,
|
||||
"-Json",
|
||||
"-Number",
|
||||
"1",
|
||||
"-ShortName",
|
||||
"composed",
|
||||
"x",
|
||||
),
|
||||
repos[1],
|
||||
),
|
||||
)
|
||||
checked_repos.insert(1, repos[1])
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
for current in checked_repos:
|
||||
assert (
|
||||
current / "specs" / "001-composed" / "spec.md"
|
||||
).read_text(encoding="utf-8") == expected
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_fail_for_broken_spec_composition(tmp_path: Path) -> None:
|
||||
repos = [
|
||||
_setup_repo(tmp_path, "bash"),
|
||||
_setup_repo(tmp_path, "powershell"),
|
||||
_setup_repo(tmp_path, "python"),
|
||||
]
|
||||
for current in repos:
|
||||
install_composition_stack(current, "spec-template", TEMPLATE_BODY)
|
||||
break_wrap_layer(current, "spec-template")
|
||||
|
||||
bash = run(bash_cmd(repos[0], SCRIPT, "--json", "x"), repos[0])
|
||||
py = run(py_cmd(repos[2], SCRIPT, "--json", "x"), repos[2])
|
||||
results = [(bash, repos[0]), (py, repos[2])]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(
|
||||
(
|
||||
run(ps_cmd(repos[1], SCRIPT, "-Json", "x"), repos[1]),
|
||||
repos[1],
|
||||
)
|
||||
)
|
||||
|
||||
assert all(result.returncode != 0 for result, _ in results)
|
||||
assert all(
|
||||
not (current / "specs" / "001-x").exists()
|
||||
for _, current in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_python_missing_template_warning_matches_bash(
|
||||
repo_pair: tuple[Path, Path],
|
||||
|
||||
@@ -1020,6 +1020,268 @@ provides:
|
||||
assert len(hash_value) > 10
|
||||
|
||||
|
||||
class TestExtensionManifestTemplatesAndScripts:
|
||||
"""Tests for the optional provides.templates / provides.scripts sections."""
|
||||
|
||||
def test_templates_and_scripts_declared(self, temp_dir, valid_manifest_data):
|
||||
"""A manifest declaring templates and scripts exposes them via properties."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["templates"] = [
|
||||
{
|
||||
"name": "myext-template",
|
||||
"file": "templates/myext-template.md",
|
||||
"description": "Report scaffold contributed by myext",
|
||||
}
|
||||
]
|
||||
valid_manifest_data["provides"]["scripts"] = [
|
||||
{
|
||||
"name": "myext-collect",
|
||||
"file": "scripts/bash/myext-collect.sh",
|
||||
"description": "Data-collection helper",
|
||||
"runtimes": ["bash", "python"],
|
||||
}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
manifest = ExtensionManifest(manifest_path)
|
||||
|
||||
assert manifest.templates == valid_manifest_data["provides"]["templates"]
|
||||
assert manifest.scripts == valid_manifest_data["provides"]["scripts"]
|
||||
assert manifest.warnings == []
|
||||
|
||||
def test_templates_only_extension_is_valid(self, temp_dir, valid_manifest_data):
|
||||
"""An extension with only a declared template (no commands/hooks/events) is valid."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["commands"] = []
|
||||
valid_manifest_data.pop("hooks", None)
|
||||
valid_manifest_data["provides"]["templates"] = [
|
||||
{"name": "myext-template", "file": "templates/myext-template.md"}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
manifest = ExtensionManifest(manifest_path)
|
||||
assert len(manifest.templates) == 1
|
||||
assert len(manifest.commands) == 0
|
||||
|
||||
def test_scripts_only_extension_is_valid(self, temp_dir, valid_manifest_data):
|
||||
"""An extension with only a declared script (no commands/hooks/events) is valid."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["commands"] = []
|
||||
valid_manifest_data.pop("hooks", None)
|
||||
valid_manifest_data["provides"]["scripts"] = [
|
||||
{"name": "myext-collect", "file": "scripts/bash/myext-collect.sh"}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
manifest = ExtensionManifest(manifest_path)
|
||||
assert len(manifest.scripts) == 1
|
||||
|
||||
def test_no_provides_at_all_still_rejected(self, temp_dir, valid_manifest_data):
|
||||
"""Without commands, hooks, events, templates, or scripts the manifest is
|
||||
still rejected — the relaxed rule only widens what counts, it doesn't
|
||||
drop the requirement that an extension provide *something*."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["commands"] = []
|
||||
valid_manifest_data.pop("hooks", None)
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="must provide at least one command, hook, or event"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
@pytest.mark.parametrize("section", ["templates", "scripts"])
|
||||
def test_provides_section_must_be_a_list(self, temp_dir, valid_manifest_data, section):
|
||||
"""provides.templates / provides.scripts must be a list, not e.g. a mapping."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"][section] = {"not": "a list"}
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match=f"Invalid provides.{section}: expected a list"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
@pytest.mark.parametrize("section", ["templates", "scripts"])
|
||||
def test_provides_entry_must_be_a_mapping(self, temp_dir, valid_manifest_data, section):
|
||||
"""Each provides.templates / provides.scripts entry must be a mapping."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"][section] = ["not-a-mapping"]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match=f"Each entry in 'provides.{section}' must be a mapping"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
@pytest.mark.parametrize("section", ["templates", "scripts"])
|
||||
def test_provides_entry_missing_name_or_file(self, temp_dir, valid_manifest_data, section):
|
||||
"""Each entry requires both 'name' and 'file'."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"][section] = [{"name": "only-a-name"}]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="missing 'name' or 'file'"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
@pytest.mark.parametrize("section", ["templates", "scripts"])
|
||||
def test_provides_entry_invalid_name_format(self, temp_dir, valid_manifest_data, section):
|
||||
"""Names must be lowercase alphanumeric with hyphens only."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"][section] = [
|
||||
{"name": "Bad_Name", "file": f"{section}/bad.txt"}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="must be lowercase alphanumeric with hyphens only"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
@pytest.mark.parametrize("section", ["templates", "scripts"])
|
||||
def test_provides_entry_duplicate_name_rejected(self, temp_dir, valid_manifest_data, section):
|
||||
"""Two entries in the same section sharing a name are rejected.
|
||||
|
||||
The resolver (PresetResolver._extension_manifest_declared_template)
|
||||
returns the first entry matching a name, so a later duplicate would
|
||||
be silently unreachable while still counted by ExtensionManifest
|
||||
properties -- reject it up front instead.
|
||||
"""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"][section] = [
|
||||
{"name": "dup", "file": f"{section}/a.txt"},
|
||||
{"name": "dup", "file": f"{section}/b.txt"},
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match=f"Duplicate .* name 'dup' in 'provides.{section}'"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
@pytest.mark.parametrize("section", ["templates", "scripts"])
|
||||
def test_provides_entry_path_traversal_rejected(self, temp_dir, valid_manifest_data, section):
|
||||
"""The 'file' field is checked with the same path-safety policy as commands."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"][section] = [
|
||||
{"name": "escape", "file": "../evil"}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="relative path within the extension directory"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
@pytest.mark.parametrize("section", ["templates", "scripts"])
|
||||
def test_provides_entry_strategy_rejected(self, temp_dir, valid_manifest_data, section):
|
||||
"""'strategy' is preset-only; extension-provided artifacts are always 'replace'."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"][section] = [
|
||||
{"name": "has-strategy", "file": f"{section}/x.txt", "strategy": "replace"}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="'strategy' is not authorable"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
def test_script_runtimes_accepted(self, temp_dir, valid_manifest_data):
|
||||
"""A valid 'runtimes' list on a script entry is accepted as-is."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["scripts"] = [
|
||||
{
|
||||
"name": "myext-collect",
|
||||
"file": "scripts/bash/myext-collect.sh",
|
||||
"runtimes": ["bash", "powershell", "python"],
|
||||
}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
manifest = ExtensionManifest(manifest_path)
|
||||
assert manifest.scripts[0]["runtimes"] == ["bash", "powershell", "python"]
|
||||
|
||||
def test_script_runtimes_must_be_a_list_of_strings(self, temp_dir, valid_manifest_data):
|
||||
"""A non-list 'runtimes' value is rejected."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["scripts"] = [
|
||||
{"name": "myext-collect", "file": "scripts/bash/myext-collect.sh", "runtimes": "bash"}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="expected a list of strings"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
def test_script_runtimes_rejects_unknown_runtime(self, temp_dir, valid_manifest_data):
|
||||
"""An unrecognized runtime name is rejected with the valid set in the message."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["scripts"] = [
|
||||
{"name": "myext-collect", "file": "scripts/bash/myext-collect.sh", "runtimes": ["ruby"]}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="Invalid runtimes.*must be one of"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
def test_provides_entry_description_must_be_a_string(self, temp_dir, valid_manifest_data):
|
||||
"""An optional 'description' field must be a string when present."""
|
||||
import yaml
|
||||
|
||||
valid_manifest_data["provides"]["templates"] = [
|
||||
{"name": "myext-template", "file": "templates/myext-template.md", "description": 123}
|
||||
]
|
||||
|
||||
manifest_path = temp_dir / "extension.yml"
|
||||
with open(manifest_path, 'w', encoding="utf-8") as f:
|
||||
yaml.dump(valid_manifest_data, f)
|
||||
|
||||
with pytest.raises(ValidationError, match="expected a string"):
|
||||
ExtensionManifest(manifest_path)
|
||||
|
||||
|
||||
# ===== ExtensionRegistry Tests =====
|
||||
|
||||
class TestExtensionRegistry:
|
||||
|
||||
@@ -57,3 +57,38 @@ def test_community_bundle_submission_automation_is_wired():
|
||||
assert "verified: false" in source_text
|
||||
assert "allowed-files:" in source_text
|
||||
assert "bundle-submission" in assignment_text
|
||||
|
||||
|
||||
def test_bug_test_workflow_provisions_python_dependencies():
|
||||
source = WORKFLOWS_DIR / "bug-test.md"
|
||||
compiled = WORKFLOWS_DIR / "bug-test.lock.yml"
|
||||
|
||||
assert source.is_file()
|
||||
assert compiled.is_file()
|
||||
source_text = source.read_text(encoding="utf-8")
|
||||
compiled_text = compiled.read_text(encoding="utf-8")
|
||||
|
||||
setup_uv = (
|
||||
"astral-sh/setup-uv@c771a70e6277c0a99b617c7a806ffedaca235ff9 # v9.0.0"
|
||||
)
|
||||
setup_python = (
|
||||
"actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0"
|
||||
)
|
||||
|
||||
assert " - pypi.org" in source_text
|
||||
assert " - files.pythonhosted.org" in source_text
|
||||
assert setup_uv in source_text
|
||||
assert setup_python in source_text
|
||||
assert 'run: uv pip install --system -e ".[test]"' in source_text
|
||||
|
||||
assert '"pypi.org"' in compiled_text
|
||||
assert '"files.pythonhosted.org"' in compiled_text
|
||||
checkout_index = compiled_text.index("- name: Checkout repository")
|
||||
uv_index = compiled_text.index("- name: Setup uv")
|
||||
python_index = compiled_text.index("- name: Set up Python")
|
||||
sync_index = compiled_text.index("- name: Install Python test dependencies")
|
||||
agent_index = compiled_text.index("- name: Execute GitHub Copilot CLI")
|
||||
assert checkout_index < uv_index < python_index < sync_index < agent_index
|
||||
assert setup_uv in compiled_text
|
||||
assert setup_python in compiled_text
|
||||
assert 'run: uv pip install --system -e ".[test]"' in compiled_text
|
||||
|
||||
+715
-33
@@ -1135,6 +1135,40 @@ class TestPresetResolver:
|
||||
result = resolver.resolve("nonexistent-template")
|
||||
assert result is None
|
||||
|
||||
def test_resolver_ignores_traversing_registry_ids(self, project_dir):
|
||||
"""Registry IDs cannot escape preset or extension install roots."""
|
||||
for registry_dir, registry_key, outside_name in (
|
||||
("presets", "presets", "outside-preset"),
|
||||
("extensions", "extensions", "outside-extension"),
|
||||
):
|
||||
outside = project_dir.parent / outside_name
|
||||
(outside / "templates").mkdir(parents=True)
|
||||
(outside / "templates" / "spec-template.md").write_text(
|
||||
f"# Sensitive {registry_key}\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
installed = project_dir / ".specify" / registry_dir
|
||||
installed.mkdir(parents=True, exist_ok=True)
|
||||
(installed / ".registry").write_text(
|
||||
json.dumps(
|
||||
{
|
||||
registry_key: {
|
||||
f"../../../{outside_name}": {
|
||||
"enabled": True,
|
||||
"priority": 1,
|
||||
}
|
||||
}
|
||||
}
|
||||
),
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
content = PresetResolver(project_dir).resolve_content("spec-template")
|
||||
|
||||
assert content is not None
|
||||
assert "Core Spec Template" in content
|
||||
assert "Sensitive" not in content
|
||||
|
||||
def test_resolve_higher_priority_pack_wins(self, project_dir, temp_dir, valid_pack_data):
|
||||
"""Test that a pack with lower priority number wins over higher number."""
|
||||
manager = PresetManager(project_dir)
|
||||
@@ -1447,6 +1481,65 @@ class TestPresetResolver:
|
||||
result = resolver.resolve("unique-disabled-template")
|
||||
assert result is None, "Disabled extension should not be picked up as unregistered"
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"registry_bytes",
|
||||
[b"{ not valid json", b'{"extensions": []}', b"[]"],
|
||||
ids=["invalid_json", "non_mapping_extensions", "non_mapping_root"],
|
||||
)
|
||||
def test_resolve_fails_closed_on_corrupt_extension_registry(
|
||||
self, project_dir, registry_bytes
|
||||
):
|
||||
"""A corrupt extension registry must fail closed rather than let the
|
||||
directory scan admit every on-disk extension as enabled."""
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
ext_templates_dir = extensions_dir / "sneaky-ext" / "templates"
|
||||
ext_templates_dir.mkdir(parents=True)
|
||||
(ext_templates_dir / "custom-template.md").write_text(
|
||||
"# Should not be served\n"
|
||||
)
|
||||
(extensions_dir / ".registry").write_bytes(registry_bytes)
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
with pytest.raises(PresetValidationError, match="Invalid extension registry"):
|
||||
resolver._get_all_extensions_by_priority()
|
||||
with pytest.raises(PresetValidationError, match="Invalid extension registry"):
|
||||
resolver.resolve("custom-template")
|
||||
|
||||
def test_resolve_fails_closed_when_registry_is_directory(self, project_dir):
|
||||
"""A directory at the registry path must fail closed, not be treated as
|
||||
an absent registry that enables every on-disk extension."""
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
ext_templates_dir = extensions_dir / "sneaky-ext" / "templates"
|
||||
ext_templates_dir.mkdir(parents=True)
|
||||
(ext_templates_dir / "custom-template.md").write_text(
|
||||
"# Should not be served\n"
|
||||
)
|
||||
(extensions_dir / ".registry").mkdir()
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
with pytest.raises(PresetValidationError, match="Invalid extension registry"):
|
||||
resolver.resolve("custom-template")
|
||||
|
||||
def test_resolve_fails_closed_when_registry_is_broken_symlink(self, project_dir):
|
||||
"""A dangling ``.registry`` symlink must fail closed. ``Path.exists()``
|
||||
follows symlinks and would mistake it for an absent registry, reopening
|
||||
the fail-open directory scan."""
|
||||
extensions_dir = project_dir / ".specify" / "extensions"
|
||||
ext_templates_dir = extensions_dir / "sneaky-ext" / "templates"
|
||||
ext_templates_dir.mkdir(parents=True)
|
||||
(ext_templates_dir / "custom-template.md").write_text(
|
||||
"# Should not be served\n"
|
||||
)
|
||||
(extensions_dir / ".registry").symlink_to(
|
||||
extensions_dir / "does-not-exist"
|
||||
)
|
||||
|
||||
registry = ExtensionRegistry(extensions_dir)
|
||||
assert registry.is_corrupt()
|
||||
resolver = PresetResolver(project_dir)
|
||||
with pytest.raises(PresetValidationError, match="Invalid extension registry"):
|
||||
resolver.resolve("custom-template")
|
||||
|
||||
def test_resolve_pack_over_extension(self, project_dir, pack_dir, temp_dir, valid_pack_data):
|
||||
"""Test that pack templates take priority over extension templates."""
|
||||
# Create extension with templates
|
||||
@@ -3454,6 +3547,9 @@ class TestPresetCatalogMultiCatalog:
|
||||
|
||||
|
||||
SELF_TEST_PRESET_DIR = Path(__file__).parent.parent / "presets" / "self-test"
|
||||
CONSTITUTION_SYNC_PRESET_DIR = (
|
||||
Path(__file__).parent.parent / "presets" / "constitution-sync"
|
||||
)
|
||||
SELF_TEST_WRAP_WARNING = (
|
||||
r"Cannot compose command 'speckit\.wrap-test': no base layer\. "
|
||||
r"Stale command files may remain\."
|
||||
@@ -3480,6 +3576,11 @@ def install_self_test_preset(manager: PresetManager, speckit_version: str = "0.1
|
||||
return manager.install_from_directory(SELF_TEST_PRESET_DIR, speckit_version)
|
||||
|
||||
|
||||
def install_constitution_sync_preset(manager: PresetManager) -> PresetManifest:
|
||||
"""Enable guarded install-time constitution materialization."""
|
||||
return manager.install_from_directory(CONSTITUTION_SYNC_PRESET_DIR, "0.15.0")
|
||||
|
||||
|
||||
def _make_convention_constitution_preset(temp_dir: Path) -> Path:
|
||||
"""Create a preset whose constitution is found by convention, not its manifest."""
|
||||
preset_dir = temp_dir / "convention-constitution"
|
||||
@@ -3612,6 +3713,7 @@ class TestSelfTestPreset:
|
||||
(templates_dir / f"{name}.md").write_text(f"# Core {name}\n")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
manager.remove("self-test")
|
||||
|
||||
@@ -3630,6 +3732,7 @@ class TestSelfTestPreset:
|
||||
(templates_dir / "constitution-template.md").write_text("# Core Constitution\n")
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
memory = project_dir / ".specify" / "memory" / "constitution.md"
|
||||
edited = memory.read_text() + "\n## Authored amendment\n"
|
||||
@@ -3713,19 +3816,16 @@ class TestSelfTestPreset:
|
||||
metadata = manager.registry.get("self-test")
|
||||
assert metadata["registered_commands"] == {}
|
||||
|
||||
def test_self_test_seeds_constitution_when_memory_absent(self, project_dir):
|
||||
"""Installing a preset seeds memory/constitution.md from its template."""
|
||||
def test_self_test_does_not_seed_constitution_without_sync(self, project_dir):
|
||||
"""Installing a preset does not materialize its constitution by default."""
|
||||
manager = PresetManager(project_dir)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
memory = project_dir / ".specify" / "memory" / "constitution.md"
|
||||
assert memory.exists(), "constitution.md was not seeded from the preset"
|
||||
assert "preset:self-test" in memory.read_text(), (
|
||||
"constitution.md was not seeded from the self-test preset template"
|
||||
)
|
||||
assert not memory.exists()
|
||||
|
||||
def test_self_test_reseeds_exact_core_constitution(self, project_dir):
|
||||
"""An unchanged core constitution is re-seeded from the preset template."""
|
||||
def test_self_test_preserves_generated_constitution_without_sync(self, project_dir):
|
||||
"""Preset install and removal preserve generated content without the opt-in."""
|
||||
resolver = PresetResolver(project_dir)
|
||||
bundled_core = resolver._find_bundled_core(
|
||||
"constitution-template", "template", ".md"
|
||||
@@ -3738,10 +3838,19 @@ class TestSelfTestPreset:
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_self_test_preset(manager)
|
||||
manager.remove("self-test")
|
||||
|
||||
content = memory.read_text()
|
||||
assert "preset:self-test" in content, "placeholder constitution was not re-seeded"
|
||||
assert "[PROJECT_NAME]" not in content
|
||||
assert memory.read_bytes() == core
|
||||
|
||||
def test_self_test_seeds_constitution_with_sync(self, project_dir):
|
||||
"""constitution-sync preserves the previous install-time seeding behavior."""
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
memory = project_dir / ".specify" / "memory" / "constitution.md"
|
||||
assert "preset:self-test" in memory.read_text()
|
||||
assert "[PROJECT_NAME]" not in memory.read_text()
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"provenance_content",
|
||||
@@ -3769,6 +3878,7 @@ class TestSelfTestPreset:
|
||||
original = memory.read_bytes()
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
assert memory.read_bytes() == original
|
||||
@@ -3785,6 +3895,7 @@ class TestSelfTestPreset:
|
||||
memory.write_text(authored)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
assert memory.read_text() == authored
|
||||
@@ -3831,7 +3942,9 @@ class TestSelfTestPreset:
|
||||
)
|
||||
)
|
||||
|
||||
PresetManager(project_dir).install_from_directory(preset_dir, "0.1.5")
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
manager.install_from_directory(preset_dir, "0.1.5")
|
||||
|
||||
assert memory.read_text() == authored
|
||||
assert not (memory.parent / ".constitution-template.json").exists()
|
||||
@@ -3846,6 +3959,7 @@ class TestSelfTestPreset:
|
||||
memory.write_text(authored)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
assert memory.read_text() == authored
|
||||
@@ -3858,6 +3972,7 @@ class TestSelfTestPreset:
|
||||
memory.write_text(authored)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
assert memory.read_text() == authored, "authored constitution was overwritten"
|
||||
@@ -3915,6 +4030,7 @@ class TestSelfTestPreset:
|
||||
)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
manager.install_from_directory(preset_dir, "0.1.5")
|
||||
|
||||
memory = project_dir / ".specify" / "memory" / "constitution.md"
|
||||
@@ -3928,6 +4044,7 @@ class TestSelfTestPreset:
|
||||
):
|
||||
"""An unchanged generated constitution follows priority and fallback layers."""
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
preset_dir = temp_dir / "higher-priority"
|
||||
@@ -3975,6 +4092,7 @@ class TestSelfTestPreset:
|
||||
):
|
||||
"""Removing a convention layer rematerializes the remaining resolver layer."""
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
manager.install_from_directory(
|
||||
_make_convention_constitution_preset(temp_dir), "0.1.5", priority=1
|
||||
@@ -3996,6 +4114,7 @@ class TestSelfTestPreset:
|
||||
templates_dir = project_dir / ".specify" / "templates"
|
||||
(templates_dir / "constitution-template.md").write_text("# Core Constitution\n")
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
manager.install_from_directory(
|
||||
_make_convention_constitution_preset(temp_dir), "0.1.5"
|
||||
)
|
||||
@@ -4013,6 +4132,7 @@ class TestSelfTestPreset:
|
||||
):
|
||||
"""Provenance triggers fallback when a custom-path manifest is invalid."""
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
preset_dir = temp_dir / "custom-constitution"
|
||||
@@ -4073,9 +4193,9 @@ class TestSelfTestPreset:
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
with pytest.warns(UserWarning, match="symlinked"):
|
||||
install_self_test_preset(manager)
|
||||
install_constitution_sync_preset(manager)
|
||||
|
||||
assert manager.registry.is_installed("self-test")
|
||||
assert manager.registry.is_installed("constitution-sync")
|
||||
assert not (outside / "constitution.md").exists()
|
||||
|
||||
def test_constitution_seed_rejects_dangling_destination_symlink(
|
||||
@@ -4092,9 +4212,9 @@ class TestSelfTestPreset:
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
with pytest.warns(UserWarning, match="symlinked"):
|
||||
install_self_test_preset(manager)
|
||||
install_constitution_sync_preset(manager)
|
||||
|
||||
assert manager.registry.is_installed("self-test")
|
||||
assert manager.registry.is_installed("constitution-sync")
|
||||
assert not outside.exists()
|
||||
|
||||
def test_constitution_materialization_error_is_nonfatal(
|
||||
@@ -4133,6 +4253,7 @@ class TestSelfTestPreset:
|
||||
)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
with pytest.warns(UserWarning, match="Failed to seed constitution"):
|
||||
manifest = manager.install_from_directory(preset_dir, "0.1.5")
|
||||
|
||||
@@ -4727,6 +4848,163 @@ class TestPresetSkills:
|
||||
parsed = yaml.safe_load(skill_file.read_text(encoding="utf-8").split("---", 2)[1])
|
||||
assert "argument-hint" not in parsed
|
||||
|
||||
def test_wrap_preset_inherits_argument_hint_from_core(self, project_dir, temp_dir):
|
||||
"""A wrap-strategy preset that omits argument-hint must inherit it from the core template.
|
||||
|
||||
Regression for issue #3991: the wrap-composition path in _register_skills
|
||||
previously inherited only scripts/agent_scripts from core_frontmatter,
|
||||
silently discarding argument-hint and leaking its value into description.
|
||||
"""
|
||||
core_arg_hint = "Describe the feature you want to specify"
|
||||
preset_description = "Wrapped speckit.specify — extra project context added"
|
||||
self._write_init_options(project_dir, ai="claude")
|
||||
skills_dir = project_dir / ".claude" / "skills"
|
||||
self._create_skill(skills_dir, "speckit-specify")
|
||||
|
||||
# Place a core template that declares argument-hint
|
||||
core_cmds = project_dir / ".specify" / "templates" / "commands"
|
||||
core_cmds.mkdir(parents=True, exist_ok=True)
|
||||
(core_cmds / "specify.md").write_text(
|
||||
"---\n"
|
||||
"description: Core specify description.\n"
|
||||
f'argument-hint: "{core_arg_hint}"\n'
|
||||
"---\n\n"
|
||||
"Core specify body.\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
# Wrap preset: only declares description (no argument-hint)
|
||||
preset_dir = temp_dir / "wrap-hint-preset"
|
||||
preset_dir.mkdir()
|
||||
(preset_dir / "commands").mkdir()
|
||||
(preset_dir / "commands" / "speckit.specify.md").write_text(
|
||||
"---\n"
|
||||
f'description: "{preset_description}"\n'
|
||||
"strategy: wrap\n"
|
||||
"---\n\n"
|
||||
"{CORE_TEMPLATE}\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
manifest_data = {
|
||||
"schema_version": "1.0",
|
||||
"preset": {
|
||||
"id": "wrap-hint-preset",
|
||||
"name": "Wrap Hint Preset",
|
||||
"version": "1.0.0",
|
||||
"description": "Test wrap hint inheritance",
|
||||
},
|
||||
"requires": {"speckit_version": ">=0.1.0"},
|
||||
"provides": {
|
||||
"templates": [
|
||||
{
|
||||
"type": "command",
|
||||
"name": "speckit.specify",
|
||||
"file": "commands/speckit.specify.md",
|
||||
"strategy": "wrap",
|
||||
}
|
||||
]
|
||||
},
|
||||
}
|
||||
import yaml as _yaml
|
||||
with open(preset_dir / "preset.yml", "w") as f:
|
||||
_yaml.dump(manifest_data, f)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(preset_dir, "1.0.0")
|
||||
|
||||
skill_file = skills_dir / "speckit-specify" / "SKILL.md"
|
||||
assert skill_file.exists()
|
||||
parsed = yaml.safe_load(skill_file.read_text(encoding="utf-8").split("---", 2)[1])
|
||||
# argument-hint must be inherited from core, not dropped
|
||||
assert parsed.get("argument-hint") == core_arg_hint, (
|
||||
f"argument-hint was not inherited from core; parsed={parsed}"
|
||||
)
|
||||
# description must be exactly the preset's declared value, not concatenated
|
||||
assert parsed["description"] == preset_description, (
|
||||
f"description was corrupted; parsed={parsed}"
|
||||
)
|
||||
|
||||
def test_wrap_preset_inherits_argument_hint_for_unmapped_command(self, project_dir, temp_dir):
|
||||
"""Wrap inheritance must carry argument-hint for a command NOT in ARGUMENT_HINTS.
|
||||
|
||||
Regression guard for issue #3991. The companion test above wraps
|
||||
``speckit.specify``, whose stem is in Claude's ``ARGUMENT_HINTS`` map, so
|
||||
the string-injection fallback in ``post_process_skill_content`` re-adds
|
||||
``argument-hint`` even when wrap composition drops it — masking the bug.
|
||||
This test wraps an extension-like command (``speckit.myfeature``) that is
|
||||
absent from that map, so the *only* thing that can carry the hint into the
|
||||
SKILL.md is the wrap-composition inheritance fix itself. Without the fix
|
||||
the key is dropped and this test fails.
|
||||
"""
|
||||
core_arg_hint = "Custom hint that lives only on the core template"
|
||||
preset_description = "Wrapped speckit.myfeature — extra project context added"
|
||||
self._write_init_options(project_dir, ai="claude")
|
||||
skills_dir = project_dir / ".claude" / "skills"
|
||||
self._create_skill(skills_dir, "speckit-myfeature")
|
||||
|
||||
# Place a core template (extension-like command) that declares argument-hint
|
||||
core_cmds = project_dir / ".specify" / "templates" / "commands"
|
||||
core_cmds.mkdir(parents=True, exist_ok=True)
|
||||
(core_cmds / "myfeature.md").write_text(
|
||||
"---\n"
|
||||
"description: Core myfeature description.\n"
|
||||
f'argument-hint: "{core_arg_hint}"\n'
|
||||
"---\n\n"
|
||||
"Core myfeature body.\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
# Wrap preset: only declares description (no argument-hint)
|
||||
preset_dir = temp_dir / "wrap-hint-preset-unmapped"
|
||||
preset_dir.mkdir()
|
||||
(preset_dir / "commands").mkdir()
|
||||
(preset_dir / "commands" / "speckit.myfeature.md").write_text(
|
||||
"---\n"
|
||||
f'description: "{preset_description}"\n'
|
||||
"strategy: wrap\n"
|
||||
"---\n\n"
|
||||
"{CORE_TEMPLATE}\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
manifest_data = {
|
||||
"schema_version": "1.0",
|
||||
"preset": {
|
||||
"id": "wrap-hint-preset-unmapped",
|
||||
"name": "Wrap Hint Preset Unmapped",
|
||||
"version": "1.0.0",
|
||||
"description": "Test wrap hint inheritance for an unmapped command",
|
||||
},
|
||||
"requires": {"speckit_version": ">=0.1.0"},
|
||||
"provides": {
|
||||
"templates": [
|
||||
{
|
||||
"type": "command",
|
||||
"name": "speckit.myfeature",
|
||||
"file": "commands/speckit.myfeature.md",
|
||||
"strategy": "wrap",
|
||||
}
|
||||
]
|
||||
},
|
||||
}
|
||||
import yaml as _yaml
|
||||
with open(preset_dir / "preset.yml", "w") as f:
|
||||
_yaml.dump(manifest_data, f)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(preset_dir, "1.0.0")
|
||||
|
||||
skill_file = skills_dir / "speckit-myfeature" / "SKILL.md"
|
||||
assert skill_file.exists()
|
||||
parsed = yaml.safe_load(skill_file.read_text(encoding="utf-8").split("---", 2)[1])
|
||||
# argument-hint must be inherited from core, not dropped
|
||||
assert parsed.get("argument-hint") == core_arg_hint, (
|
||||
f"argument-hint was not inherited from core; parsed={parsed}"
|
||||
)
|
||||
# description must be exactly the preset's declared value, not concatenated
|
||||
assert parsed["description"] == preset_description, (
|
||||
f"description was corrupted; parsed={parsed}"
|
||||
)
|
||||
|
||||
def test_register_skills_resolves_command_refs(self, project_dir, temp_dir):
|
||||
"""Preset skill overrides must resolve __SPECKIT_COMMAND_*__ tokens (issue #2717).
|
||||
|
||||
@@ -9174,6 +9452,155 @@ class TestPresetSkills:
|
||||
"---\nname: speckit-specify\n---\n\nuser-owned content\n"
|
||||
)
|
||||
|
||||
def test_unregister_skills_in_dir_unreadable_core_template_skips(
|
||||
self, project_dir
|
||||
):
|
||||
"""An undecodable core template must not crash `preset remove`.
|
||||
|
||||
Every other failure in the restore loop — an unsafe registry name,
|
||||
a missing skill subdirectory, a foreign owner — skips the skill
|
||||
with ``continue``. The core-template read was outside that
|
||||
boundary, so one non-UTF-8 project-owned override in
|
||||
``.specify/templates/commands/`` raised a raw ``UnicodeDecodeError``
|
||||
straight out of ``PresetManager.remove()``, which has no handler
|
||||
for it. Sibling reads of the very same directory are already
|
||||
guarded (``_substitute_core_template``, the provenance reads in
|
||||
``_infer_legacy_skill_provenance``).
|
||||
"""
|
||||
self._write_init_options(project_dir, ai="claude", ai_skills=True)
|
||||
skills_dir = project_dir / ".claude" / "skills"
|
||||
skill_dir = self._create_skill(
|
||||
skills_dir, "speckit-specify", "installed content"
|
||||
)
|
||||
core_commands = project_dir / ".specify" / "templates" / "commands"
|
||||
core_commands.mkdir(parents=True, exist_ok=True)
|
||||
(core_commands / "specify.md").write_bytes(
|
||||
b"---\ndescription: \xff\xfe not utf-8\n---\n\nCore body\n"
|
||||
)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
with pytest.warns(UserWarning, match="speckit-specify"):
|
||||
mutated = manager._unregister_skills_in_dir(
|
||||
["speckit-specify"], skills_dir, "claude"
|
||||
)
|
||||
|
||||
assert mutated == [], (
|
||||
"a skill whose restore source could not be read was not "
|
||||
"restored, so it must not be reported as mutated"
|
||||
)
|
||||
assert (skill_dir / "SKILL.md").read_text(encoding="utf-8") == (
|
||||
"---\nname: speckit-specify\n---\n\ninstalled content\n"
|
||||
), (
|
||||
"an unreadable core template must leave the skill untouched — "
|
||||
"falling through to the rmtree branch would delete it exactly "
|
||||
"when its replacement cannot be generated"
|
||||
)
|
||||
|
||||
def test_unregister_skills_in_dir_unreadable_core_template_oserror_skips(
|
||||
self, project_dir, monkeypatch
|
||||
):
|
||||
"""The same boundary must cover ``OSError`` (e.g. permission denied).
|
||||
|
||||
Mocked rather than chmod-based so the case also holds under
|
||||
privileged CI, where permission bits are not enforced.
|
||||
"""
|
||||
self._write_init_options(project_dir, ai="claude", ai_skills=True)
|
||||
skills_dir = project_dir / ".claude" / "skills"
|
||||
skill_dir = self._create_skill(
|
||||
skills_dir, "speckit-specify", "installed content"
|
||||
)
|
||||
core_commands = project_dir / ".specify" / "templates" / "commands"
|
||||
core_commands.mkdir(parents=True, exist_ok=True)
|
||||
core_template = core_commands / "specify.md"
|
||||
core_template.write_text(
|
||||
"---\ndescription: Core specify\n---\n\nCore body\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
original_read_text = Path.read_text
|
||||
|
||||
def failing_read_text(self_path, *args, **kwargs):
|
||||
if self_path == core_template:
|
||||
raise PermissionError(13, "Permission denied")
|
||||
return original_read_text(self_path, *args, **kwargs)
|
||||
|
||||
monkeypatch.setattr(Path, "read_text", failing_read_text)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
with pytest.warns(UserWarning, match="speckit-specify"):
|
||||
mutated = manager._unregister_skills_in_dir(
|
||||
["speckit-specify"], skills_dir, "claude"
|
||||
)
|
||||
|
||||
monkeypatch.undo()
|
||||
|
||||
assert mutated == []
|
||||
assert (skill_dir / "SKILL.md").read_text(encoding="utf-8") == (
|
||||
"---\nname: speckit-specify\n---\n\ninstalled content\n"
|
||||
)
|
||||
|
||||
def test_unregister_skills_in_dir_unreadable_extension_source_skips(
|
||||
self, project_dir
|
||||
):
|
||||
"""The extension-restore arm needs the same boundary as the core arm.
|
||||
|
||||
The two restore reads are independent branches — a skill backed by an
|
||||
installed extension never reaches the core-template read — so this
|
||||
half of the guard can regress on its own. An undecodable extension
|
||||
command file must warn, leave the skill byte-for-byte intact, and stay
|
||||
out of ``mutated_names``.
|
||||
"""
|
||||
self._write_init_options(project_dir, ai="claude", ai_skills=True)
|
||||
skills_dir = project_dir / ".claude" / "skills"
|
||||
skill_dir = self._create_skill(
|
||||
skills_dir, "speckit-fakeext-cmd", "installed content"
|
||||
)
|
||||
|
||||
extension_dir = project_dir / ".specify" / "extensions" / "fakeext"
|
||||
(extension_dir / "commands").mkdir(parents=True, exist_ok=True)
|
||||
(extension_dir / "commands" / "cmd.md").write_bytes(
|
||||
b"---\ndescription: \xff\xfe not utf-8\n---\n\nExtension body\n"
|
||||
)
|
||||
extension_manifest = {
|
||||
"schema_version": "1.0",
|
||||
"extension": {
|
||||
"id": "fakeext",
|
||||
"name": "Fake Extension",
|
||||
"version": "1.0.0",
|
||||
"description": "Test",
|
||||
},
|
||||
"requires": {"speckit_version": ">=0.1.0"},
|
||||
"provides": {
|
||||
"commands": [
|
||||
{
|
||||
"name": "speckit.fakeext.cmd",
|
||||
"file": "commands/cmd.md",
|
||||
"description": "Fake extension command",
|
||||
}
|
||||
]
|
||||
},
|
||||
}
|
||||
with open(extension_dir / "extension.yml", "w") as f:
|
||||
yaml.dump(extension_manifest, f)
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
with pytest.warns(UserWarning, match="speckit-fakeext-cmd"):
|
||||
mutated = manager._unregister_skills_in_dir(
|
||||
["speckit-fakeext-cmd"], skills_dir, "claude"
|
||||
)
|
||||
|
||||
assert mutated == [], (
|
||||
"a skill whose extension restore source could not be read was "
|
||||
"not restored, so it must not be reported as mutated"
|
||||
)
|
||||
assert (skill_dir / "SKILL.md").read_text(encoding="utf-8") == (
|
||||
"---\nname: speckit-fakeext-cmd\n---\n\ninstalled content\n"
|
||||
), (
|
||||
"an unreadable extension source must leave the skill untouched — "
|
||||
"falling through to the rmtree branch would delete it exactly "
|
||||
"when its replacement cannot be generated"
|
||||
)
|
||||
|
||||
def test_unregister_skills_in_dir_rejects_absolute_registry_name(
|
||||
self, project_dir
|
||||
):
|
||||
@@ -9629,6 +10056,7 @@ class TestPresetSetPriority:
|
||||
from specify_cli import app
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
manager.install_from_directory(
|
||||
_make_convention_constitution_preset(temp_dir), "0.1.5", priority=20
|
||||
@@ -9874,6 +10302,7 @@ class TestPresetEnableDisable:
|
||||
from specify_cli import app
|
||||
|
||||
manager = PresetManager(project_dir)
|
||||
install_constitution_sync_preset(manager)
|
||||
install_self_test_preset(manager)
|
||||
manager.install_from_directory(
|
||||
_make_convention_constitution_preset(temp_dir), "0.1.5", priority=1
|
||||
@@ -10094,6 +10523,29 @@ def test_constitution_commands_guard_against_non_governance_work(command_path):
|
||||
assert "do not invoke it" in normalized_content or "without invoking it" in normalized_content
|
||||
|
||||
|
||||
def test_core_constitution_command_resolves_template_at_runtime():
|
||||
"""The core command must consume the composed scaffold on every invocation."""
|
||||
content = CORE_CONSTITUTION_COMMAND.read_text()
|
||||
|
||||
assert "resolve-template.sh constitution-template --json" in content
|
||||
assert "resolve-template.ps1 constitution-template -Json" in content
|
||||
assert "resolve_template.py constitution-template --json" in content
|
||||
assert "parse `TEMPLATE_CONTENT` as the active template" in content
|
||||
assert "do not continue with only one contributing" in content
|
||||
assert "Do not write back to any versioned template layer" in content
|
||||
|
||||
|
||||
def test_core_checklist_command_resolves_template_at_runtime():
|
||||
"""The checklist command must consume the composed scaffold."""
|
||||
content = (CORE_CONSTITUTION_COMMAND.parent / "checklist.md").read_text(
|
||||
encoding="utf-8"
|
||||
)
|
||||
|
||||
assert "--template checklist-template" in content
|
||||
assert "TEMPLATE_CONTENT" in content
|
||||
assert "Use TEMPLATE_CONTENT as the structural template" in content
|
||||
|
||||
|
||||
class TestLeanPreset:
|
||||
"""Tests for the lean preset that ships with the repo."""
|
||||
|
||||
@@ -10790,6 +11242,35 @@ class TestWrapStrategy:
|
||||
assert "{CORE_TEMPLATE}" in result
|
||||
assert core_fm == {}
|
||||
|
||||
def test_substitute_core_template_unreadable_core_treated_as_missing(
|
||||
self, project_dir
|
||||
):
|
||||
"""An undecodable core template must not crash substitution.
|
||||
|
||||
The wrap-strategy callers (``CommandRegistrar.register_pack`` and
|
||||
``_register_commands``) skip an unreadable preset source with a
|
||||
warning, but the core template read inside
|
||||
``_substitute_core_template`` had no boundary, so one corrupted
|
||||
project-owned override in ``.specify/templates/commands/`` crashed
|
||||
the whole registration with a raw ``UnicodeDecodeError``. An
|
||||
unreadable core is treated like a missing one.
|
||||
"""
|
||||
from specify_cli.presets import _substitute_core_template
|
||||
from specify_cli.agents import CommandRegistrar
|
||||
|
||||
core_dir = project_dir / ".specify" / "templates" / "commands"
|
||||
core_dir.mkdir(parents=True, exist_ok=True)
|
||||
(core_dir / "specify.md").write_bytes(b"\xff\xfe not utf-8")
|
||||
|
||||
registrar = CommandRegistrar()
|
||||
body = "Pre.\n\n{CORE_TEMPLATE}\n\nPost.\n"
|
||||
with pytest.warns(UserWarning, match="Ignoring core template"):
|
||||
result, core_fm = _substitute_core_template(
|
||||
body, "specify", project_dir, registrar
|
||||
)
|
||||
assert result == body
|
||||
assert core_fm == {}
|
||||
|
||||
def test_register_commands_substitutes_core_template_for_wrap_strategy(self, project_dir):
|
||||
"""register_commands substitutes {CORE_TEMPLATE} when strategy: wrap."""
|
||||
from specify_cli.agents import CommandRegistrar
|
||||
@@ -11220,6 +11701,181 @@ class TestWrapStrategy:
|
||||
assert "# Selftest Core" in result
|
||||
assert "{CORE_TEMPLATE}" not in result
|
||||
|
||||
def test_extension_template_resolves_via_manifest_when_filename_differs(self, project_dir):
|
||||
"""provides.templates entries resolve via extension.yml when the file
|
||||
doesn't sit at the conventional path.
|
||||
|
||||
Regression coverage for #4010: manifest-declared templates/scripts
|
||||
must actually be consulted by the resolver, not just accepted by
|
||||
manifest validation.
|
||||
"""
|
||||
ext_dir = project_dir / ".specify" / "extensions" / "reportext"
|
||||
tmpl_dir = ext_dir / "templates" / "nested"
|
||||
tmpl_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# File lives at a path convention-based lookup (templates/<name>.md)
|
||||
# would never find.
|
||||
(tmpl_dir / "actual.md").write_text("# Report Scaffold\n")
|
||||
(ext_dir / "extension.yml").write_text(
|
||||
"schema_version: '1.0'\n"
|
||||
"extension:\n id: reportext\n name: Report Ext\n version: 1.0.0\n"
|
||||
" description: test\n author: test\n repository: https://example.com\n"
|
||||
" license: MIT\n"
|
||||
"requires:\n speckit_version: '>=0.2.0'\n"
|
||||
"provides:\n"
|
||||
" templates:\n"
|
||||
" - name: report-scaffold\n"
|
||||
" file: templates/nested/actual.md\n"
|
||||
" description: Report scaffold\n"
|
||||
)
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
layers = resolver.collect_all_layers("report-scaffold", "template")
|
||||
assert layers, "expected the manifest-declared template to resolve"
|
||||
assert layers[0]["path"] == tmpl_dir / "actual.md"
|
||||
assert layers[0]["strategy"] == "replace"
|
||||
|
||||
def test_extension_script_resolves_via_manifest_when_filename_differs(self, project_dir):
|
||||
"""provides.scripts entries resolve via extension.yml when the file
|
||||
doesn't sit at the conventional path."""
|
||||
ext_dir = project_dir / ".specify" / "extensions" / "collectext"
|
||||
script_dir = ext_dir / "scripts" / "bash"
|
||||
script_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# File is under scripts/bash/, not directly under scripts/, so
|
||||
# convention-based lookup (scripts/<name>.sh) would never find it.
|
||||
(script_dir / "collect.sh").write_text("#!/usr/bin/env bash\necho collect\n")
|
||||
(ext_dir / "extension.yml").write_text(
|
||||
"schema_version: '1.0'\n"
|
||||
"extension:\n id: collectext\n name: Collect Ext\n version: 1.0.0\n"
|
||||
" description: test\n author: test\n repository: https://example.com\n"
|
||||
" license: MIT\n"
|
||||
"requires:\n speckit_version: '>=0.2.0'\n"
|
||||
"provides:\n"
|
||||
" scripts:\n"
|
||||
" - name: myext-collect\n"
|
||||
" file: scripts/bash/collect.sh\n"
|
||||
" description: Data-collection helper\n"
|
||||
" runtimes: [bash]\n"
|
||||
)
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
layers = resolver.collect_all_layers("myext-collect", "script")
|
||||
assert layers, "expected the manifest-declared script to resolve"
|
||||
assert layers[0]["path"] == script_dir / "collect.sh"
|
||||
assert layers[0]["strategy"] == "replace"
|
||||
|
||||
def test_extension_template_convention_lookup_unaffected_when_undeclared(self, project_dir):
|
||||
"""An extension template with no manifest entry still resolves via
|
||||
the pre-existing filename convention (no regression)."""
|
||||
ext_dir = project_dir / ".specify" / "extensions" / "conventionext"
|
||||
tmpl_dir = ext_dir / "templates"
|
||||
tmpl_dir.mkdir(parents=True, exist_ok=True)
|
||||
(tmpl_dir / "legacy-template.md").write_text("# Legacy Template\n")
|
||||
# No extension.yml at all -- purely convention-based, unregistered extension.
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
layers = resolver.collect_all_layers("legacy-template", "template")
|
||||
assert layers, "expected convention-based lookup to still find the template"
|
||||
assert layers[0]["path"] == tmpl_dir / "legacy-template.md"
|
||||
|
||||
def test_extension_manifest_wins_over_stale_conventional_file(self, project_dir):
|
||||
"""A declared entry is authoritative even when a stale file also sits at
|
||||
the conventional path (templates/<name>.md) — the manifest must win,
|
||||
not the convention lookup, per #4010's acceptance criteria."""
|
||||
ext_dir = project_dir / ".specify" / "extensions" / "bothpathsext"
|
||||
(ext_dir / "templates").mkdir(parents=True, exist_ok=True)
|
||||
(ext_dir / "custom").mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# Stale file at the conventional path -- must NOT win.
|
||||
(ext_dir / "templates" / "report-scaffold.md").write_text("# Stale\n")
|
||||
# Declared file at a non-conventional path -- must win.
|
||||
(ext_dir / "custom" / "bar.md").write_text("# Actual\n")
|
||||
(ext_dir / "extension.yml").write_text(
|
||||
"schema_version: '1.0'\n"
|
||||
"extension:\n id: bothpathsext\n name: Both Paths Ext\n version: 1.0.0\n"
|
||||
" description: test\n author: test\n repository: https://example.com\n"
|
||||
" license: MIT\n"
|
||||
"requires:\n speckit_version: '>=0.2.0'\n"
|
||||
"provides:\n"
|
||||
" templates:\n"
|
||||
" - name: report-scaffold\n"
|
||||
" file: custom/bar.md\n"
|
||||
" description: Report scaffold\n"
|
||||
)
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
|
||||
layers = resolver.collect_all_layers("report-scaffold", "template")
|
||||
assert layers, "expected the manifest-declared template to resolve"
|
||||
assert layers[0]["path"] == ext_dir / "custom" / "bar.md"
|
||||
|
||||
resolved = resolver.resolve("report-scaffold", "template")
|
||||
assert resolved == ext_dir / "custom" / "bar.md"
|
||||
|
||||
with_source = resolver.resolve_with_source("report-scaffold", "template")
|
||||
assert with_source["path"] == str(ext_dir / "custom" / "bar.md")
|
||||
|
||||
def test_extension_manifest_declared_but_missing_file_does_not_fall_back(self, project_dir):
|
||||
"""A declared entry whose file is missing is authoritative -- the
|
||||
resolver must not silently mask the typo by falling back to a
|
||||
conventional file that happens to also exist."""
|
||||
ext_dir = project_dir / ".specify" / "extensions" / "missingfileext"
|
||||
(ext_dir / "scripts").mkdir(parents=True, exist_ok=True)
|
||||
|
||||
# A conventional file exists, but the manifest declares a different,
|
||||
# non-existent file for the same name.
|
||||
(ext_dir / "scripts" / "myext-collect.sh").write_text("#!/usr/bin/env bash\necho legacy\n")
|
||||
(ext_dir / "extension.yml").write_text(
|
||||
"schema_version: '1.0'\n"
|
||||
"extension:\n id: missingfileext\n name: Missing File Ext\n version: 1.0.0\n"
|
||||
" description: test\n author: test\n repository: https://example.com\n"
|
||||
" license: MIT\n"
|
||||
"requires:\n speckit_version: '>=0.2.0'\n"
|
||||
"provides:\n"
|
||||
" scripts:\n"
|
||||
" - name: myext-collect\n"
|
||||
" file: scripts/does-not-exist.sh\n"
|
||||
" description: Data-collection helper\n"
|
||||
)
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
|
||||
assert resolver.collect_all_layers("myext-collect", "script") == []
|
||||
assert resolver.resolve("myext-collect", "script") is None
|
||||
|
||||
def test_extension_script_resolve_and_resolve_with_source_parity(self, project_dir):
|
||||
"""resolve() and resolve_with_source() must find a manifest-declared
|
||||
script at a non-conventional path, matching collect_all_layers()."""
|
||||
ext_dir = project_dir / ".specify" / "extensions" / "collectext2"
|
||||
script_dir = ext_dir / "scripts" / "bash"
|
||||
script_dir.mkdir(parents=True, exist_ok=True)
|
||||
|
||||
(script_dir / "collect.sh").write_text("#!/usr/bin/env bash\necho collect\n")
|
||||
(ext_dir / "extension.yml").write_text(
|
||||
"schema_version: '1.0'\n"
|
||||
"extension:\n id: collectext2\n name: Collect Ext 2\n version: 1.0.0\n"
|
||||
" description: test\n author: test\n repository: https://example.com\n"
|
||||
" license: MIT\n"
|
||||
"requires:\n speckit_version: '>=0.2.0'\n"
|
||||
"provides:\n"
|
||||
" scripts:\n"
|
||||
" - name: myext-collect2\n"
|
||||
" file: scripts/bash/collect.sh\n"
|
||||
" description: Data-collection helper\n"
|
||||
" runtimes: [bash]\n"
|
||||
)
|
||||
|
||||
resolver = PresetResolver(project_dir)
|
||||
|
||||
resolved = resolver.resolve("myext-collect2", "script")
|
||||
assert resolved == script_dir / "collect.sh"
|
||||
|
||||
with_source = resolver.resolve_with_source("myext-collect2", "script")
|
||||
assert with_source is not None
|
||||
assert with_source["path"] == str(script_dir / "collect.sh")
|
||||
assert with_source["source"] == "extension:collectext2 (unregistered)"
|
||||
|
||||
|
||||
# ===== _replay_wraps_for_command Tests =====
|
||||
|
||||
@@ -12418,10 +13074,10 @@ def test_preset_wrapper_resolves_ghes_asset_when_host_configured(tmp_path, monke
|
||||
class TestEnsureConstitutionResolverAware:
|
||||
"""`ensure_constitution_from_template` must resolve through PresetResolver.
|
||||
|
||||
The constitution is the only template materialized to a live file rather
|
||||
than resolved on demand. These tests pin the regression from issue #3272:
|
||||
a preset-provided ``constitution-template`` must seed memory, while the
|
||||
core template is used when no preset overrides it.
|
||||
Init materializes the live constitution once, while later /constitution
|
||||
runs resolve on demand. These tests pin the regression from issue #3272:
|
||||
a preset-provided ``constitution-template`` must win during the init seed,
|
||||
while the core template is used when no preset overrides it.
|
||||
"""
|
||||
|
||||
def _core_constitution(self, project_dir):
|
||||
@@ -12482,10 +13138,8 @@ class TestEnsureConstitutionResolverAware:
|
||||
manager = PresetManager(project_dir)
|
||||
install_self_test_preset(manager)
|
||||
|
||||
# Remove the memory file seeded during install to test ensure() in
|
||||
# isolation; it must re-seed from the preset, not the core template.
|
||||
memory = project_dir / ".specify" / "memory" / "constitution.md"
|
||||
memory.unlink()
|
||||
assert not memory.exists()
|
||||
|
||||
ensure_constitution_from_template(project_dir)
|
||||
|
||||
@@ -12528,9 +13182,8 @@ class TestEnsureConstitutionResolverAware:
|
||||
manager = PresetManager(project_dir)
|
||||
manager.install_from_directory(self._wrap_constitution_preset(temp_dir), "0.1.5")
|
||||
|
||||
# Ensure we validate ensure() behavior directly.
|
||||
memory = project_dir / ".specify" / "memory" / "constitution.md"
|
||||
memory.unlink()
|
||||
assert not memory.exists()
|
||||
ensure_constitution_from_template(project_dir)
|
||||
|
||||
content = memory.read_text()
|
||||
@@ -12899,11 +13552,41 @@ class TestInstalledPresetRichMarkup:
|
||||
assert result.exit_code == 0, (args, result.output, result.exception)
|
||||
assert "Broken [/red] tag" in strip_ansi(result.output)
|
||||
|
||||
def test_resolve_escapes_template_name(self, project_dir):
|
||||
"""``preset resolve`` echoes its argument; an unbalanced tag must not crash."""
|
||||
def test_resolve_rejects_invalid_template_name(self, project_dir):
|
||||
"""``preset resolve`` rejects names before joining them into paths."""
|
||||
result = self._invoke(project_dir, ["preset", "resolve", "no[/red]such"])
|
||||
assert result.exit_code == 1, (result.output, result.exception)
|
||||
assert "invalid template name" in strip_ansi(result.output)
|
||||
|
||||
def test_resolve_rejects_path_traversal(self, project_dir):
|
||||
"""The resolver rejects traversal before joining names into paths."""
|
||||
result = self._invoke(
|
||||
project_dir,
|
||||
["preset", "resolve", "../../../README"],
|
||||
)
|
||||
|
||||
assert result.exit_code == 1
|
||||
assert "invalid template name" in strip_ansi(result.output)
|
||||
|
||||
def test_resolve_accepts_dotted_command_name(self, project_dir):
|
||||
"""Documented dotted command identifiers use command resolution."""
|
||||
result = self._invoke(
|
||||
project_dir,
|
||||
["preset", "resolve", "speckit.constitution"],
|
||||
)
|
||||
|
||||
assert result.exit_code == 0, (result.output, result.exception)
|
||||
assert "no[/red]such" in strip_ansi(result.output)
|
||||
assert "constitution.md" in strip_ansi(result.output)
|
||||
|
||||
def test_resolve_rejects_empty_command_segments(self, project_dir):
|
||||
"""Dotted command identifiers cannot contain empty path-like segments."""
|
||||
result = self._invoke(
|
||||
project_dir,
|
||||
["preset", "resolve", "speckit..constitution"],
|
||||
)
|
||||
|
||||
assert result.exit_code == 1
|
||||
assert "invalid template name" in strip_ansi(result.output)
|
||||
|
||||
def test_resolve_escapes_layer_path_and_source(self, project_dir):
|
||||
"""The top-layer path/source lines must render markup literally.
|
||||
@@ -12997,14 +13680,13 @@ class TestInstalledPresetRichMarkup:
|
||||
assert "[base]" in output, output
|
||||
assert "[append]" in output, output
|
||||
|
||||
|
||||
class TestConstitutionSyncPreset:
|
||||
"""The bundled opt-in ``constitution-sync`` preset re-adds propagation.
|
||||
"""The bundled opt-in ``constitution-sync`` preset re-adds materialization.
|
||||
|
||||
Follow-up to #3790: core ``/constitution`` no longer propagates guidance
|
||||
into templates. This preset restores that behavior for teams that treat
|
||||
materialized templates as reviewed artifacts, delivered as a ``wrap`` of
|
||||
the core command so it stays forward-compatible with core changes.
|
||||
into templates. Issue #3950 also gates install-time constitution seeding on
|
||||
this preset. Its command override remains a ``wrap`` of core so it stays
|
||||
forward-compatible with core changes.
|
||||
"""
|
||||
|
||||
PRESET_DIR = Path(__file__).parent.parent / "presets" / "constitution-sync"
|
||||
|
||||
@@ -0,0 +1,753 @@
|
||||
"""Parity tests for composed runtime template resolution."""
|
||||
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
import pytest
|
||||
|
||||
from tests.conftest import requires_bash
|
||||
from tests.parity_helpers import (
|
||||
HAS_POWERSHELL,
|
||||
bash_cmd,
|
||||
clean_env,
|
||||
install_composition_stack,
|
||||
install_scripts,
|
||||
json_stdout,
|
||||
make_repo,
|
||||
ps_cmd,
|
||||
py_cmd,
|
||||
run,
|
||||
)
|
||||
|
||||
SCRIPT = "resolve-template"
|
||||
TEMPLATE = "constitution-template"
|
||||
|
||||
|
||||
def _setup_repo(tmp_path: Path) -> tuple[Path, str]:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
expected = install_composition_stack(repo, TEMPLATE, "# Core\n")
|
||||
return repo, expected
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_emit_composed_template_content(tmp_path: Path) -> None:
|
||||
repo, expected = _setup_repo(tmp_path)
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(result.stderr == "" for result in results)
|
||||
assert all(
|
||||
json_stdout(result)
|
||||
== {"TEMPLATE_NAME": TEMPLATE, "TEMPLATE_CONTENT": expected}
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
"without_registry,core_content",
|
||||
[
|
||||
(True, "# Core\n"),
|
||||
(False, "# Café ✓\n"),
|
||||
],
|
||||
ids=["directory_fallback", "unicode"],
|
||||
)
|
||||
def test_all_variants_preserve_composition_parity(
|
||||
tmp_path: Path, without_registry: bool, core_content: str
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
expected = install_composition_stack(repo, TEMPLATE, core_content)
|
||||
if without_registry:
|
||||
(repo / ".specify" / "presets" / ".registry").unlink()
|
||||
expected = (
|
||||
"# Prepended\n\n\n"
|
||||
"## Wrapper\n"
|
||||
f"{core_content}\n"
|
||||
"## End\n\n\n"
|
||||
"# Appended\n"
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == expected
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_read_utf8_registry_under_ascii_locale(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
"""Registry/manifest reads must force UTF-8, not the process locale.
|
||||
|
||||
With UTF-8 mode disabled and a C locale, the interpreter's default text
|
||||
encoding is ASCII. Non-ASCII *metadata* in the registry or a manifest must
|
||||
still resolve, because the resolvers open those files as UTF-8 explicitly.
|
||||
Template content stays ASCII so the pure-Python variant can emit it on the
|
||||
ASCII stdout this configuration forces.
|
||||
"""
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
expected = install_composition_stack(repo, TEMPLATE, "# Core\n")
|
||||
|
||||
# Inject non-ASCII metadata into the preset registry and a manifest so a
|
||||
# locale-dependent decode would raise instead of resolving cleanly.
|
||||
registry = repo / ".specify" / "presets" / ".registry"
|
||||
registry_data = json.loads(registry.read_text(encoding="utf-8"))
|
||||
registry_data["presets"]["wrap-pack"]["description"] = "Café ✓ wrapper"
|
||||
registry.write_text(
|
||||
json.dumps(registry_data, separators=(",", ":")) + "\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
manifest = repo / ".specify" / "presets" / "wrap-pack" / "preset.yml"
|
||||
manifest.write_text(
|
||||
manifest.read_text(encoding="utf-8") + ' description: "Café ✓"\n',
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
env = clean_env()
|
||||
# Force the interpreter's default text encoding to ASCII so an unqualified
|
||||
# open() would fail on the non-ASCII metadata above.
|
||||
env["PYTHONUTF8"] = "0"
|
||||
env["PYTHONCOERCECLOCALE"] = "0"
|
||||
env["LC_ALL"] = "C"
|
||||
env["LANG"] = "C"
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo, env),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo, env),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo, env))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == expected
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
"template_name",
|
||||
["missing-template", "../../../outside"],
|
||||
ids=["missing", "path_traversal"],
|
||||
)
|
||||
def test_all_variants_reject_unresolvable_template(
|
||||
tmp_path: Path, template_name: str
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
(repo / "outside.md").write_text("sensitive content\n", encoding="utf-8")
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, template_name, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, template_name, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, template_name, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 1 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
assert all("sensitive content" not in result.stderr for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_ignore_traversing_preset_registry_ids(tmp_path: Path) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
outside = repo.parent / "outside"
|
||||
outside.mkdir()
|
||||
(outside / f"{TEMPLATE}.md").write_text("sensitive content\n", encoding="utf-8")
|
||||
presets = repo / ".specify" / "presets"
|
||||
presets.mkdir(parents=True)
|
||||
(presets / ".registry").write_text(
|
||||
'{"presets":{"../../../outside":{"enabled":true,"priority":1}}}\n',
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 1 for result in results)
|
||||
assert all("sensitive content" not in result.stdout for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_support_root_level_preset_convention(tmp_path: Path) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
preset = repo / ".specify" / "presets" / "root-pack"
|
||||
preset.mkdir(parents=True)
|
||||
(preset / f"{TEMPLATE}.md").write_text("# Root convention\n", encoding="utf-8")
|
||||
(repo / ".specify" / "presets" / ".registry").write_text(
|
||||
'{"presets":{"root-pack":{"enabled":true,"priority":1}}}\n',
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == "# Root convention\n"
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_honor_extension_registry_state_and_priority(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
extensions = repo / ".specify" / "extensions"
|
||||
for extension_id, content in (
|
||||
("disabled-ext", "# Disabled\n"),
|
||||
("low-priority", "# Low priority\n"),
|
||||
("high-priority", "# High priority\n"),
|
||||
):
|
||||
template_dir = extensions / extension_id / "templates"
|
||||
template_dir.mkdir(parents=True)
|
||||
(template_dir / f"{TEMPLATE}.md").write_text(content, encoding="utf-8")
|
||||
(extensions / ".registry").write_text(
|
||||
'{"extensions":{'
|
||||
'"disabled-ext":{"enabled":null,"priority":1},'
|
||||
'"low-priority":{"enabled":true,"priority":20},'
|
||||
'"high-priority":{"enabled":true,"priority":5}'
|
||||
"}}\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == "# High priority\n"
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_support_root_level_extension_convention(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
extension = repo / ".specify" / "extensions" / "root-extension"
|
||||
extension.mkdir(parents=True)
|
||||
(extension / f"{TEMPLATE}.md").write_text(
|
||||
"# Root extension\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
(repo / ".specify" / "extensions" / ".registry").write_text(
|
||||
'{"extensions":{"root-extension":{"enabled":true,"priority":1}}}\n',
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == "# Root extension\n"
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_treat_extension_registry_ids_case_sensitively(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
extension = repo / ".specify" / "extensions" / "foo" / "templates"
|
||||
extension.mkdir(parents=True)
|
||||
(extension / f"{TEMPLATE}.md").write_text(
|
||||
"# Lowercase extension\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
(repo / ".specify" / "extensions" / ".registry").write_text(
|
||||
'{"extensions":{"FOO":{"enabled":true,"priority":1}}}\n',
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == "# Lowercase extension\n"
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
"registry_content",
|
||||
["{ not valid json", '{"extensions":[]}\n', "[]\n"],
|
||||
ids=["invalid_json", "non_mapping_extensions", "non_mapping_root"],
|
||||
)
|
||||
def test_all_variants_fail_for_malformed_extension_registry(
|
||||
tmp_path: Path, registry_content: str
|
||||
) -> None:
|
||||
"""A corrupt extension registry must fail closed, not silently enable
|
||||
every on-disk extension directory as unregistered."""
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
extensions = repo / ".specify" / "extensions"
|
||||
template_dir = extensions / "sneaky-ext" / "templates"
|
||||
template_dir.mkdir(parents=True)
|
||||
(template_dir / f"{TEMPLATE}.md").write_text(
|
||||
"# Should not be served\n", encoding="utf-8"
|
||||
)
|
||||
(extensions / ".registry").write_text(registry_content, encoding="utf-8")
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
assert all(
|
||||
"Should not be served" not in result.stdout for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_fail_when_registry_is_a_directory(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
"""A directory at the extension registry path must fail closed, not be
|
||||
treated as an absent registry that enables every on-disk extension."""
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
extensions = repo / ".specify" / "extensions"
|
||||
template_dir = extensions / "sneaky-ext" / "templates"
|
||||
template_dir.mkdir(parents=True)
|
||||
(template_dir / f"{TEMPLATE}.md").write_text(
|
||||
"# Should not be served\n", encoding="utf-8"
|
||||
)
|
||||
# Create ``.registry`` as a directory rather than a regular file.
|
||||
(extensions / ".registry").mkdir()
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_fail_when_registry_is_broken_symlink(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
"""A broken symlink at the extension registry path must fail closed across
|
||||
Bash, Python, and PowerShell resolvers rather than being treated as absent."""
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
extensions = repo / ".specify" / "extensions"
|
||||
template_dir = extensions / "sneaky-ext" / "templates"
|
||||
template_dir.mkdir(parents=True)
|
||||
(template_dir / f"{TEMPLATE}.md").write_text(
|
||||
"# Should not be served\n", encoding="utf-8"
|
||||
)
|
||||
(extensions / ".registry").symlink_to(extensions / "does-not-exist")
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize("base_kind", ["override", "preset"])
|
||||
def test_all_variants_ignore_malformed_layers_below_replace_base(
|
||||
tmp_path: Path,
|
||||
base_kind: str,
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
expected = "# Winning base\r\nBody\r\n"
|
||||
presets = repo / ".specify" / "presets"
|
||||
|
||||
if base_kind == "override":
|
||||
override = repo / ".specify" / "templates" / "overrides"
|
||||
override.mkdir(parents=True)
|
||||
(override / f"{TEMPLATE}.md").write_bytes(expected.encode("utf-8"))
|
||||
registry = {"presets": {"broken-pack": {"enabled": True, "priority": 1}}}
|
||||
else:
|
||||
winning = presets / "winning-pack" / "templates"
|
||||
winning.mkdir(parents=True)
|
||||
(winning / f"{TEMPLATE}.md").write_bytes(expected.encode("utf-8"))
|
||||
registry = {
|
||||
"presets": {
|
||||
"winning-pack": {"enabled": True, "priority": 1},
|
||||
"broken-pack": {"enabled": True, "priority": 2},
|
||||
}
|
||||
}
|
||||
|
||||
broken = presets / "broken-pack"
|
||||
broken.mkdir(parents=True)
|
||||
(broken / "preset.yml").write_text("provides: [\n", encoding="utf-8")
|
||||
(presets / ".registry").write_text(
|
||||
json.dumps(registry, separators=(",", ":")) + "\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == expected
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
("entries", "expected"),
|
||||
[
|
||||
(
|
||||
[
|
||||
("disabled-pack", {"enabled": False, "priority": 0}),
|
||||
("numeric-pack", {"enabled": True, "priority": 2}),
|
||||
("string-pack", {"enabled": True, "priority": "1"}),
|
||||
],
|
||||
"# string-pack\n",
|
||||
),
|
||||
(
|
||||
[
|
||||
("z-pack", {"enabled": True}),
|
||||
("a-pack", {"enabled": True}),
|
||||
],
|
||||
"# a-pack\n",
|
||||
),
|
||||
(
|
||||
[
|
||||
("float-pack", {"enabled": True, "priority": 5.9}),
|
||||
("six-pack", {"enabled": True, "priority": 6}),
|
||||
],
|
||||
"# float-pack\n",
|
||||
),
|
||||
(
|
||||
[
|
||||
("a-huge-pack", {"enabled": True, "priority": 2147483648}),
|
||||
("z-default-pack", {"enabled": True, "priority": "invalid"}),
|
||||
],
|
||||
"# z-default-pack\n",
|
||||
),
|
||||
(
|
||||
[
|
||||
("decimal-string-pack", {"enabled": True, "priority": "5.9"}),
|
||||
("exponent-string-pack", {"enabled": True, "priority": "1e3"}),
|
||||
("hex-string-pack", {"enabled": True, "priority": "0x10"}),
|
||||
("six-pack", {"enabled": True, "priority": 6}),
|
||||
],
|
||||
"# six-pack\n",
|
||||
),
|
||||
],
|
||||
ids=[
|
||||
"mixed_priorities",
|
||||
"equal_priority_id_tiebreaker",
|
||||
"float_priority",
|
||||
"large_integer_priority",
|
||||
"non_integer_numeric_strings",
|
||||
],
|
||||
)
|
||||
def test_all_variants_normalize_and_tiebreak_preset_priorities(
|
||||
tmp_path: Path,
|
||||
entries: list[tuple[str, dict[str, object]]],
|
||||
expected: str,
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
presets = repo / ".specify" / "presets"
|
||||
registry: dict[str, object] = {"presets": {}}
|
||||
registry_presets = registry["presets"]
|
||||
assert isinstance(registry_presets, dict)
|
||||
for preset_id, metadata in entries:
|
||||
template_dir = presets / preset_id / "templates"
|
||||
template_dir.mkdir(parents=True)
|
||||
(template_dir / f"{TEMPLATE}.md").write_text(
|
||||
f"# {preset_id}\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
registry_presets[preset_id] = metadata
|
||||
(presets / ".registry").write_text(
|
||||
json.dumps(registry, separators=(",", ":")) + "\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TEMPLATE_CONTENT"] == expected
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_fail_when_wrap_placeholder_is_missing(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
templates = repo / ".specify" / "templates"
|
||||
templates.mkdir(parents=True)
|
||||
(templates / f"{TEMPLATE}.md").write_text("# Core\n", encoding="utf-8")
|
||||
preset = repo / ".specify" / "presets" / "wrap-pack"
|
||||
(preset / "templates").mkdir(parents=True)
|
||||
(preset / "templates" / f"{TEMPLATE}.md").write_text(
|
||||
"# Broken wrapper\n", encoding="utf-8"
|
||||
)
|
||||
(preset / "preset.yml").write_text(
|
||||
"provides:\n"
|
||||
" templates:\n"
|
||||
" - type: template\n"
|
||||
f" name: {TEMPLATE}\n"
|
||||
f" file: templates/{TEMPLATE}.md\n"
|
||||
" strategy: wrap\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
(repo / ".specify" / "presets" / ".registry").write_text(
|
||||
'{"presets":{"wrap-pack":{"enabled":true,"priority":1}}}\n',
|
||||
encoding="utf-8",
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_fail_when_yaml_parser_is_unavailable(
|
||||
tmp_path: Path,
|
||||
) -> None:
|
||||
repo, _ = _setup_repo(tmp_path)
|
||||
blocker = tmp_path / "blocker"
|
||||
blocker.mkdir()
|
||||
(blocker / "yaml.py").write_text(
|
||||
"raise ImportError('simulated missing PyYAML')\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
env = clean_env()
|
||||
env["PYTHONPATH"] = str(blocker)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo, env),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo, env),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(
|
||||
run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo, env)
|
||||
)
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_bash_fails_when_override_read_fails(tmp_path: Path) -> None:
|
||||
repo = make_repo(tmp_path)
|
||||
install_scripts(repo, SCRIPT)
|
||||
override = repo / ".specify" / "templates" / "overrides"
|
||||
override.mkdir(parents=True)
|
||||
(override / f"{TEMPLATE}.md").write_text("# Override\n", encoding="utf-8")
|
||||
shim_dir = tmp_path / "bin"
|
||||
shim_dir.mkdir()
|
||||
cat_shim = shim_dir / "cat"
|
||||
cat_shim.write_text(
|
||||
"#!/bin/sh\n"
|
||||
"case \"$1\" in\n"
|
||||
" */.specify/templates/overrides/*) exit 1 ;;\n"
|
||||
"esac\n"
|
||||
"exec /bin/cat \"$@\"\n",
|
||||
encoding="utf-8",
|
||||
)
|
||||
cat_shim.chmod(0o755)
|
||||
env = clean_env()
|
||||
env["PATH"] = f"{shim_dir}{os.pathsep}{env.get('PATH', '')}"
|
||||
|
||||
result = run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo, env)
|
||||
|
||||
assert result.returncode != 0
|
||||
assert result.stdout == ""
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
"manifest_content",
|
||||
[
|
||||
"provides: [\n",
|
||||
"",
|
||||
"provides:\n templates:\n - null\n",
|
||||
"provides:\n templates: {}\n",
|
||||
"preset:\n id: wrap-pack\n",
|
||||
"provides:\n templates: []\n",
|
||||
f"""provides:
|
||||
templates:
|
||||
- type: template
|
||||
name: {TEMPLATE}
|
||||
file: null
|
||||
strategy: wrap
|
||||
""",
|
||||
f"""provides:
|
||||
templates:
|
||||
- type: template
|
||||
name: {TEMPLATE}
|
||||
file: templates/{TEMPLATE}.md
|
||||
strategy: 123
|
||||
""",
|
||||
f"""provides:
|
||||
templates:
|
||||
- type: template
|
||||
name: {TEMPLATE}
|
||||
file: templates/{TEMPLATE}.md
|
||||
strategy: wrap
|
||||
- type: template
|
||||
name: unrelated-template
|
||||
file: null
|
||||
strategy: append
|
||||
""",
|
||||
f"""provides:
|
||||
templates:
|
||||
- name: {TEMPLATE}
|
||||
file: templates/{TEMPLATE}.md
|
||||
strategy: wrap
|
||||
- type: template
|
||||
name: unrelated-template
|
||||
file: templates/other.md
|
||||
""",
|
||||
f"""provides:
|
||||
templates:
|
||||
- type: template
|
||||
name: {TEMPLATE}
|
||||
file: templates/{TEMPLATE}.md
|
||||
strategy: wrap
|
||||
- type: template
|
||||
name: unrelated-template
|
||||
""",
|
||||
f"""provides:
|
||||
templates:
|
||||
- type: template
|
||||
name: {TEMPLATE}
|
||||
file: templates/{TEMPLATE}.md
|
||||
strategy: wrap
|
||||
- type: bogus
|
||||
name: unrelated-template
|
||||
file: templates/other.md
|
||||
""",
|
||||
f"""provides:
|
||||
templates:
|
||||
- type: template
|
||||
name: {TEMPLATE}
|
||||
file: templates/{TEMPLATE}.md
|
||||
strategy: wrap
|
||||
- type: template
|
||||
name: unrelated-template
|
||||
file: templates/other.md
|
||||
strategy: merge
|
||||
""",
|
||||
],
|
||||
ids=[
|
||||
"invalid_yaml",
|
||||
"empty_document",
|
||||
"non_mapping_template_entry",
|
||||
"non_list_templates",
|
||||
"missing_provides",
|
||||
"empty_templates",
|
||||
"non_string_file",
|
||||
"non_string_strategy",
|
||||
"malformed_entry_after_match",
|
||||
"entry_missing_type",
|
||||
"entry_missing_file",
|
||||
"unsupported_type",
|
||||
"unsupported_strategy",
|
||||
],
|
||||
)
|
||||
def test_all_variants_fail_for_malformed_preset_manifest(
|
||||
tmp_path: Path,
|
||||
manifest_content: str,
|
||||
) -> None:
|
||||
repo, _ = _setup_repo(tmp_path)
|
||||
(
|
||||
repo / ".specify" / "presets" / "wrap-pack" / "preset.yml"
|
||||
).write_text(manifest_content, encoding="utf-8")
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, TEMPLATE, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, TEMPLATE, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
@@ -11,7 +11,9 @@ from tests.parity_helpers import (
|
||||
HAS_POWERSHELL,
|
||||
POWERSHELL_EXE,
|
||||
bash_cmd,
|
||||
break_wrap_layer,
|
||||
clean_env,
|
||||
install_composition_stack,
|
||||
install_scripts,
|
||||
json_stdout,
|
||||
make_repo,
|
||||
@@ -60,7 +62,57 @@ def test_python_fresh_copy_matches_bash(tmp_path: Path) -> None:
|
||||
)
|
||||
for repo in (repo_a, repo_b):
|
||||
plan = repo / "specs" / "001-my-feature" / "plan.md"
|
||||
assert plan.read_text(encoding="utf-8") == TEMPLATE_BODY
|
||||
assert plan.read_bytes() == TEMPLATE_BODY.encode("utf-8")
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_materialize_composed_plan_template(tmp_path: Path) -> None:
|
||||
repos = [
|
||||
_setup_repo(tmp_path, "bash"),
|
||||
_setup_repo(tmp_path, "powershell"),
|
||||
_setup_repo(tmp_path, "python"),
|
||||
]
|
||||
expected = ""
|
||||
for current in repos:
|
||||
expected = install_composition_stack(
|
||||
current, "plan-template", TEMPLATE_BODY
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repos[0], SCRIPT, "--json"), repos[0]),
|
||||
run(py_cmd(repos[2], SCRIPT, "--json"), repos[2]),
|
||||
]
|
||||
checked_repos = [repos[0], repos[2]]
|
||||
if HAS_POWERSHELL:
|
||||
results.insert(1, run(ps_cmd(repos[1], SCRIPT, "-Json"), repos[1]))
|
||||
checked_repos.insert(1, repos[1])
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
for current in checked_repos:
|
||||
assert (
|
||||
current / "specs" / "001-my-feature" / "plan.md"
|
||||
).read_text(encoding="utf-8") == expected
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_fail_for_broken_plan_composition(tmp_path: Path) -> None:
|
||||
repos = [
|
||||
_setup_repo(tmp_path, "bash"),
|
||||
_setup_repo(tmp_path, "powershell"),
|
||||
_setup_repo(tmp_path, "python"),
|
||||
]
|
||||
for current in repos:
|
||||
install_composition_stack(current, "plan-template", TEMPLATE_BODY)
|
||||
break_wrap_layer(current, "plan-template")
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repos[0], SCRIPT, "--json"), repos[0]),
|
||||
run(py_cmd(repos[2], SCRIPT, "--json"), repos[2]),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repos[1], SCRIPT, "-Json"), repos[1]))
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@@ -119,13 +171,19 @@ def test_python_missing_template_matches_bash(tmp_path: Path) -> None:
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
"registry",
|
||||
("registry", "expected"),
|
||||
[
|
||||
'{"presets": {"alpha": {"priority": "high"}, "beta": {"priority": 1}}}',
|
||||
'{"presets": {"alpha": {"priority": 2}, "beta": {"priority": 1}, "gamma": {"priority": null}}}',
|
||||
"[]",
|
||||
'{"presets":[]}',
|
||||
'{"presets":null}',
|
||||
(
|
||||
'{"presets": {"alpha": {"priority": "high"}, "beta": {"priority": 1}}}',
|
||||
"# beta plan\n",
|
||||
),
|
||||
(
|
||||
'{"presets": {"alpha": {"priority": 2}, "beta": {"priority": 1}, "gamma": {"priority": null}}}',
|
||||
"# beta plan\n",
|
||||
),
|
||||
("[]", "# alpha plan\n"),
|
||||
('{"presets":[]}', "# alpha plan\n"),
|
||||
('{"presets":null}', "# alpha plan\n"),
|
||||
],
|
||||
ids=[
|
||||
"mixed_priorities",
|
||||
@@ -135,10 +193,10 @@ def test_python_missing_template_matches_bash(tmp_path: Path) -> None:
|
||||
"null_presets",
|
||||
],
|
||||
)
|
||||
def test_all_variants_broken_registry_falls_back_to_dir_scan(
|
||||
tmp_path: Path, registry: str
|
||||
def test_all_variants_normalize_or_fallback_for_registry(
|
||||
tmp_path: Path, registry: str, expected: str
|
||||
) -> None:
|
||||
"""Malformed registries fall back to the alphabetical directory scan."""
|
||||
"""Priorities normalize canonically; malformed shapes fall back to directories."""
|
||||
repos = [
|
||||
_setup_repo(tmp_path, "bash", template=False),
|
||||
_setup_repo(tmp_path, "powershell", template=False),
|
||||
@@ -183,7 +241,7 @@ def test_all_variants_broken_registry_falls_back_to_dir_scan(
|
||||
) == 1
|
||||
for _, repo in results:
|
||||
plan = repo / "specs" / "001-my-feature" / "plan.md"
|
||||
assert plan.read_text(encoding="utf-8") == "# alpha plan\n"
|
||||
assert plan.read_text(encoding="utf-8") == expected
|
||||
|
||||
|
||||
@pytest.mark.skipif(not HAS_POWERSHELL, reason="no PowerShell available")
|
||||
|
||||
@@ -719,7 +719,7 @@ def test_setup_tasks_ps_core_template_resolved(tasks_repo: Path) -> None:
|
||||
[exe, "-NoProfile", "-File", str(script), "-Json"],
|
||||
cwd=tasks_repo,
|
||||
capture_output=True,
|
||||
text=True,
|
||||
encoding="utf-8",
|
||||
check=False,
|
||||
env=_clean_env(),
|
||||
)
|
||||
|
||||
@@ -10,7 +10,9 @@ from tests.conftest import requires_bash
|
||||
from tests.parity_helpers import (
|
||||
HAS_POWERSHELL,
|
||||
bash_cmd,
|
||||
break_wrap_layer,
|
||||
clean_env,
|
||||
install_composition_stack,
|
||||
install_scripts,
|
||||
json_stdout,
|
||||
make_repo,
|
||||
@@ -87,6 +89,42 @@ def test_python_override_template_wins_matches_bash(repo: Path) -> None:
|
||||
assert json_stdout(py)["TASKS_TEMPLATE"].endswith("overrides/tasks-template.md")
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_return_composed_tasks_template(repo: Path) -> None:
|
||||
expected = install_composition_stack(
|
||||
repo, "tasks-template", "# Tasks Template\n"
|
||||
)
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode == 0 for result in results)
|
||||
assert all(
|
||||
json_stdout(result)["TASKS_TEMPLATE_CONTENT"] == expected
|
||||
for result in results
|
||||
)
|
||||
|
||||
|
||||
@requires_bash
|
||||
def test_all_variants_fail_for_broken_tasks_composition(repo: Path) -> None:
|
||||
install_composition_stack(repo, "tasks-template", "# Tasks Template\n")
|
||||
break_wrap_layer(repo, "tasks-template")
|
||||
|
||||
results = [
|
||||
run(bash_cmd(repo, SCRIPT, "--json"), repo),
|
||||
run(py_cmd(repo, SCRIPT, "--json"), repo),
|
||||
]
|
||||
if HAS_POWERSHELL:
|
||||
results.append(run(ps_cmd(repo, SCRIPT, "-Json"), repo))
|
||||
|
||||
assert all(result.returncode != 0 for result in results)
|
||||
assert all(result.stdout == "" for result in results)
|
||||
|
||||
|
||||
@requires_bash
|
||||
@pytest.mark.parametrize(
|
||||
"missing",
|
||||
|
||||
@@ -786,6 +786,39 @@ class TestExpressions:
|
||||
assert evaluate_condition("{{ inputs.ready }}", ctx) is True
|
||||
assert evaluate_condition("{{ inputs.missing }}", ctx) is False
|
||||
|
||||
def test_condition_strips_captured_command_output(self):
|
||||
"""A condition resolving to captured stdout must honour "false".
|
||||
|
||||
A ``shell`` step stores ``proc.stdout`` verbatim, so ``run: echo false``
|
||||
resolves to ``"false\\n"``. Without stripping, the trailing newline
|
||||
matched neither the "false" nor the "true" branch and fell through to
|
||||
``bool("false\\n")`` -> True, so an ``if`` step took its ``then`` branch
|
||||
on a step that printed "false". There is no ``trim`` filter, so a
|
||||
workflow author cannot strip it themselves.
|
||||
"""
|
||||
from specify_cli.workflows.expressions import evaluate_condition
|
||||
from specify_cli.workflows.base import StepContext
|
||||
|
||||
ctx = StepContext(steps={"check": {"output": {"stdout": "false\n"}}})
|
||||
assert evaluate_condition("{{ steps.check.output.stdout }}", ctx) is False
|
||||
|
||||
for raw in ("false\n", "false\r\n", " false", "false ", "FALSE\n"):
|
||||
assert evaluate_condition(raw, StepContext()) is False, raw
|
||||
for raw in ("true\n", " true ", "TRUE\r\n"):
|
||||
assert evaluate_condition(raw, StepContext()) is True, raw
|
||||
|
||||
def test_condition_whitespace_only_string_stays_truthy(self):
|
||||
"""Stripping must not turn a whitespace-only string into False.
|
||||
|
||||
Only the "false"/"true" special case is stripped; everything else still
|
||||
falls through to ``bool(result)`` on the raw string.
|
||||
"""
|
||||
from specify_cli.workflows.expressions import evaluate_condition
|
||||
from specify_cli.workflows.base import StepContext
|
||||
|
||||
assert evaluate_condition(" ", StepContext()) is True
|
||||
assert evaluate_condition("falsey", StepContext()) is True
|
||||
|
||||
def test_non_string_passthrough(self):
|
||||
from specify_cli.workflows.expressions import evaluate_expression
|
||||
from specify_cli.workflows.base import StepContext
|
||||
|
||||
@@ -136,6 +136,44 @@ class TestShorthandEdits:
|
||||
assert overlay is None
|
||||
assert any("operation" in e.lower() for e in errors), errors
|
||||
|
||||
@pytest.mark.parametrize(
|
||||
"operation",
|
||||
[
|
||||
{"insert_after": "a"},
|
||||
["insert_after"],
|
||||
],
|
||||
)
|
||||
def test_non_string_operation_rejected_without_raising(self, operation):
|
||||
"""An unhashable 'operation' must be reported, not raised.
|
||||
|
||||
`VALID_OPERATIONS` is a frozenset, so `operation not in ...` hashes the
|
||||
value. Nesting the shorthand form under the explicit key by mistake
|
||||
(`operation: {insert_after: a}`) therefore raised
|
||||
`TypeError: unhashable type: 'dict'` out of a validator whose docstring
|
||||
promises "validation never raises" — and nothing upstream catches
|
||||
TypeError, so the CLI died with a raw traceback.
|
||||
"""
|
||||
overlay, errors = validate_overlay_yaml(
|
||||
{
|
||||
"id": "ov",
|
||||
"extends": "wf",
|
||||
"priority": 10,
|
||||
"edits": [
|
||||
{
|
||||
"operation": operation,
|
||||
"anchor": "a",
|
||||
"step": {
|
||||
"id": "b",
|
||||
"type": "command",
|
||||
"command": "echo",
|
||||
},
|
||||
}
|
||||
],
|
||||
}
|
||||
)
|
||||
assert overlay is None
|
||||
assert any("invalid operation" in err for err in errors), errors
|
||||
|
||||
def test_shorthand_and_explicit_mixed_list(self):
|
||||
overlay, errors = validate_overlay_yaml(
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user