@brucewaynedecoy/make-docs 2.0.2 → 2.0.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 +30 -75
- package/dist/{backup-73HQNKMC.js → backup-CM7RL2Q7.js} +5 -5
- package/dist/chunk-3EXHM5L2.js +1225 -0
- package/dist/chunk-3EXHM5L2.js.map +1 -0
- package/dist/{chunk-LVQSJF63.js → chunk-52FTNVXS.js} +242 -76
- package/dist/{chunk-LVQSJF63.js.map → chunk-52FTNVXS.js.map} +1 -1
- package/dist/{chunk-LQ5NSWCJ.js → chunk-65QWMODG.js} +2 -2
- package/dist/{chunk-HJYIQTMD.js → chunk-7R2PPKTB.js} +2 -2
- package/dist/{chunk-BENO4IH5.js → chunk-ADVNSMA7.js} +3 -3
- package/dist/{chunk-G5EF63GG.js → chunk-GERMRLJ2.js} +2 -2
- package/dist/{chunk-3BAJQXGH.js → chunk-J5QDGRZ7.js} +3 -3
- package/dist/{chunk-GNP6HRVP.js → chunk-LV3CBXZB.js} +20 -20
- package/dist/{chunk-GNP6HRVP.js.map → chunk-LV3CBXZB.js.map} +1 -1
- package/dist/{chunk-LRVV7UDD.js → chunk-M7DMFIKU.js} +2 -2
- package/dist/{chunk-64CTKJO7.js → chunk-OR5ZVGLG.js} +6 -5
- package/dist/chunk-OR5ZVGLG.js.map +1 -0
- package/dist/{chunk-MXBHCHSM.js → chunk-YVSASZMT.js} +3 -3
- package/dist/chunk-YVSASZMT.js.map +1 -0
- package/dist/index.js +118 -110
- package/dist/index.js.map +1 -1
- package/dist/{self-YYXOLDKU.js → self-36ULRIJ6.js} +17 -17
- package/dist/{self-YYXOLDKU.js.map → self-36ULRIJ6.js.map} +1 -1
- package/dist/{server-O2ZELIMX.js → server-H754TA4Q.js} +9 -9
- package/dist/{setup-system-HZROFNMP.js → setup-system-JI36YJ6D.js} +15 -15
- package/dist/{setup-system-HZROFNMP.js.map → setup-system-JI36YJ6D.js.map} +1 -1
- package/dist/{skills-command-MGGHY7HU.js → skills-command-IGDVLNKY.js} +28 -28
- package/dist/{skills-command-MGGHY7HU.js.map → skills-command-IGDVLNKY.js.map} +1 -1
- package/dist/{uninstall-3UXXXNFO.js → uninstall-VBGMQQLA.js} +8 -8
- package/dist/{virtual_make-docs-first-party-skills-ZII74YOB.js → virtual_make-docs-first-party-skills-H3FC47C2.js} +2 -2
- package/dist/{virtual_make-docs-first-party-skills-ZII74YOB.js.map → virtual_make-docs-first-party-skills-H3FC47C2.js.map} +1 -1
- package/package.json +4 -4
- package/template/.make-docs/system/contracts/output-contract.md +3 -1
- package/template/.make-docs/system/references/prd-change-management.md +14 -2
- package/dist/chunk-64CTKJO7.js.map +0 -1
- package/dist/chunk-MXBHCHSM.js.map +0 -1
- package/dist/chunk-Z5K4FHYP.js +0 -922
- package/dist/chunk-Z5K4FHYP.js.map +0 -1
- /package/dist/{backup-73HQNKMC.js.map → backup-CM7RL2Q7.js.map} +0 -0
- /package/dist/{chunk-LQ5NSWCJ.js.map → chunk-65QWMODG.js.map} +0 -0
- /package/dist/{chunk-HJYIQTMD.js.map → chunk-7R2PPKTB.js.map} +0 -0
- /package/dist/{chunk-BENO4IH5.js.map → chunk-ADVNSMA7.js.map} +0 -0
- /package/dist/{chunk-G5EF63GG.js.map → chunk-GERMRLJ2.js.map} +0 -0
- /package/dist/{chunk-3BAJQXGH.js.map → chunk-J5QDGRZ7.js.map} +0 -0
- /package/dist/{chunk-LRVV7UDD.js.map → chunk-M7DMFIKU.js.map} +0 -0
- /package/dist/{server-O2ZELIMX.js.map → server-H754TA4Q.js.map} +0 -0
- /package/dist/{uninstall-3UXXXNFO.js.map → uninstall-VBGMQQLA.js.map} +0 -0
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@brucewaynedecoy/make-docs",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.4",
|
|
4
4
|
"description": "Plan and maintain project docs with a CLI, MCP server, templates, and optional agent Skills.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"repository": {
|
|
@@ -23,7 +23,7 @@
|
|
|
23
23
|
"README.md"
|
|
24
24
|
],
|
|
25
25
|
"engines": {
|
|
26
|
-
"node": ">=
|
|
26
|
+
"node": ">=24.0.0"
|
|
27
27
|
},
|
|
28
28
|
"publishConfig": {
|
|
29
29
|
"access": "public"
|
|
@@ -43,8 +43,8 @@
|
|
|
43
43
|
"vitest": "^3.2.4"
|
|
44
44
|
},
|
|
45
45
|
"dependencies": {
|
|
46
|
-
"@clack/core": "
|
|
47
|
-
"@clack/prompts": "
|
|
46
|
+
"@clack/core": "1.5.1",
|
|
47
|
+
"@clack/prompts": "1.8.1",
|
|
48
48
|
"@modelcontextprotocol/sdk": "^1.29.0",
|
|
49
49
|
"yaml": "^2.9.0",
|
|
50
50
|
"zod": "^4.4.3"
|
|
@@ -274,4 +274,6 @@ Use `## Source Anchors` to aggregate the most important files that shaped the do
|
|
|
274
274
|
|
|
275
275
|
## PRD Authority Validation
|
|
276
276
|
|
|
277
|
-
Run `make-docs run prd authority validate --target-root <project>` before treating an active PRD set as downstream authority. The read-only validator enforces `PRD-AUTH-001` through `PRD-AUTH-
|
|
277
|
+
Run `make-docs run prd authority validate --target-root <project>` before treating an active PRD set as downstream authority. The read-only validator enforces `PRD-AUTH-001` through `PRD-AUTH-010` as defined in `.make-docs/system/references/prd-change-management.md`: filename/H1 editorial stems use the narrow twelve-term set that allows legitimate Update Delivery, Replacement Policy, and Migration Safety subjects; controlled kinds additionally prohibit update/replace/replacement/migrate/migration; and the remaining diagnostics cover retired headings, authority targets, top-level coordinates, invalid target roots, unsafe documentation roots, invalid custom Markdown declarations, and unusable selected frontmatter. It exempts standardized provenance sections and frontmatter containers. No standalone JSON, JSONL, YAML, or YML file is a current PRD authority source, so the validator does not select one by extension or apparent field name. A future standalone source needs a product requirement that defines its bounded path or path family, schema, current-authority field, and provenance rule before a selector is added. Human TTY output summarizes diagnostics and remediation; `--json` and non-TTY output return the complete report. An explicit `failed` report exits nonzero after rendering.
|
|
278
|
+
|
|
279
|
+
The validator selects working Markdown by path before it reads a file. Default sources are direct numbered files in `docs/prd/`, dated designs directly in `docs/designs/`, direct overview and phase files in dated W/R plan packages, and direct index and phase files in dated W/R work packages. It does not enter stored copies nested under those packages, whatever the storage directory is named. A project may add an exact custom `.md` file under `docs/` through `prd_authority.markdown_sources` in `.make-docs/config.yaml`. The validator checks a bounded YAML header after path selection. A copied header cannot add a source. An older selected document without frontmatter stays in scope. Store access is not required. The report's `markdownFilesScanned` counts bodies checked, and `markdownSourceCoverage` shows checked source classes and custom paths.
|
|
@@ -141,7 +141,19 @@ Before closing PRD authority maintenance, confirm:
|
|
|
141
141
|
|
|
142
142
|
## Deterministic Authority Validation
|
|
143
143
|
|
|
144
|
-
Run `make-docs run prd authority validate --target-root <project>` against the project root after PRD maintenance and before downstream work treats the set as authority. The read-only operation scans
|
|
144
|
+
Run `make-docs run prd authority validate --target-root <project>` against the project root after PRD maintenance and before downstream work treats the set as authority. The read-only operation scans selected working PRD and other Markdown documents for current PRD authority claims.
|
|
145
|
+
|
|
146
|
+
Default sources are direct numbered Markdown files in `docs/prd/`, dated designs directly in `docs/designs/`, direct overview and phase files in dated W/R plan packages, and direct index and phase files in dated W/R work packages. The validator does not enter other descendants of a plan or work package. A stored copy with a copied header remains outside the source set, whatever its directory name. A completed work record at its working path remains in scope.
|
|
147
|
+
|
|
148
|
+
For a custom working document, add its exact repository-relative `.md` path under `docs/` to `.make-docs/config.yaml`:
|
|
149
|
+
|
|
150
|
+
```yaml
|
|
151
|
+
prd_authority:
|
|
152
|
+
markdown_sources:
|
|
153
|
+
- docs/history/current.md
|
|
154
|
+
```
|
|
155
|
+
|
|
156
|
+
The list accepts files, not directories or globs. Invalid, missing, escaping, archive, or symlinked paths report `PRD-AUTH-009`. After selection, the validator reads a bounded YAML header to check `kind` and `status` where they have a defined meaning. An older selected document without frontmatter remains in scope. Present malformed, over-limit, or role-inconsistent frontmatter reports `PRD-AUTH-010`; it cannot silently remove a source. The report's `markdownFilesScanned` counts bodies checked. `markdownSourceCoverage` shows checked source classes and custom paths. Source selection and results do not depend on a local Store or CLI installation in the target project.
|
|
145
157
|
|
|
146
158
|
The validator uses two finite, case-insensitive sets. Filenames and H1 subjects prohibit only `revise`, `revision`, `add`, `addition`, `enhance`, `enhancement`, `remove`, `removal`, `deprecate`, `deprecation`, `reconcile`, and `reconciliation`. Product subjects such as Update Delivery, Replacement Policy, and Migration Safety therefore remain valid. Frontmatter and PRD-index editorial kinds prohibit those twelve terms plus `update`, `replace`, `replacement`, `migrate`, and `migration`.
|
|
147
159
|
|
|
@@ -158,7 +170,7 @@ The validator uses two finite, case-insensitive sets. Filenames and H1 subjects
|
|
|
158
170
|
|
|
159
171
|
Markdown links are authority-bearing only within `Source PRD Docs`, `Source PRDs`, `Source PRD Documents`, `PRD Authority`, `Product Authority`, `Current PRD Authority`, `Authoritative PRDs`, `Authoritative PRD Docs`, `Source Authority`, `Authority Sources`, or `Active Authority Baseline`, plus the PRD index's `Document Map`. The provenance sections `Requirement History`, `Provenance`, `Lineage`, `Source Anchors`, `Design Provenance`, `Migration Provenance`, `Migration History`, `Historical Provenance`, and `Archive Provenance` are exempt from authority-link enforcement.
|
|
160
172
|
|
|
161
|
-
|
|
173
|
+
The validator does not select standalone JSON, JSONL, YAML, or YML files by extension or apparent field name. Make Docs currently defines no standalone structured file as a current PRD authority source. The report keeps `structuredFilesScanned` at zero while that set is empty. In live Markdown frontmatter, after camel/snake/hyphen normalization, authority fields remain `source(s)`, `sourcePath(s)`, `sourcePrd(s)`, `sourcePrdPath(s)`, `sourcePrdDoc(s)`, `authority/authorities`, `authorityPath(s)`, `authorityPrd(s)`, `prd(s)`, `prdPath(s)`, and `prdDoc(s)`, including nested `path(s)` under source, authority, or PRD containers. Standardized provenance containers matching the provenance section vocabulary are exempt. A future standalone structured source needs a product requirement that names its bounded path or path family, schema, current-authority field, and provenance rule before a selector is added.
|
|
162
174
|
|
|
163
175
|
These provenance exemptions do not permit an active PRD filename, H1, kind, retired heading, or document-level coordinate to violate current-authority rules. The validator resolves the target root and documentation scan roots before reading; an absent or invalid root fails with `PRD-AUTH-007`, while an escaping or otherwise unsafe `docs/` or `docs/prd/` root fails closed with `PRD-AUTH-008`.
|
|
164
176
|
|