codeassembly-guidance 0.2.0 → 0.3.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/.meta/changelog.json +227 -0
- package/CHANGELOG.md +59 -0
- package/README.md +37 -121
- package/content/_partials/README.md +19 -3
- package/content/_partials/diff-audit-checklist.md +1 -0
- package/content/_partials/kb-standard-tags.md +7 -0
- package/content/codeassembly-content.yaml +6 -0
- package/content/collections/recommended.md +1 -1
- package/content/guidance/README.md +1 -1
- package/content/guidance/rulebooks/cli-conventions.md +16 -2
- package/content/guidance/rulebooks/codeassembly-content-specification.md +19 -2
- package/content/guidance/rulebooks/commit-conventions.md +3 -2
- package/content/guidance/rulebooks/williamthorsen-collaboration-preferences.md +6 -2
- package/content/guidance/rulebooks/williamthorsen-writing-preferences.md +28 -1
- package/content/guidance/shared/AGENTS.md +31 -4
- package/content/scripts/check-prose.mjs +38 -38
- package/content/scripts/describe-change.mjs +69 -69
- package/content/scripts/manage-jira-ticket.mjs +73 -73
- package/content/scripts/validate-preferences.mjs +1 -1
- package/content/skills/_data/action-items.md +2 -0
- package/content/skills/_data/artifact-conventions.md +18 -2
- package/content/skills/_data/complexity-classification.md +1 -1
- package/content/skills/_data/design-priorities.md +12 -1
- package/content/skills/_data/spike-conventions.md +21 -6
- package/content/skills/_data/title-templates.md +3 -1
- package/content/skills/_partials/apply-guidance-edits.md +5 -0
- package/content/skills/_partials/commit-title-rendering.md +1 -1
- package/content/skills/_partials/next-steps-after-plan.md +1 -1
- package/content/skills/_partials/option-format.md +2 -2
- package/content/skills/_partials/plan-template.md +4 -2
- package/content/skills/_partials/ticket-and-plan-completeness.md +1 -1
- package/content/skills/_partials/ticket-composition.md +40 -0
- package/content/skills/_partials/ticket-skeleton.md +15 -1
- package/content/skills/align-ticket-with-implementation/SKILL.md +1 -5
- package/content/skills/assess-code-health/SKILL.md +127 -0
- package/content/skills/assess-code-health/assess-code-health.mjs +77 -0
- package/content/skills/assess-usability/SKILL.md +3 -1
- package/content/skills/capture-event/SKILL.md +2 -0
- package/content/skills/capture-feedback/SKILL.md +1 -1
- package/content/skills/collaborate/SKILL.md +2 -2
- package/content/skills/create-bitbucket-pr/SKILL.md +2 -1
- package/content/skills/create-commit/SKILL.md +1 -1
- package/content/skills/create-gh-pr/SKILL.md +4 -1
- package/content/skills/create-pr/SKILL.md +2 -1
- package/content/skills/create-ticket/SKILL.md +3 -7
- package/content/skills/derive-session-context/derive-session-context.mjs +94 -94
- package/content/skills/design-and-plan/SKILL.md +5 -9
- package/content/skills/implement-plan/SKILL.md +2 -2
- package/content/skills/index-prototypes/SKILL.md +1 -1
- package/content/skills/kb-add/SKILL.md +2 -0
- package/content/skills/kb-edit/SKILL.md +2 -0
- package/content/skills/kb-edit/kb-edit.mjs +24 -24
- package/content/skills/kb-retrieve/kb-retrieve.mjs +75 -75
- package/content/skills/kb-retrieve-events/SKILL.md +19 -10
- package/content/skills/kb-retrieve-events/kb-retrieve-events.mjs +75 -75
- package/content/skills/kb-update-events/SKILL.md +9 -6
- package/content/skills/kb-update-events/kb-update-events.mjs +86 -85
- package/content/skills/lesson-clusters/lesson-clusters.mjs +209 -0
- package/content/skills/plan/SKILL.md +1 -1
- package/content/skills/refine-guidance/SKILL.md +97 -0
- package/content/skills/review-branch/SKILL.md +350 -1
- package/content/skills/revise-prose/revise-prose.mjs +85 -85
- package/content/skills/save-artifact/SKILL.md +1 -1
- package/content/skills/streamline-guidance/SKILL.md +10 -15
- package/content/skills/streamline-guidance/streamline-guidance.mjs +73 -73
- package/content/skills/summarize-change/SKILL.md +1 -1
- package/content/skills/testing-conventions/SKILL.md +7 -1
- package/content/skills/triage-feedback/SKILL.md +150 -0
- package/content/skills/triage-feedback/triage-feedback.mjs +70 -0
- package/content/skills/triage-spike-findings/SKILL.md +5 -5
- package/content/skills/triage-spike-findings/triage-spike-findings.mjs +30 -28
- package/content/skills/update-project-guidance/SKILL.md +10 -10
- package/content/subagents/code-health-assessor.md +98 -0
- package/content/subagents/feedback-triage-challenger.md +81 -0
- package/content/subagents/lesson-clusterer.md +68 -0
- package/package.json +13 -13
- package/schemas/preferences.v1.json +22 -6
- package/schemas/work-types.v1.json +1 -1
- package/content/_partials/code-descriptions.md +0 -4
- package/content/_partials/code-style.md +0 -7
- package/content/_partials/live-repo-writes.md +0 -13
- package/content/_partials/reduced-object-relative.md +0 -28
- package/content/_partials/test-structure-audit-checklist.md +0 -7
- package/content/skills/_partials/acceptance-criteria-scaffold.md +0 -15
- package/content/skills/_partials/next-steps-after-review.md +0 -350
- package/content/skills/_partials/ticket-concision.md +0 -18
- package/content/skills/_partials/ticket-placement.md +0 -14
- package/content/skills/_partials/ticket-skeleton-tiers.md +0 -6
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
---
|
|
2
2
|
name: kb-update-events
|
|
3
|
-
description: Edit existing events in the knowledge store (mark one or more events addressed-by a reference, retag them, or set their impact) in a single batch invocation. The curatorial mutable set only; substantive content is edited via `capture-event --amend`.
|
|
3
|
+
description: Edit existing events in the knowledge store (mark one or more events addressed-by a reference, add tags to them, retag them, or set their impact) in a single batch invocation. The curatorial mutable set only; substantive content is edited via `capture-event --amend`.
|
|
4
4
|
user-invocable: true
|
|
5
5
|
---
|
|
6
6
|
|
|
@@ -8,9 +8,9 @@ user-invocable: true
|
|
|
8
8
|
|
|
9
9
|
Apply one mutation to one or more existing event records in a single invocation. A bundled helper does the mechanical work: It resolves the event store by name, resolves each id to its record, reads it through the type-blind note I/O layer, parses it to a typed `KbEvent`, applies the operation, and writes it back atomically. You supply the store, the operation, and the event ids.
|
|
10
10
|
|
|
11
|
-
The operation surface is the **curatorial mutable set** only: `addressed-by` (mark an event as addressed by a reference), `tags` (retag), and `impact` (set the impact rating). These are curatorial annotations; none of them writes a timestamp. Impact is a subjective assessment that may legitimately change, which is why it belongs to the mutable set rather than to the substantive fields. They are not substantive edits: To change an event's summary or body, use `capture-event --amend`. For new events, use `capture-event`. For editing assertions, use `kb-edit`.
|
|
11
|
+
The operation surface is the **curatorial mutable set** only: `addressed-by` (mark an event as addressed by a reference), `tags` (add tags, or retag), and `impact` (set the impact rating). These are curatorial annotations; none of them writes a timestamp. Impact is a subjective assessment that may legitimately change, which is why it belongs to the mutable set rather than to the substantive fields. They are not substantive edits: To change an event's summary or body, use `capture-event --amend`. For new events, use `capture-event`. For editing assertions, use `kb-edit`.
|
|
12
12
|
|
|
13
|
-
**Announce at start:** "Using kb-update-events to {mark|retag|rate} {N} event(s)."
|
|
13
|
+
**Announce at start:** "Using kb-update-events to {mark|tag|retag|rate} {N} event(s)."
|
|
14
14
|
|
|
15
15
|
## Arguments
|
|
16
16
|
|
|
@@ -18,16 +18,19 @@ The operation surface is the **curatorial mutable set** only: `addressed-by` (ma
|
|
|
18
18
|
| --------------------------- | -------------------------------------------------------------------------------------------------- | -------- |
|
|
19
19
|
| `--store` | Registry name, `@default` for the `default_kb`, or `@feedback` for the `feedback_kb`. | Yes |
|
|
20
20
|
| `--add-addressed-by <refs>` | Append comma-separated reference(s) to each event's `addressed-by` list. | One op |
|
|
21
|
+
| `--add-tag <list>` | Append the comma-separated tags to each event's `tags`, keeping the existing ones. Canonicalizes. | One op |
|
|
21
22
|
| `--retag <list>` | Replace each event's `tags` with the comma-separated list. Canonicalizes. | One op |
|
|
22
23
|
| `--set-impact <level>` | Set each event's `impact` to one of `low`, `medium`, `high`, `critical`. Replaces any prior value. | One op |
|
|
23
24
|
| `<event-id>` | One or more event ids; each resolves to `{store}/content/events/{id}.md`. | Yes |
|
|
24
25
|
|
|
25
|
-
A value-bearing flag accepts both `--retag fix,observation` and `--retag=fix,observation`. Exactly one operation flag is required per invocation; combining more than one is rejected with `invalid-args`. References are free-form (a KB wikilink or relative path, a commit SHA, a PR/issue ref, or a URL); they are stored verbatim and de-duplicated after any existing entries. A reference that begins with `--` is otherwise read as the next flag, so pass it with the inline `--add-addressed-by=<ref>` form.
|
|
26
|
+
A value-bearing flag accepts both `--retag fix,observation` and `--retag=fix,observation`. Exactly one operation flag is required per invocation; combining more than one is rejected with `invalid-args`. `--add-tag` canonicalizes only the tags that it adds and leaves an event whose tags already include all of them untouched, which makes it the operation for applying one tag across events whose tags differ; `--retag` replaces the whole set and canonicalizes all of it. `--help` prints the helper's usage. References are free-form (a KB wikilink or relative path, a commit SHA, a PR/issue ref, or a URL); they are stored verbatim and de-duplicated after any existing entries. A reference that begins with `--` is otherwise read as the next flag, so pass it with the inline `--add-addressed-by=<ref>` form.
|
|
26
27
|
|
|
27
28
|
### Store selection
|
|
28
29
|
|
|
29
30
|
`--store` is required: Every edit names its store. The helper resolves the store by registry name only and never walks the working directory for a `.kb/` folder. The store must be registered in `kb.yaml`. Pass `--store <name>` for a named store, `--store @default` for the registry's `default_kb`, or `--store @feedback` for its `feedback_kb`. The helper refuses an edit that omits `--store`, with an error that lists the registered stores.
|
|
30
31
|
|
|
32
|
+
<!-- include: ../../_partials/kb-standard-tags.md / -->
|
|
33
|
+
|
|
31
34
|
## Runtime dependencies
|
|
32
35
|
|
|
33
36
|
- **`node` ≥ 24**: The bundled helper inherits the Node version floor of `@williamthorsen/kb`.
|
|
@@ -47,7 +50,7 @@ node {harness_home_dir}/skills/kb-update-events/kb-update-events.mjs \
|
|
|
47
50
|
<event-id> [<event-id> ...]
|
|
48
51
|
```
|
|
49
52
|
|
|
50
|
-
Use `--retag <tag[,tag...]
|
|
53
|
+
Use `--add-tag <tag[,tag...]>`, `--retag <tag[,tag...]>`, or `--set-impact <level>` in place of `--add-addressed-by` for those operations.
|
|
51
54
|
|
|
52
55
|
The helper prints a JSON object to stdout:
|
|
53
56
|
|
|
@@ -74,4 +77,4 @@ On `ok: false`, act on the `error` code:
|
|
|
74
77
|
|
|
75
78
|
## Completion
|
|
76
79
|
|
|
77
|
-
Each named event updated in place and re-validated, written atomically. A mixed batch is partial by design: The helper writes the events that succeed and reports the ids that fail, leaving those untouched. These `addressed-by
|
|
80
|
+
Each named event updated in place and re-validated, written atomically, or left untouched when the operation changes nothing. A mixed batch is partial by design: The helper writes the events that succeed and reports the ids that fail, leaving those untouched. These `addressed-by`, `tags`, and `impact` annotations are curatorial; make substantive content edits with `capture-event --amend`.
|