squad-kit 0.1.0 → 0.2.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.1.0",
3
+ "version": "0.2.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": [
@@ -22,20 +22,37 @@
22
22
  "dist",
23
23
  "templates",
24
24
  "README.md",
25
+ "CHANGELOG.md",
26
+ "SECURITY.md",
25
27
  "LICENSE"
26
28
  ],
29
+ "scripts": {
30
+ "build": "tsup",
31
+ "dev": "tsup --watch",
32
+ "test": "vitest run",
33
+ "test:watch": "vitest",
34
+ "lint": "tsc --noEmit",
35
+ "verify:models": "tsx scripts/verify-models.ts",
36
+ "prepublishOnly": "pnpm run verify:models && pnpm build && pnpm test"
37
+ },
27
38
  "dependencies": {
28
39
  "@inquirer/prompts": "^7.2.0",
40
+ "boxen": "^8.0.1",
29
41
  "commander": "^12.1.0",
30
42
  "fs-extra": "^11.2.0",
43
+ "gradient-string": "^3.0.0",
44
+ "ignore": "^6.0.2",
31
45
  "js-yaml": "^4.1.0",
32
- "kleur": "^4.1.5"
46
+ "kleur": "^4.1.5",
47
+ "ora": "^8.1.1"
33
48
  },
34
49
  "devDependencies": {
35
50
  "@types/fs-extra": "^11.0.4",
51
+ "@types/gradient-string": "^1.1.6",
36
52
  "@types/js-yaml": "^4.0.9",
37
53
  "@types/node": "^22.10.0",
38
54
  "tsup": "^8.3.5",
55
+ "tsx": "^4.19.3",
39
56
  "typescript": "^5.7.2",
40
57
  "vitest": "^2.1.8"
41
58
  },
@@ -49,12 +66,5 @@
49
66
  "homepage": "https://github.com/AzmSquad/squad-kit#readme",
50
67
  "bugs": {
51
68
  "url": "https://github.com/AzmSquad/squad-kit/issues"
52
- },
53
- "scripts": {
54
- "build": "tsup",
55
- "dev": "tsup --watch",
56
- "test": "vitest run",
57
- "test:watch": "vitest",
58
- "lint": "tsc --noEmit"
59
69
  }
60
- }
70
+ }
@@ -8,14 +8,14 @@ You are generating an agent-executable implementation plan for this project usin
8
8
 
9
9
  - **Intake file path:** `$ARGUMENTS`
10
10
  - If empty, ask the user for the path to a story intake file (under `.squad/stories/`).
11
- - **Meta-prompt:** `.squad/prompts/generate-plan.md` — follow its instructions exactly.
11
+ - **Meta-prompt:** `generate-plan.md` from the **installed squad-kit package** (`templates/prompts/` — not under `.squad/`; locate via `npm root -g`/your package manager under `squad-kit`, or run `squad new-plan <intake> --copy` to print the composed meta-prompt). Follow it exactly.
12
12
  - **Project config:** `.squad/config.yaml` — read `project.projectRoots`, `tracker.type`, `naming.includeTrackerId`, `naming.globalSequence`.
13
13
 
14
14
  ## Steps
15
15
 
16
- 1. Read `.squad/prompts/generate-plan.md` completely. Treat it as your operating instructions for structure, tone, and output rules.
16
+ 1. Read `generate-plan.md` from the installed squad-kit package completely. Treat it as your operating instructions for structure, tone, and output rules.
17
17
  2. Read the intake file at `$ARGUMENTS`, plus any files in its `attachments/` directory that the intake references.
18
- 3. Read one or two existing plan files under `.squad/plans/` (if any) to match established tone. If none exist, use `.squad/prompts/story-skeleton.md` as the structural reference.
18
+ 3. Read one or two existing plan files under `.squad/plans/` (if any) to match established tone. If none exist, use `story-skeleton.md` from the same `templates/prompts/` directory in the squad-kit package as the structural reference.
19
19
  4. Determine the next sequence number by scanning `.squad/plans/**/NN-story-*.md` for the highest `NN` (global sequence) or the highest within the target feature folder (per-feature sequence), per `config.yaml.naming.globalSequence`.
20
20
  5. Write the plan file to `.squad/plans/<feature-slug>/NN-story-<slug>[-<id>].md`.
21
21
  6. Update `.squad/plans/<feature-slug>/00-overview.md` with the new story row.
@@ -5,7 +5,7 @@ description: Generate an implementation plan from a squad-kit story intake file.
5
5
 
