prizmkit 1.0.121 → 1.0.122
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/bundled/VERSION.json
CHANGED
|
@@ -46,7 +46,54 @@ Execute implementation by following the task breakdown in plan.md. Respects task
|
|
|
46
46
|
f. Error handling: sequential tasks stop on failure (later tasks may depend on this one). Parallel `[P]` tasks continue — report all failures at the end.
|
|
47
47
|
5. At each checkpoint: verify build passes and tests pass. Checkpoints catch integration errors early — skipping them means cascading failures in later phases that are much harder to debug.
|
|
48
48
|
6. After all tasks: run full test suite
|
|
49
|
-
7.
|
|
49
|
+
7. **Deploy guide update** (only when new frameworks/tools were added):
|
|
50
|
+
- Check if any dependency manifests were modified in this session:
|
|
51
|
+
```bash
|
|
52
|
+
git diff --name-only HEAD -- package.json requirements*.txt Pipfile pyproject.toml go.mod Cargo.toml pom.xml build.gradle Gemfile composer.json docker-compose*.yml Dockerfile .tool-versions 2>/dev/null
|
|
53
|
+
```
|
|
54
|
+
- If no manifest files changed → skip this step entirely
|
|
55
|
+
- If manifest files changed, scan for **newly added** dependencies (not version bumps):
|
|
56
|
+
```bash
|
|
57
|
+
git diff -U0 HEAD -- package.json requirements*.txt Pipfile pyproject.toml go.mod Cargo.toml pom.xml build.gradle Gemfile composer.json docker-compose*.yml Dockerfile .tool-versions 2>/dev/null | grep '^\+' | grep -v '^\+\+\+' | head -30
|
|
58
|
+
```
|
|
59
|
+
- For each genuinely new framework/tool, record in `deploy_guide.md` at project root:
|
|
60
|
+
|
|
61
|
+
| Field | Description | Source |
|
|
62
|
+
|-------|-------------|--------|
|
|
63
|
+
| **Name** | Framework/tool name | Package name from manifest |
|
|
64
|
+
| **Version** | Installed version or constraint | Version spec from manifest |
|
|
65
|
+
| **Purpose** | Why it was introduced | You just added it — you know why |
|
|
66
|
+
| **Install Command** | How to install locally | Standard install command for the ecosystem |
|
|
67
|
+
| **Key Config** | Config files or env vars needed | Config files you just created/modified |
|
|
68
|
+
| **Notes** | Setup gotchas, required services | Docker services, manual steps, env vars |
|
|
69
|
+
|
|
70
|
+
- Template for `deploy_guide.md`:
|
|
71
|
+
```markdown
|
|
72
|
+
# Deploy Guide
|
|
73
|
+
|
|
74
|
+
> Auto-maintained by PrizmKit. Manual edits are preserved.
|
|
75
|
+
> Last updated: YYYY-MM-DD
|
|
76
|
+
|
|
77
|
+
## Frameworks & Tools
|
|
78
|
+
|
|
79
|
+
### <Framework Name>
|
|
80
|
+
|
|
81
|
+
- **Version**: <version constraint>
|
|
82
|
+
- **Purpose**: <why this framework is used>
|
|
83
|
+
- **Install**:
|
|
84
|
+
```bash
|
|
85
|
+
<install command>
|
|
86
|
+
```
|
|
87
|
+
- **Key Config**:
|
|
88
|
+
- `<config file or env var>`: <description>
|
|
89
|
+
- **Notes**:
|
|
90
|
+
- <any setup gotchas, required external services, manual steps>
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
- **Update rules**: create file if absent; append new sections if file exists; update version if framework already documented; preserve manually added content; keep entries sorted alphabetically
|
|
94
|
+
- **Filter out**: patch version bumps of existing deps, dev-only tools needing no setup (linters, formatters), transitive/lock-file-only changes
|
|
95
|
+
- Stage the file: `git add deploy_guide.md`
|
|
96
|
+
8. Output implementation summary with pass/fail status
|
|
50
97
|
|
|
51
98
|
## Task Format in plan.md
|
|
52
99
|
|
|
@@ -85,4 +132,5 @@ If a session is interrupted mid-implementation:
|
|
|
85
132
|
|
|
86
133
|
- Code files created/modified as specified in plan.md Tasks section
|
|
87
134
|
- `plan.md` Tasks section updated with completion markers `[x]`
|
|
135
|
+
- `deploy_guide.md` created/updated (only when new frameworks/tools were added)
|
|
88
136
|
- Implementation summary output to conversation
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: "prizmkit-retrospective"
|
|
3
|
-
description: "Incremental .prizm-docs/ maintainer
|
|
3
|
+
description: "Incremental .prizm-docs/ maintainer. Performs two jobs: (1) structural sync — update .prizm-docs/ KEY_FILES/INTERFACES/DEPENDENCIES, (2) architecture knowledge — inject TRAPS/RULES/DECISIONS into .prizm-docs/. All project knowledge lives in .prizm-docs/ . Run after code review passes and before committing. Trigger on: 'retrospective', 'retro', 'update docs', 'sync docs', 'wrap up', 'done with feature', 'feature complete'. (project)"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
# PrizmKit Retrospective
|
|
@@ -11,11 +11,10 @@ All project knowledge is maintained in a single store:
|
|
|
11
11
|
|-------|----------|---------|---------|
|
|
12
12
|
| **Architecture Index** | `.prizm-docs/` | MODULE, FILES, INTERFACES, DEPENDENCIES, TRAPS, RULES, DECISIONS | AI quickly locates code structure, interfaces, known pitfalls, and key design decisions |
|
|
13
13
|
|
|
14
|
-
**This skill performs
|
|
14
|
+
**This skill performs two jobs in one pass:**
|
|
15
15
|
|
|
16
16
|
1. **Structural Sync** — reflect what changed in code → `.prizm-docs/` (KEY_FILES, INTERFACES, DEPENDENCIES, file counts)
|
|
17
17
|
2. **Architecture Knowledge** — inject TRAPS, RULES, and DECISIONS → `.prizm-docs/`. All knowledge is consolidated in `.prizm-docs/`.
|
|
18
|
-
3. **Deploy Guide** — detect new frameworks/tools and record setup instructions → `deploy_guide.md`
|
|
19
18
|
|
|
20
19
|
No other skill writes to `.prizm-docs/`. This is the sole writer during ongoing development. For initial doc setup, validation, or migration, use `/prizmkit-prizm-docs` instead.
|
|
21
20
|
|
|
@@ -151,132 +150,6 @@ When writing TRAPS:
|
|
|
151
150
|
|
|
152
151
|
---
|
|
153
152
|
|
|
154
|
-
## Job 3: Deploy Guide Maintenance (`deploy_guide.md`)
|
|
155
|
-
|
|
156
|
-
When new frameworks or tools that require **manual setup steps** are introduced, record them in `deploy_guide.md` at the project root. This ensures installation, configuration, and deployment knowledge is systematically documented for the team.
|
|
157
|
-
|
|
158
|
-
### When to Run Job 3
|
|
159
|
-
|
|
160
|
-
Run this job **only when new frameworks/tools are detected** in the current changeset. Skip entirely if no new framework was introduced.
|
|
161
|
-
|
|
162
|
-
### Step 3-1: Detect New Frameworks
|
|
163
|
-
|
|
164
|
-
From the `git diff --cached` (or `git diff`) output already collected in Job 1, check for newly added entries in dependency manifest files:
|
|
165
|
-
|
|
166
|
-
```bash
|
|
167
|
-
# Check for newly added dependencies in common manifest files
|
|
168
|
-
git diff --cached -U0 -- package.json requirements*.txt Pipfile pyproject.toml go.mod Cargo.toml pom.xml build.gradle Gemfile composer.json docker-compose*.yml Dockerfile .tool-versions 2>/dev/null | grep '^\+' | grep -v '^\+\+\+' | head -30
|
|
169
|
-
```
|
|
170
|
-
|
|
171
|
-
**Trigger conditions** (ANY match → proceed to Step 3-2):
|
|
172
|
-
- New dependency added to `package.json` (dependencies/devDependencies)
|
|
173
|
-
- New package in `requirements.txt`, `pyproject.toml`, `Pipfile`, `go.mod`, `Cargo.toml`, `pom.xml`, `build.gradle`, `Gemfile`, `composer.json`
|
|
174
|
-
- New service in `docker-compose*.yml` (e.g., database, cache, message queue)
|
|
175
|
-
- New `Dockerfile` created or base image changed
|
|
176
|
-
- New system tool in `.tool-versions`, `.nvmrc`, `.python-version`
|
|
177
|
-
- New CI/CD configuration file added (`.github/workflows/*.yml`, `.gitlab-ci.yml`, `Jenkinsfile`)
|
|
178
|
-
|
|
179
|
-
**Filter out** (do NOT record):
|
|
180
|
-
- Patch version bumps of existing dependencies (e.g., `1.2.3` → `1.2.4`)
|
|
181
|
-
- Dev-only tools that need no manual setup (linters, formatters, type checkers)
|
|
182
|
-
- Transitive dependencies (lock file changes without manifest changes)
|
|
183
|
-
|
|
184
|
-
### Step 3-2: Record Framework Info
|
|
185
|
-
|
|
186
|
-
For each detected new framework/tool, gather the following information from the code changes and dependency files:
|
|
187
|
-
|
|
188
|
-
| Field | Description | Source |
|
|
189
|
-
|-------|-------------|--------|
|
|
190
|
-
| **Name** | Framework/tool name | Package name from manifest |
|
|
191
|
-
| **Version** | Installed version or constraint | Version spec from manifest |
|
|
192
|
-
| **Purpose** | Why it was introduced | Infer from code usage, feature context, or commit message |
|
|
193
|
-
| **Install Command** | How to install locally | Standard install command for the ecosystem |
|
|
194
|
-
| **Key Config** | Config files or env vars needed | Scan for new config files, `.env` entries, or env references in code |
|
|
195
|
-
| **Notes** | Setup gotchas, required services, manual steps | Infer from Dockerfile, docker-compose, README references, or TRAPS |
|
|
196
|
-
|
|
197
|
-
### Step 3-3: Update `deploy_guide.md`
|
|
198
|
-
|
|
199
|
-
Write or append to `deploy_guide.md` at the project root using this template:
|
|
200
|
-
|
|
201
|
-
```markdown
|
|
202
|
-
# Deploy Guide
|
|
203
|
-
|
|
204
|
-
> Auto-maintained by PrizmKit retrospective. Manual edits are preserved.
|
|
205
|
-
> Last updated: YYYY-MM-DD
|
|
206
|
-
|
|
207
|
-
## Frameworks & Tools
|
|
208
|
-
|
|
209
|
-
### <Framework Name>
|
|
210
|
-
|
|
211
|
-
- **Version**: <version constraint>
|
|
212
|
-
- **Purpose**: <why this framework is used>
|
|
213
|
-
- **Install**:
|
|
214
|
-
```bash
|
|
215
|
-
<install command>
|
|
216
|
-
```
|
|
217
|
-
- **Key Config**:
|
|
218
|
-
- `<config file or env var>`: <description>
|
|
219
|
-
- **Notes**:
|
|
220
|
-
- <any setup gotchas, required external services, manual steps>
|
|
221
|
-
```
|
|
222
|
-
|
|
223
|
-
**Update rules**:
|
|
224
|
-
- If `deploy_guide.md` does not exist → create it with the header and first framework entry
|
|
225
|
-
- If `deploy_guide.md` exists → check if the framework already has a section (match by `### <Name>` heading). If yes, update version and any changed config. If no, append a new section.
|
|
226
|
-
- Preserve any manually added content (sections not matching the template are left untouched)
|
|
227
|
-
- Keep entries sorted alphabetically by framework name within `## Frameworks & Tools`
|
|
228
|
-
|
|
229
|
-
**Stage the file**:
|
|
230
|
-
```bash
|
|
231
|
-
git add deploy_guide.md
|
|
232
|
-
```
|
|
233
|
-
|
|
234
|
-
### Example
|
|
235
|
-
|
|
236
|
-
After adding PostgreSQL via docker-compose and Prisma ORM to a Node.js project:
|
|
237
|
-
|
|
238
|
-
```markdown
|
|
239
|
-
# Deploy Guide
|
|
240
|
-
|
|
241
|
-
> Auto-maintained by PrizmKit retrospective. Manual edits are preserved.
|
|
242
|
-
> Last updated: 2026-03-27
|
|
243
|
-
|
|
244
|
-
## Frameworks & Tools
|
|
245
|
-
|
|
246
|
-
### PostgreSQL
|
|
247
|
-
|
|
248
|
-
- **Version**: 16
|
|
249
|
-
- **Purpose**: Primary relational database for user data, orders, and product catalog
|
|
250
|
-
- **Install**:
|
|
251
|
-
```bash
|
|
252
|
-
docker compose up -d postgres
|
|
253
|
-
```
|
|
254
|
-
- **Key Config**:
|
|
255
|
-
- `DATABASE_URL` (env): PostgreSQL connection string, format `postgresql://user:pass@host:5432/dbname`
|
|
256
|
-
- `docker-compose.yml`: Service `postgres` with volume `pgdata`
|
|
257
|
-
- **Notes**:
|
|
258
|
-
- Requires Docker running locally
|
|
259
|
-
- Run `npx prisma migrate deploy` after first start to initialize schema
|
|
260
|
-
|
|
261
|
-
### Prisma
|
|
262
|
-
|
|
263
|
-
- **Version**: ^5.20.0
|
|
264
|
-
- **Purpose**: ORM for type-safe database access and schema migrations
|
|
265
|
-
- **Install**:
|
|
266
|
-
```bash
|
|
267
|
-
npm install prisma @prisma/client
|
|
268
|
-
npx prisma generate
|
|
269
|
-
```
|
|
270
|
-
- **Key Config**:
|
|
271
|
-
- `prisma/schema.prisma`: Database schema definition
|
|
272
|
-
- `DATABASE_URL` (env): Shared with PostgreSQL connection
|
|
273
|
-
- **Notes**:
|
|
274
|
-
- After schema changes: `npx prisma migrate dev --name <description>`
|
|
275
|
-
- Generate client after pull: `npx prisma generate`
|
|
276
|
-
```
|
|
277
|
-
|
|
278
|
-
---
|
|
279
|
-
|
|
280
153
|
## Final: Changelog + Stage
|
|
281
154
|
|
|
282
155
|
**3a.** Append to `.prizm-docs/changelog.prizm`:
|
|
@@ -287,8 +160,6 @@ After adding PostgreSQL via docker-compose and Prisma ORM to a Node.js project:
|
|
|
287
160
|
**3b.** Stage all doc changes:
|
|
288
161
|
```bash
|
|
289
162
|
git add .prizm-docs/
|
|
290
|
-
# Stage deploy guide if it was created/updated
|
|
291
|
-
git add deploy_guide.md 2>/dev/null || true
|
|
292
163
|
```
|
|
293
164
|
|
|
294
165
|
**3c.** Handoff:
|
|
@@ -318,5 +189,4 @@ The pipeline enforces a **docs pass condition**: `.prizm-docs/` must show change
|
|
|
318
189
|
|
|
319
190
|
- `.prizm-docs/*.prizm` — Structurally synced + TRAPS/RULES/DECISIONS enriched
|
|
320
191
|
- `.prizm-docs/changelog.prizm` — Appended entries
|
|
321
|
-
-
|
|
322
|
-
- All `.prizm-docs/` changes and `deploy_guide.md` staged via `git add`
|
|
192
|
+
- All `.prizm-docs/` changes staged via `git add`
|