squad-kit 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "squad-kit",
3
- "version": "0.3.0",
3
+ "version": "0.4.0",
4
4
  "author": "Momen Yasser <momenysr@gmail.com>",
5
5
  "description": "Plan once, execute cheap. A token-efficient, 3-step SDD workflow CLI (stories → plans → implementation).",
6
6
  "keywords": [
@@ -26,4 +26,5 @@ You are generating an agent-executable implementation plan for this project usin
26
26
  - **Planning only.** Do not modify application source code in this session.
27
27
  - **Concrete over clever.** File paths, line ranges, type names, function signatures, verification commands. No "consider" or "might".
28
28
  - **Respect existing conventions.** Read neighbouring plan files before inventing a new pattern.
29
+ - If a plan file already starts with `<!-- squad-kit:`, **never change or remove that first line** when editing. New plans start with `# Story NN — …` per `generate-plan.md`; do not invent the API metadata comment. In later implementation sessions, treat the plan file as read-only unless the user explicitly asks to revise the plan.
29
30
  - Report back the path(s) you wrote and a one-line summary per file.
@@ -12,3 +12,5 @@ Generate an implementation plan using the squad-kit workflow.
12
12
  - Write the plan file to `.squad/plans/<feature-slug>/NN-story-<slug>[-<id>].md` and update `00-overview.md` / `00-index.md` as needed.
13
13
 
14
14
  Planning only. Do not modify application source code in this session.
15
+
16
+ If a plan file already starts with `<!-- squad-kit:`, never change or remove that first line when editing (tooling / `squad list`). New plans start with `# Story NN — …` per `generate-plan.md`; do not fake the API metadata comment. In later implementation sessions, keep the plan file read-only unless the user explicitly asks to revise the plan.
@@ -24,3 +24,4 @@ You are generating an agent-executable implementation plan for this project usin
24
24
  - Planning only. Do **not** modify application source code in this session.
25
25
  - Concrete over clever. File paths, line ranges, type names, function signatures, verification commands.
26
26
  - Respect existing conventions — read neighbouring plan files first.
27
+ - If a plan file already starts with `<!-- squad-kit:`, **never change or remove that first line** when editing the file. New plans you write start with `# Story NN — …` per `generate-plan.md`; do not fake the API metadata comment (only `squad new-plan --api` emits that header). In later **implementation** chats, treat the plan file as read-only unless the user explicitly asks to revise the plan.
@@ -11,4 +11,6 @@ Steps:
11
11
  5. Write the plan file to .squad/plans/<feature-slug>/NN-story-<slug>[-<id>].md and update 00-overview.md / 00-index.md as needed.
12
12
 
13
13
  Planning only. Do not modify application source code in this session.
14
+
15
+ If a plan file already starts with `<!-- squad-kit:`, never change or remove that first line when editing (tooling). New plans start with `# Story NN — …` per generate-plan.md; do not fake the API metadata comment. In later implementation sessions, keep the plan file read-only unless the user explicitly asks to revise the plan.
14
16
  """
@@ -82,6 +82,9 @@ Every generated plan Markdown must follow this structure and tone.
82
82
  5. **Cross-feature links:** Use relative paths like `../other-feature/NN-story-….md`.
83
83
  6. **Index:** If introducing a **new** feature slug, add a row to `.squad/plans/00-index.md`.
84
84
  7. **Scope:** Produce planning Markdown only unless the user explicitly asks for code changes.
85
+ 8. **First-line metadata (`<!-- squad-kit: … -->`):** If an existing `NN-story-*.md` already begins (after any leading blank lines) with a single-line HTML comment `<!-- squad-kit: … -->`, **leave that first line unchanged** in every edit unless the user explicitly asks to change plan metadata. Do not replace it with status text, a title, or a different comment—`squad list` and other tooling read it. Status notes (*implementation complete*, etc.) belong in the body or elsewhere, not on that line.
86
+ 9. **New plan files you author here (e.g. copy-paste / in-agent planning):** Start the Markdown body with the **`# Story NN — …`** H1 from this document. Do **not** invent a `<!-- squad-kit: generated by … -->` line; only `squad new-plan --api` writes that exact header format.
87
+ 10. **Executor sessions (later):** When this plan is used for implementation (attach-only workflow), treat the plan file as **read-only** unless the user explicitly asks to revise the plan; implement in application sources and tests instead of rewriting the plan header.
85
88
 
86
89
  ---
87
90
 
@@ -18,8 +18,11 @@ This is **not** an implementation prompt. It is the input to the plan-generation
18
18
  ## Tracker (metadata only)
19
19
 
20
20
  - **Tracker type:** `{{trackerType}}`
21
- - **Work item id:** (used in filenames and plan tables; leave blank if tracker type is `none`)
22
- - **Work item type:** Story / Bug / Task / Chore / …
21
+ - **Work item id:** `{{trackerWorkItemId}}` *(used in filenames and plan tables; fill manually if empty)*
22
+ - **Work item type:** `{{trackerWorkItemType}}`
23
+ - **Status:** `{{trackerStatus}}`
24
+ - **Assignee:** `{{trackerAssignee}}`
25
+ - **Labels:** `{{trackerLabels}}`
23
26
 
24
27
  External tracker links are **not** followed by the planner. Keep the id for naming and traceability only.
25
28
 
@@ -27,30 +30,30 @@ External tracker links are **not** followed by the planner. Keep the id for nami
27
30
 
28
31
  ## Title
29
32
 
30
- *(Paste the work item title verbatim.)*
33
+ *(Paste the work item title verbatim. Prefilled when `squad new-story` fetched from a tracker.)*
31
34
 
32
35
  ```
33
-
36
+ {{trackerTitle}}
34
37
  ```
35
38
 
36
39
  ---
37
40
 
38
41
  ## Description
39
42
 
40
- *(Paste the full work item description, including any formatting you rely on.)*
43
+ *(Paste the full work item description. Prefilled when fetched from a tracker.)*
41
44
 
42
45
  ```
43
-
46
+ {{trackerDescription}}
44
47
  ```
45
48
 
46
49
  ---
47
50
 
48
51
  ## Acceptance criteria
49
52
 
50
- *(Paste the acceptance criteria — checklist, bullets, Gherkin, whatever the tracker stores.)*
53
+ *(Checklist, bullets, Gherkin, etc. Prefilled for Azure DevOps when the work item has acceptance criteria.)*
51
54
 
52
55
  ```
53
-
56
+ {{trackerAcceptanceCriteria}}
54
57
  ```
55
58
 
56
59
  ---
@@ -2,6 +2,8 @@
2
2
 
3
3
  This file documents the structure of `NN-story-<slug>.md` plans that the planner produces. The planner reads `generate-plan.md`; this file exists so contributors can scan the target shape at a glance.
4
4
 
5
+ When **`squad new-plan --api`** creates the file, the first line is often a single-line **`<!-- squad-kit: generated by … -->`** comment (tooling / `squad list`). **Preserve that line** when editing the plan; do not overwrite it with prose or a different comment unless the user explicitly asks to change metadata.
6
+
5
7
  ```md
6
8
  # Story NN — <title> (Story: <tracker-id?>)
7
9