@hechura/noreaster-cli 0.2.2 → 0.2.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.
|
@@ -16,6 +16,7 @@ exports.TEMPLATE_DOC_TYPES = [
|
|
|
16
16
|
"feature_summary",
|
|
17
17
|
"sprint_plan",
|
|
18
18
|
"executive_summary",
|
|
19
|
+
"rules",
|
|
19
20
|
];
|
|
20
21
|
const AI_WRITING_HINT = `<!-- Writing for AI tools:
|
|
21
22
|
- Be explicit with exact values ("max file size: 10MB", not "reasonable").
|
|
@@ -436,6 +437,39 @@ ${AI_WRITING_HINT}
|
|
|
436
437
|
|
|
437
438
|
## Next Steps
|
|
438
439
|
|
|
440
|
+
-
|
|
441
|
+
`;
|
|
442
|
+
const RULES_TEMPLATE = `# Project Rules
|
|
443
|
+
|
|
444
|
+
${AI_WRITING_HINT}
|
|
445
|
+
|
|
446
|
+
## Purpose
|
|
447
|
+
|
|
448
|
+
<!-- Binding constraints for agents implementing work in this project.
|
|
449
|
+
Prefer exact, enforceable rules over vibes. -->
|
|
450
|
+
|
|
451
|
+
## Must
|
|
452
|
+
|
|
453
|
+
- Agents must [specific required behavior].
|
|
454
|
+
|
|
455
|
+
## Must Not
|
|
456
|
+
|
|
457
|
+
- Agents must not [specific forbidden behavior].
|
|
458
|
+
|
|
459
|
+
## Coding Standards
|
|
460
|
+
|
|
461
|
+
- Language / framework conventions:
|
|
462
|
+
- File and module layout:
|
|
463
|
+
- Testing expectations:
|
|
464
|
+
|
|
465
|
+
## Constraints
|
|
466
|
+
|
|
467
|
+
| Constraint | Rationale |
|
|
468
|
+
|------------|-----------|
|
|
469
|
+
| | |
|
|
470
|
+
|
|
471
|
+
## Open Questions
|
|
472
|
+
|
|
439
473
|
-
|
|
440
474
|
`;
|
|
441
475
|
const TEMPLATES = {
|
|
@@ -450,6 +484,7 @@ const TEMPLATES = {
|
|
|
450
484
|
feature_summary: FEATURE_SUMMARY_TEMPLATE,
|
|
451
485
|
sprint_plan: SPRINT_PLAN_TEMPLATE,
|
|
452
486
|
executive_summary: EXECUTIVE_SUMMARY_TEMPLATE,
|
|
487
|
+
rules: RULES_TEMPLATE,
|
|
453
488
|
};
|
|
454
489
|
function isTemplateDocType(value) {
|
|
455
490
|
return value != null && exports.TEMPLATE_DOC_TYPES.includes(value);
|
package/package.json
CHANGED
|
@@ -10,7 +10,7 @@ Use this skill for operational work in Noreaster through the official agent CLI
|
|
|
10
10
|
## Execution Defaults
|
|
11
11
|
|
|
12
12
|
1. Prefer the published CLI:
|
|
13
|
-
- `npx @hechura/noreaster-cli@0.2.
|
|
13
|
+
- `npx @hechura/noreaster-cli@0.2.4 <command>` or `noreaster <command>` after global install (`npm install -g @hechura/noreaster-cli@0.2.4`)
|
|
14
14
|
- In this repo: `npm run agent -- <command>`
|
|
15
15
|
2. Default API base URL:
|
|
16
16
|
- `https://noreaster.vercel.app`
|
|
@@ -36,6 +36,7 @@ Project documents are the versioned source of truth for how a project is built.
|
|
|
36
36
|
|
|
37
37
|
| UI label | `doc_type` | Purpose — how agents use it |
|
|
38
38
|
| --- | --- | --- |
|
|
39
|
+
| Rules | `rules` | Binding agent execution constraints for the project (must / must-not, coding standards). **Always load and apply before implementing work items.** |
|
|
39
40
|
| PRD | `prd` | Product requirements: problem, goals, personas, feature list. Governs *what* to build and why. |
|
|
40
41
|
| Architecture | `architecture` | System overview: services, data flows, infrastructure. Governs *where* code lives and how systems connect. |
|
|
41
42
|
| Technical Design | `technical_design` | Project-level technical design: affected areas, API contracts, data model, edge cases. Governs implementation shape. |
|
|
@@ -65,7 +66,7 @@ Common gates:
|
|
|
65
66
|
|
|
66
67
|
- Feature PRD (`feature_description`) must be approved before Feature Spec (`design_spec`) can be approved
|
|
67
68
|
- Feature Spec must be approved before draft-run apply creates work items
|
|
68
|
-
- Document → `approved`
|
|
69
|
+
- Document → `approved` is a direct status transition (`docs transition <id> approved`); no approved review is required. Reviews remain available as an optional collaboration surface.
|
|
69
70
|
- Agent document reads return `approved` docs by default; use `--include-drafts` only when intentionally working on drafts
|
|
70
71
|
|
|
71
72
|
When refused, read the `gate` / `error` fields, fix the missing prerequisite, then retry.
|
|
@@ -77,6 +78,7 @@ Before implementing a work item, load the governing docs — do not invent contr
|
|
|
77
78
|
1. Fetch the work item: `tasks get <id>`
|
|
78
79
|
2. Follow `source_document_id` (or the feature's Feature Spec / `design_spec`) and read it: `docs get <id>`
|
|
79
80
|
3. Load project foundation docs:
|
|
81
|
+
- `docs list --project-id <id> --type rules` — **apply these Rules when implementing**; treat Must / Must Not as binding
|
|
80
82
|
- `docs list --project-id <id> --type architecture`
|
|
81
83
|
- `docs list --project-id <id> --type design_system`
|
|
82
84
|
- `docs list --project-id <id> --type technical_design`
|
|
@@ -85,6 +87,7 @@ Before implementing a work item, load the governing docs — do not invent contr
|
|
|
85
87
|
|
|
86
88
|
Compliance rules while coding:
|
|
87
89
|
|
|
90
|
+
- Honor project Rules (`doc_type: rules`) — do not violate Must / Must Not or coding standards
|
|
88
91
|
- Honor the Feature Spec's API contract and data model verbatim
|
|
89
92
|
- Every edge-case table row becomes a required test
|
|
90
93
|
- UI work must conform to the approved design-system doc (tokens, components, a11y)
|
|
@@ -111,7 +114,7 @@ noreaster docs update <id> --data '{"content":"...","change_summary":"Recorded d
|
|
|
111
114
|
- Architectural decisions (technology choices, service boundaries, data model direction) go in a new ADR (`doc_type: "adr"`), not buried in an edit. Then update the affected `architecture` / `technical_design` doc to reflect it, with a `change_summary` referencing the ADR.
|
|
112
115
|
- Implementation decisions that deviate from or refine an approved doc: update the governing doc's **Decision Log** / **Deviations from Spec** section with date, decision, rationale, and who decided — plus a `change_summary`.
|
|
113
116
|
- Never rewrite history: use `docs revisions <id>` to inspect prior versions; corrections are new revisions, not silent replacements.
|
|
114
|
-
-
|
|
117
|
+
- Content edits to an `approved` doc still record revisions. Approval itself is a human decision made by changing the document status; if your change invalidates an approval, say so explicitly rather than working around it.
|
|
115
118
|
|
|
116
119
|
## Work Discovery
|
|
117
120
|
|
|
@@ -225,7 +228,7 @@ Empty `content` on create is seeded from the template for that `doc_type`.
|
|
|
225
228
|
## Quick Command Examples
|
|
226
229
|
|
|
227
230
|
```bash
|
|
228
|
-
npm install -g @hechura/noreaster-cli@0.2.
|
|
231
|
+
npm install -g @hechura/noreaster-cli@0.2.4
|
|
229
232
|
noreaster skill install
|
|
230
233
|
noreaster my-work
|
|
231
234
|
noreaster features list --project-id <project-id>
|