@nolrm/contextkit 0.13.3 → 0.13.4
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/README.md +3 -0
- package/lib/commands/install.js +14 -0
- package/lib/commands/update.js +14 -0
- package/lib/integrations/claude-integration.js +35 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -142,6 +142,9 @@ ContextKit installs reusable slash commands for supported platforms:
|
|
|
142
142
|
| `/refactor` | Refactor code with safety checks |
|
|
143
143
|
| `/test` | Generate comprehensive tests |
|
|
144
144
|
| `/doc` | Add documentation |
|
|
145
|
+
| `/doc-arch` | Generate architecture docs (`docs/architecture.md`) — stack-aware (Level 1) |
|
|
146
|
+
| `/doc-feature` | Generate feature-level docs (`docs/features/<name>.md`) — stack-aware (Level 2) |
|
|
147
|
+
| `/doc-component` | Generate component-level docs colocated with the target file — stack-aware (Level 3) |
|
|
145
148
|
| `/spec` | Write a component spec (MD-first) before any code is created |
|
|
146
149
|
| `/squad` | Kick off a squad task — one task or many (auto-detects batch mode). Pushes back with clarifying questions if the task is vague. |
|
|
147
150
|
| `/squad-architect` | Design the technical plan from the PO spec |
|
package/lib/commands/install.js
CHANGED
|
@@ -806,6 +806,20 @@ Any design decisions, trade-offs, or open questions to resolve before coding.
|
|
|
806
806
|
'.contextkit/commands/health-check.md'
|
|
807
807
|
);
|
|
808
808
|
|
|
809
|
+
// Download doc family commands
|
|
810
|
+
await this.downloadManager.downloadFile(
|
|
811
|
+
`${this.repoUrl}/commands/doc-arch.md`,
|
|
812
|
+
'.contextkit/commands/doc-arch.md'
|
|
813
|
+
);
|
|
814
|
+
await this.downloadManager.downloadFile(
|
|
815
|
+
`${this.repoUrl}/commands/doc-feature.md`,
|
|
816
|
+
'.contextkit/commands/doc-feature.md'
|
|
817
|
+
);
|
|
818
|
+
await this.downloadManager.downloadFile(
|
|
819
|
+
`${this.repoUrl}/commands/doc-component.md`,
|
|
820
|
+
'.contextkit/commands/doc-component.md'
|
|
821
|
+
);
|
|
822
|
+
|
|
809
823
|
// Download hooks (pre-push and commit-msg only, no pre-commit)
|
|
810
824
|
await this.downloadManager.downloadFile(
|
|
811
825
|
`${this.repoUrl}/hooks/pre-push`,
|
package/lib/commands/update.js
CHANGED
|
@@ -318,6 +318,20 @@ class UpdateCommand {
|
|
|
318
318
|
'.contextkit/commands/health-check.md'
|
|
319
319
|
);
|
|
320
320
|
|
|
321
|
+
// Download doc family commands
|
|
322
|
+
await this.downloadManager.downloadFile(
|
|
323
|
+
`${this.repoUrl}/commands/doc-arch.md`,
|
|
324
|
+
'.contextkit/commands/doc-arch.md'
|
|
325
|
+
);
|
|
326
|
+
await this.downloadManager.downloadFile(
|
|
327
|
+
`${this.repoUrl}/commands/doc-feature.md`,
|
|
328
|
+
'.contextkit/commands/doc-feature.md'
|
|
329
|
+
);
|
|
330
|
+
await this.downloadManager.downloadFile(
|
|
331
|
+
`${this.repoUrl}/commands/doc-component.md`,
|
|
332
|
+
'.contextkit/commands/doc-component.md'
|
|
333
|
+
);
|
|
334
|
+
|
|
321
335
|
// Update CI squad workflow if the user opted in
|
|
322
336
|
if (config.features?.squad_ci_workflow) {
|
|
323
337
|
await fs.ensureDir('.github/workflows');
|
|
@@ -28,6 +28,9 @@ class ClaudeIntegration extends BaseIntegration {
|
|
|
28
28
|
'.claude/commands/squad-doc.md',
|
|
29
29
|
'.claude/commands/spec.md',
|
|
30
30
|
'.claude/commands/ck.md',
|
|
31
|
+
'.claude/commands/doc-arch.md',
|
|
32
|
+
'.claude/commands/doc-feature.md',
|
|
33
|
+
'.claude/commands/doc-component.md',
|
|
31
34
|
];
|
|
32
35
|
this.platformDir = '.claude/rules';
|
|
33
36
|
}
|
|
@@ -281,6 +284,34 @@ After review passes, create or update companion .md files for every new/modified
|
|
|
281
284
|
Read \`.contextkit/commands/health-check.md\` and execute the health check workflow.
|
|
282
285
|
|
|
283
286
|
Check project setup, standards status, and integrations. Report what needs attention.
|
|
287
|
+
`);
|
|
288
|
+
|
|
289
|
+
// Doc family slash commands
|
|
290
|
+
await this.writeGeneratedFile('.claude/commands/doc-arch.md', `# Doc — Architecture (Level 1)
|
|
291
|
+
|
|
292
|
+
Read \`.contextkit/commands/doc-arch.md\` and execute the architecture documentation workflow.
|
|
293
|
+
|
|
294
|
+
Detect the project stack, then generate or update \`docs/architecture.md\` with system boundaries, key flows, and stack-appropriate artifacts (Mermaid diagrams, component trees, service maps).
|
|
295
|
+
|
|
296
|
+
Pass an optional PR number to scope to that PR's changes.
|
|
297
|
+
`);
|
|
298
|
+
|
|
299
|
+
await this.writeGeneratedFile('.claude/commands/doc-feature.md', `# Doc — Feature (Level 2)
|
|
300
|
+
|
|
301
|
+
Read \`.contextkit/commands/doc-feature.md\` and execute the feature documentation workflow.
|
|
302
|
+
|
|
303
|
+
Detect the project stack, identify the target feature from the argument or current branch, then generate or update \`docs/features/<name>.md\` with purpose, components/modules, data flow, and user flows.
|
|
304
|
+
|
|
305
|
+
Pass a feature name, directory path, or PR number to scope the documentation.
|
|
306
|
+
`);
|
|
307
|
+
|
|
308
|
+
await this.writeGeneratedFile('.claude/commands/doc-component.md', `# Doc — Component (Level 3)
|
|
309
|
+
|
|
310
|
+
Read \`.contextkit/commands/doc-component.md\` and execute the component documentation workflow.
|
|
311
|
+
|
|
312
|
+
Detect the project stack, read the target file or directory, then create or update a colocated \`<name>.md\` with API/props, usage examples, behavior, and edge cases.
|
|
313
|
+
|
|
314
|
+
Pass a file path or directory to target. Omit to infer from current context.
|
|
284
315
|
`);
|
|
285
316
|
}
|
|
286
317
|
|
|
@@ -296,7 +327,10 @@ Check project setup, standards status, and integrations. Report what needs atten
|
|
|
296
327
|
console.log(chalk.dim(' /fix — Diagnose and fix a bug'));
|
|
297
328
|
console.log(chalk.dim(' /refactor — Refactor code structure'));
|
|
298
329
|
console.log(chalk.dim(' /test — Generate or run tests'));
|
|
299
|
-
console.log(chalk.dim(' /doc
|
|
330
|
+
console.log(chalk.dim(' /doc — Add documentation'));
|
|
331
|
+
console.log(chalk.dim(' /doc-arch — Architecture docs (Level 1)'));
|
|
332
|
+
console.log(chalk.dim(' /doc-feature — Feature docs (Level 2)'));
|
|
333
|
+
console.log(chalk.dim(' /doc-component — Component docs (Level 3)'));
|
|
300
334
|
console.log(chalk.dim(''));
|
|
301
335
|
console.log(chalk.dim(' Squad (multi-agent workflow):'));
|
|
302
336
|
console.log(chalk.dim(' /squad "task" — Kickoff: create handoff + PO spec'));
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@nolrm/contextkit",
|
|
3
|
-
"version": "0.13.
|
|
3
|
+
"version": "0.13.4",
|
|
4
4
|
"description": "ContextKit - Context Engineering for AI Development. Provide rich context to AI through structured MD files with standards, code guides, and documentation. Works with Cursor, Claude, Aider, VS Code Copilot, and more.",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"bin": {
|