safeword 0.7.5 → 0.7.6
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 +14 -15
- package/templates/SAFEWORD.md +36 -26
- package/templates/scripts/lint-md.sh +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "safeword",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.6",
|
|
4
4
|
"description": "CLI for setting up and managing safeword development environments",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -19,18 +19,6 @@
|
|
|
19
19
|
"engines": {
|
|
20
20
|
"node": ">=18"
|
|
21
21
|
},
|
|
22
|
-
"scripts": {
|
|
23
|
-
"build": "tsup",
|
|
24
|
-
"dev": "tsup --watch",
|
|
25
|
-
"test": "vitest run",
|
|
26
|
-
"test:e2e": "vitest run tests/e2e/",
|
|
27
|
-
"test:watch": "vitest",
|
|
28
|
-
"test:coverage": "vitest run --coverage",
|
|
29
|
-
"typecheck": "tsc --noEmit",
|
|
30
|
-
"lint": "eslint src tests",
|
|
31
|
-
"clean": "rm -rf dist",
|
|
32
|
-
"prepublishOnly": "npm run build && npm test"
|
|
33
|
-
},
|
|
34
22
|
"dependencies": {
|
|
35
23
|
"commander": "^12.1.0"
|
|
36
24
|
},
|
|
@@ -48,5 +36,16 @@
|
|
|
48
36
|
"claude-code"
|
|
49
37
|
],
|
|
50
38
|
"author": "",
|
|
51
|
-
"license": "MIT"
|
|
52
|
-
|
|
39
|
+
"license": "MIT",
|
|
40
|
+
"scripts": {
|
|
41
|
+
"build": "tsup",
|
|
42
|
+
"dev": "tsup --watch",
|
|
43
|
+
"test": "vitest run",
|
|
44
|
+
"test:e2e": "vitest run tests/e2e/",
|
|
45
|
+
"test:watch": "vitest",
|
|
46
|
+
"test:coverage": "vitest run --coverage",
|
|
47
|
+
"typecheck": "tsc --noEmit",
|
|
48
|
+
"lint": "eslint src tests",
|
|
49
|
+
"clean": "rm -rf dist"
|
|
50
|
+
}
|
|
51
|
+
}
|
package/templates/SAFEWORD.md
CHANGED
|
@@ -44,21 +44,21 @@ Training data is stale. Follow this sequence:
|
|
|
44
44
|
|
|
45
45
|
**Read the matching guide when ANY trigger fires:**
|
|
46
46
|
|
|
47
|
-
| Trigger | Guide
|
|
48
|
-
| --------------------------------------------------------- |
|
|
49
|
-
| Starting ANY feature, bug fix, or enhancement |
|
|
50
|
-
| Need to write OR review user stories |
|
|
51
|
-
| Need to write OR review test definitions |
|
|
52
|
-
| Writing tests, doing TDD, or test is failing |
|
|
53
|
-
| Creating OR updating a design doc |
|
|
54
|
-
| Making architectural decision OR writing ADR |
|
|
55
|
-
| Designing data models, schemas, or database changes |
|
|
56
|
-
| Calling LLM APIs OR writing LLM-consumable docs |
|
|
57
|
-
| Updating CLAUDE.md, SAFEWORD.md, or any context file |
|
|
58
|
-
| Hit same bug 3+ times OR discovered undocumented gotcha |
|
|
59
|
-
| Process hanging, port in use, or zombie process suspected |
|
|
60
|
-
| Using `safeword` CLI commands |
|
|
61
|
-
| Debugging issues OR need git/cross-platform guidance |
|
|
47
|
+
| Trigger | Guide |
|
|
48
|
+
| --------------------------------------------------------- | ----------------------------------------------- |
|
|
49
|
+
| Starting ANY feature, bug fix, or enhancement | `./.safeword/guides/development-workflow.md` |
|
|
50
|
+
| Need to write OR review user stories | `./.safeword/guides/user-story-guide.md` |
|
|
51
|
+
| Need to write OR review test definitions | `./.safeword/guides/test-definitions-guide.md` |
|
|
52
|
+
| Writing tests, doing TDD, or test is failing | `./.safeword/guides/tdd-best-practices.md` |
|
|
53
|
+
| Creating OR updating a design doc | `./.safeword/guides/design-doc-guide.md` |
|
|
54
|
+
| Making architectural decision OR writing ADR | `./.safeword/guides/architecture-guide.md` |
|
|
55
|
+
| Designing data models, schemas, or database changes | `./.safeword/guides/data-architecture-guide.md` |
|
|
56
|
+
| Calling LLM APIs OR writing LLM-consumable docs | `./.safeword/guides/llm-guide.md` |
|
|
57
|
+
| Updating CLAUDE.md, SAFEWORD.md, or any context file | `./.safeword/guides/context-files-guide.md` |
|
|
58
|
+
| Hit same bug 3+ times OR discovered undocumented gotcha | `./.safeword/guides/learning-extraction.md` |
|
|
59
|
+
| Process hanging, port in use, or zombie process suspected | `./.safeword/guides/zombie-process-cleanup.md` |
|
|
60
|
+
| Using `safeword` CLI commands | `./.safeword/guides/cli-reference.md` |
|
|
61
|
+
| Debugging issues OR need git/cross-platform guidance | `./.safeword/guides/code-philosophy.md` |
|
|
62
62
|
|
|
63
63
|
---
|
|
64
64
|
|
|
@@ -66,15 +66,15 @@ Training data is stale. Follow this sequence:
|
|
|
66
66
|
|
|
67
67
|
**Use the matching template when ANY trigger fires:**
|
|
68
68
|
|
|
69
|
-
| Trigger | Template
|
|
70
|
-
| ---------------------------------------------------------- |
|
|
71
|
-
| Planning new feature scope OR creating feature spec |
|
|
72
|
-
| Bug, improvement, refactor, or internal task |
|
|
73
|
-
| Need test definitions for a feature OR acceptance criteria |
|
|
74
|
-
| Feature spans 3+ components OR needs technical spec |
|
|
75
|
-
| Making decision with long-term impact OR trade-offs |
|
|
76
|
-
| Task needs context anchoring (see Ticket System below) |
|
|
77
|
-
| Starting execution of a plan, ticket, or spec |
|
|
69
|
+
| Trigger | Template |
|
|
70
|
+
| ---------------------------------------------------------- | --------------------------------------------------- |
|
|
71
|
+
| Planning new feature scope OR creating feature spec | `./.safeword/templates/feature-spec-template.md` |
|
|
72
|
+
| Bug, improvement, refactor, or internal task | `./.safeword/templates/task-spec-template.md` |
|
|
73
|
+
| Need test definitions for a feature OR acceptance criteria | `./.safeword/templates/test-definitions-feature.md` |
|
|
74
|
+
| Feature spans 3+ components OR needs technical spec | `./.safeword/templates/design-doc-template.md` |
|
|
75
|
+
| Making decision with long-term impact OR trade-offs | `./.safeword/templates/architecture-template.md` |
|
|
76
|
+
| Task needs context anchoring (see Ticket System below) | `./.safeword/templates/ticket-template.md` |
|
|
77
|
+
| Starting execution of a plan, ticket, or spec | `./.safeword/templates/work-log-template.md` |
|
|
78
78
|
|
|
79
79
|
---
|
|
80
80
|
|
|
@@ -286,9 +286,19 @@ When markdown lint reports MD040 (missing language), choose:
|
|
|
286
286
|
|
|
287
287
|
---
|
|
288
288
|
|
|
289
|
-
##
|
|
289
|
+
## Learnings
|
|
290
290
|
|
|
291
|
-
**
|
|
291
|
+
**Location:** `.safeword/learnings/`
|
|
292
|
+
|
|
293
|
+
**Check learnings FIRST when:**
|
|
294
|
+
|
|
295
|
+
1. Stuck on an issue OR debugging same problem 2+ times
|
|
296
|
+
2. Working with unfamiliar technology in this codebase
|
|
297
|
+
3. Issue involves testing, processes, or integrations
|
|
298
|
+
|
|
299
|
+
**How:** `ls .safeword/learnings/` then read relevant files.
|
|
300
|
+
|
|
301
|
+
**Extract new learning when ANY apply:**
|
|
292
302
|
|
|
293
303
|
- 5+ debug cycles on same issue
|
|
294
304
|
- 3+ approaches tried
|
|
File without changes
|