6
6
  Generate an implementation plan using the squad-kit workflow.
7
7
 
8
- - Read `.squad/prompts/generate-plan.md` and follow its instructions exactly.
8
+ - Read `generate-plan.md` from the installed squad-kit package (`templates/prompts/`; not under `.squad/` — use `npm root -g`/your package manager path to `squad-kit`, or `squad new-plan <intake> --copy` for the composed prompt) and follow its instructions exactly.
9
9
  - Read the intake file provided by the user (under `.squad/stories/`) plus any referenced files in its `attachments/`.
10
10
  - Read `.squad/config.yaml` for tracker type and naming rules.
11
11
  - Scan `.squad/plans/**/NN-story-*.md` to determine the next global sequence number.
@@ -7,14 +7,14 @@ You are generating an agent-executable implementation plan for this project usin
7
7
  ## Inputs
8
8
 
9
9
  - **Intake file path:** `$ARGUMENTS` (if empty, ask the user for a path under `.squad/stories/`).
10
- - **Meta-prompt:** `.squad/prompts/generate-plan.md` — follow its instructions exactly.
10
+ - **Meta-prompt:** `generate-plan.md` from the **installed squad-kit package** (`templates/prompts/` — not under `.squad/`; find it via `npm root -g`/your package manager next to `squad-kit`, or run `squad new-plan <intake> --copy` to print the composed meta-prompt on stdout). Follow it exactly.
11
11
  - **Project config:** `.squad/config.yaml` — read `project.projectRoots`, `tracker.type`, `naming.*`.
12
12
 
13
13
  ## Steps
14
14
 
15
- 1. Read `.squad/prompts/generate-plan.md` completely. Treat it as your operating instructions for structure, tone, and output rules.
15
+ 1. Read `generate-plan.md` from the installed squad-kit package completely. Treat it as your operating instructions for structure, tone, and output rules.
16
16
  2. Read the intake file, plus any files in its `attachments/` directory that the intake references.
17
- 3. Read one or two existing plan files under `.squad/plans/` (if any) to match established tone. If none exist, use `.squad/prompts/story-skeleton.md`.
17
+ 3. Read one or two existing plan files under `.squad/plans/` (if any) to match established tone. If none exist, use `story-skeleton.md` from the same `templates/prompts/` directory in the squad-kit package.
18
18
  4. Determine the next sequence number by scanning `.squad/plans/**/NN-story-*.md`, honouring `config.yaml.naming.globalSequence`.
19
19
  5. Write the plan file to `.squad/plans/<feature-slug>/NN-story-<slug>[-<id>].md`.
20
20
  6. Update the feature's `00-overview.md` and `.squad/plans/00-index.md` if it's a new feature slug.
@@ -4,7 +4,7 @@ prompt = """
4
4
  Generate an implementation plan using the squad-kit workflow.
5
5
 
6
6
  Steps:
7
- 1. Read .squad/prompts/generate-plan.md and follow its instructions exactly.
7
+ 1. Read generate-plan.md from the installed squad-kit package (templates/prompts/; not under .squad/) and follow its instructions exactly.
8
8
  2. Read the intake file at the argument path (under .squad/stories/) plus any referenced files in its attachments/.
9
9
  3. Read .squad/config.yaml for tracker type and naming rules.
10
10
  4. Scan .squad/plans/**/NN-story-*.md to determine the next global sequence number.
@@ -19,6 +19,7 @@ You are maintaining **agent-executable implementation plans** for this project.
19
19
 
20
20
  - Project roots: `{{projectRoots}}`
21
21
  - Primary language: `{{primaryLanguage}}`
22
+ - Tracker type: `{{trackerType}}`
22
23
  - Existing plans in `.squad/plans/` — read one or two to match tone and file-oriented style.
23
24
 
24
25
  ## Story document pattern
@@ -6,7 +6,7 @@ Fill this template for each story you want planned. Keep it copy-paste-friendly:
6
6
  - Binaries (screenshots, PDFs, exports): put them in `attachments/` next to this file and list them below.
7
7
  - Do **not** rely on external links (tracker URLs, wiki, chat) — the planner cannot open them. Paste the content you want considered.
8
8
 
9
- This is **not** an implementation prompt. It is the input to `.squad/prompts/generate-plan.md`.
9
+ This is **not** an implementation prompt. It is the input to the plan-generation meta-prompt bundled with squad-kit (`generate-plan.md` in the installed package).
10
10
 
11
11
  ---
12
12