@brucewaynedecoy/make-docs 1.0.0-rc.1
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/LICENSE +201 -0
- package/README.md +93 -0
- package/dist/chunk-HP3HBG7F.js +626 -0
- package/dist/chunk-HP3HBG7F.js.map +1 -0
- package/dist/chunk-QRFH4J6H.js +1194 -0
- package/dist/chunk-QRFH4J6H.js.map +1 -0
- package/dist/chunk-WM3OXYTW.js +2630 -0
- package/dist/chunk-WM3OXYTW.js.map +1 -0
- package/dist/index.js +1720 -0
- package/dist/index.js.map +1 -0
- package/dist/skills-command-3ESCZ75U.js +547 -0
- package/dist/skills-command-3ESCZ75U.js.map +1 -0
- package/dist/uninstall-GQE4SJF2.js +150 -0
- package/dist/uninstall-GQE4SJF2.js.map +1 -0
- package/package.json +49 -0
- package/skill-registry.json +276 -0
- package/skill-registry.schema.json +64 -0
- package/template/.make-docs/scripts/check_path_hygiene.py +435 -0
- package/template/AGENTS.md +3 -0
- package/template/CLAUDE.md +3 -0
- package/template/docs/AGENTS.md +15 -0
- package/template/docs/CLAUDE.md +15 -0
- package/template/docs/assets/AGENTS.md +9 -0
- package/template/docs/assets/CLAUDE.md +9 -0
- package/template/docs/assets/archive/AGENTS.md +20 -0
- package/template/docs/assets/archive/CLAUDE.md +20 -0
- package/template/docs/assets/history/AGENTS.md +12 -0
- package/template/docs/assets/history/CLAUDE.md +12 -0
- package/template/docs/assets/prompts/AGENTS.md +8 -0
- package/template/docs/assets/prompts/CLAUDE.md +8 -0
- package/template/docs/assets/prompts/designs-to-plan-change.prompt.md +14 -0
- package/template/docs/assets/prompts/designs-to-plan.prompt.md +10 -0
- package/template/docs/assets/prompts/docs-path-hygiene-cleanup.prompt.md +27 -0
- package/template/docs/assets/prompts/plan-to-prd-change.prompt.md +8 -0
- package/template/docs/assets/prompts/plan-to-prd-green-field.prompt.md +6 -0
- package/template/docs/assets/prompts/prd-change-to-work.prompt.md +10 -0
- package/template/docs/assets/prompts/prd-to-work-full-prd.prompt.md +6 -0
- package/template/docs/assets/prompts/prd-to-work-prd-feature.prompt.md +6 -0
- package/template/docs/assets/prompts/request-to-design.prompt.md +16 -0
- package/template/docs/assets/prompts/session-to-history-record.prompt.md +19 -0
- package/template/docs/assets/prompts/update-readme-green-field.prompt.md +6 -0
- package/template/docs/assets/prompts/work-to-commit-message.prompt.md +27 -0
- package/template/docs/assets/prompts/work-to-guides.prompt.md +18 -0
- package/template/docs/assets/references/AGENTS.md +9 -0
- package/template/docs/assets/references/CLAUDE.md +9 -0
- package/template/docs/assets/references/commit-message-convention.md +198 -0
- package/template/docs/assets/references/design-contract.md +62 -0
- package/template/docs/assets/references/design-workflow.md +60 -0
- package/template/docs/assets/references/execution-workflow.md +157 -0
- package/template/docs/assets/references/guide-contract.md +159 -0
- package/template/docs/assets/references/harness-capability-matrix.md +52 -0
- package/template/docs/assets/references/history-record-contract.md +137 -0
- package/template/docs/assets/references/output-contract.md +221 -0
- package/template/docs/assets/references/path-and-link-hygiene.md +49 -0
- package/template/docs/assets/references/planning-workflow.md +160 -0
- package/template/docs/assets/references/prd-change-management.md +129 -0
- package/template/docs/assets/references/wave-model.md +76 -0
- package/template/docs/assets/templates/AGENTS.md +8 -0
- package/template/docs/assets/templates/CLAUDE.md +8 -0
- package/template/docs/assets/templates/design.md +30 -0
- package/template/docs/assets/templates/guide-developer.md +54 -0
- package/template/docs/assets/templates/guide-user.md +58 -0
- package/template/docs/assets/templates/history-record.md +62 -0
- package/template/docs/assets/templates/plan-overview.md +32 -0
- package/template/docs/assets/templates/plan-prd-change.md +99 -0
- package/template/docs/assets/templates/plan-prd-decompose.md +70 -0
- package/template/docs/assets/templates/plan-prd.md +124 -0
- package/template/docs/assets/templates/prd-architecture.md +51 -0
- package/template/docs/assets/templates/prd-change-addition.md +45 -0
- package/template/docs/assets/templates/prd-change-revision.md +45 -0
- package/template/docs/assets/templates/prd-glossary.md +15 -0
- package/template/docs/assets/templates/prd-index.md +45 -0
- package/template/docs/assets/templates/prd-overview.md +43 -0
- package/template/docs/assets/templates/prd-reference.md +17 -0
- package/template/docs/assets/templates/prd-risk-register.md +55 -0
- package/template/docs/assets/templates/prd-subsystem.md +49 -0
- package/template/docs/assets/templates/work-index.md +21 -0
- package/template/docs/assets/templates/work-phase.md +34 -0
- package/template/docs/designs/AGENTS.md +21 -0
- package/template/docs/designs/CLAUDE.md +21 -0
- package/template/docs/guides/AGENTS.md +15 -0
- package/template/docs/guides/CLAUDE.md +15 -0
- package/template/docs/plans/AGENTS.md +20 -0
- package/template/docs/plans/CLAUDE.md +20 -0
- package/template/docs/prd/AGENTS.md +9 -0
- package/template/docs/prd/CLAUDE.md +9 -0
- package/template/docs/work/AGENTS.md +18 -0
- package/template/docs/work/CLAUDE.md +18 -0
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import {
|
|
3
|
+
createAuditReport,
|
|
4
|
+
executePreparedBackup,
|
|
5
|
+
getLifecycleRenderer,
|
|
6
|
+
prepareBackupExecution,
|
|
7
|
+
resolveBackupDestinationPlan
|
|
8
|
+
} from "./chunk-QRFH4J6H.js";
|
|
9
|
+
import {
|
|
10
|
+
loadManifest,
|
|
11
|
+
pruneDirectoryIfEmpty,
|
|
12
|
+
removeFileIfPresent
|
|
13
|
+
} from "./chunk-WM3OXYTW.js";
|
|
14
|
+
|
|
15
|
+
// src/uninstall.ts
|
|
16
|
+
import os from "os";
|
|
17
|
+
import path from "path";
|
|
18
|
+
async function runUninstallCommand(options) {
|
|
19
|
+
const renderer = getLifecycleRenderer();
|
|
20
|
+
const targetDir = path.resolve(options.targetDir);
|
|
21
|
+
const homeDir = path.resolve(options.homeDir ?? os.homedir());
|
|
22
|
+
const backupDestinationPlan = options.backup ? resolveBackupDestinationPlan(targetDir, options.now ?? /* @__PURE__ */ new Date()) : null;
|
|
23
|
+
const backupDestinationDir = backupDestinationPlan?.destinationDir ?? null;
|
|
24
|
+
renderer.beginWorkflow("make-docs uninstall");
|
|
25
|
+
renderer.renderUninstallWarning({
|
|
26
|
+
targetDir,
|
|
27
|
+
backupDestinationDir
|
|
28
|
+
});
|
|
29
|
+
const warningApproved = await renderer.confirmUninstallWarning(
|
|
30
|
+
options.permissions
|
|
31
|
+
);
|
|
32
|
+
if (!warningApproved) {
|
|
33
|
+
renderer.renderUninstallCancelled();
|
|
34
|
+
return {
|
|
35
|
+
status: "cancelled",
|
|
36
|
+
checkpoint: "warning",
|
|
37
|
+
plan: null
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
const auditReport = options.auditReport ?? await loadAuditReport({
|
|
41
|
+
targetDir,
|
|
42
|
+
homeDir
|
|
43
|
+
});
|
|
44
|
+
const plan = {
|
|
45
|
+
targetDir,
|
|
46
|
+
backupRequested: options.backup,
|
|
47
|
+
backupDestinationPlan,
|
|
48
|
+
backupDestinationDir,
|
|
49
|
+
auditReport
|
|
50
|
+
};
|
|
51
|
+
renderer.renderUninstallAuditSummary({
|
|
52
|
+
auditReport,
|
|
53
|
+
backupDestinationDir
|
|
54
|
+
});
|
|
55
|
+
const finalApproved = await renderer.confirmUninstallRun({
|
|
56
|
+
permissions: options.permissions,
|
|
57
|
+
backupRequested: options.backup
|
|
58
|
+
});
|
|
59
|
+
if (!finalApproved) {
|
|
60
|
+
renderer.renderUninstallCancelled();
|
|
61
|
+
return {
|
|
62
|
+
status: "cancelled",
|
|
63
|
+
checkpoint: "final",
|
|
64
|
+
plan
|
|
65
|
+
};
|
|
66
|
+
}
|
|
67
|
+
let backupResult = null;
|
|
68
|
+
if (plan.backupRequested) {
|
|
69
|
+
try {
|
|
70
|
+
const preparedBackup = await prepareBackupExecution({
|
|
71
|
+
targetDir,
|
|
72
|
+
homeDir,
|
|
73
|
+
now: options.now,
|
|
74
|
+
auditReport: plan.auditReport,
|
|
75
|
+
destinationPlan: plan.backupDestinationPlan
|
|
76
|
+
});
|
|
77
|
+
backupResult = executePreparedBackup(preparedBackup);
|
|
78
|
+
} catch (error) {
|
|
79
|
+
throw createUninstallError(
|
|
80
|
+
`Backup failed before uninstall removal began: ${toErrorMessage(error)}`
|
|
81
|
+
);
|
|
82
|
+
}
|
|
83
|
+
}
|
|
84
|
+
const removedFiles = [];
|
|
85
|
+
const prunedDirectories = [];
|
|
86
|
+
try {
|
|
87
|
+
for (const removableFile of plan.auditReport.removableFiles) {
|
|
88
|
+
assertNotInsideBackupRoot(plan.targetDir, removableFile.absolutePath);
|
|
89
|
+
if (removeFileIfPresent(removableFile.absolutePath)) {
|
|
90
|
+
removedFiles.push(removableFile.path);
|
|
91
|
+
}
|
|
92
|
+
}
|
|
93
|
+
for (const prunableDirectory of plan.auditReport.prunableDirectories) {
|
|
94
|
+
assertNotInsideBackupRoot(plan.targetDir, prunableDirectory.absolutePath);
|
|
95
|
+
if (pruneDirectoryIfEmpty(prunableDirectory.absolutePath)) {
|
|
96
|
+
prunedDirectories.push(prunableDirectory.path);
|
|
97
|
+
}
|
|
98
|
+
}
|
|
99
|
+
} catch (error) {
|
|
100
|
+
renderer.renderUninstallFailureSummary({
|
|
101
|
+
auditReport: plan.auditReport,
|
|
102
|
+
removedFiles,
|
|
103
|
+
prunedDirectories,
|
|
104
|
+
backupResult,
|
|
105
|
+
errorMessage: toErrorMessage(error)
|
|
106
|
+
});
|
|
107
|
+
throw createUninstallError(
|
|
108
|
+
`Uninstall partially completed after removing ${removedFiles.length} file(s) and pruning ${prunedDirectories.length} director${prunedDirectories.length === 1 ? "y" : "ies"}: ${toErrorMessage(error)}`
|
|
109
|
+
);
|
|
110
|
+
}
|
|
111
|
+
renderer.renderUninstallCompletionSummary({
|
|
112
|
+
auditReport: plan.auditReport,
|
|
113
|
+
removedFiles,
|
|
114
|
+
prunedDirectories,
|
|
115
|
+
backupResult
|
|
116
|
+
});
|
|
117
|
+
return {
|
|
118
|
+
status: "completed",
|
|
119
|
+
plan,
|
|
120
|
+
backupResult,
|
|
121
|
+
removedFiles,
|
|
122
|
+
prunedDirectories
|
|
123
|
+
};
|
|
124
|
+
}
|
|
125
|
+
async function loadAuditReport(options) {
|
|
126
|
+
const manifest = loadManifest(options.targetDir);
|
|
127
|
+
return createAuditReport({
|
|
128
|
+
targetDir: options.targetDir,
|
|
129
|
+
manifest,
|
|
130
|
+
homeDir: options.homeDir
|
|
131
|
+
});
|
|
132
|
+
}
|
|
133
|
+
function assertNotInsideBackupRoot(targetDir, candidatePath) {
|
|
134
|
+
const backupRoot = path.resolve(targetDir, ".backup");
|
|
135
|
+
const normalizedCandidate = path.resolve(candidatePath);
|
|
136
|
+
const relativePath = path.relative(backupRoot, normalizedCandidate);
|
|
137
|
+
if (relativePath === "" || !relativePath.startsWith("..") && !path.isAbsolute(relativePath)) {
|
|
138
|
+
throw new Error(`Refusing to remove a path inside the project backup root: ${candidatePath}`);
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
function createUninstallError(message) {
|
|
142
|
+
return new Error(message);
|
|
143
|
+
}
|
|
144
|
+
function toErrorMessage(error) {
|
|
145
|
+
return error instanceof Error ? error.message : String(error);
|
|
146
|
+
}
|
|
147
|
+
export {
|
|
148
|
+
runUninstallCommand
|
|
149
|
+
};
|
|
150
|
+
//# sourceMappingURL=uninstall-GQE4SJF2.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/uninstall.ts"],"sourcesContent":["import os from \"node:os\";\nimport path from \"node:path\";\nimport {\n executePreparedBackup,\n prepareBackupExecution,\n resolveBackupDestinationPlan,\n} from \"./backup\";\nimport { createAuditReport } from \"./audit\";\nimport {\n getLifecycleRenderer,\n} from \"./lifecycle-ui\";\nimport { loadManifest } from \"./manifest\";\nimport type {\n AuditReport,\n BackupDestinationPlan,\n BackupExecutionResult,\n LifecyclePermissionsMode,\n} from \"./types\";\nimport * as fileUtils from \"./utils\";\n\nexport interface UninstallCommandOptions {\n targetDir: string;\n backup: boolean;\n permissions: LifecyclePermissionsMode;\n auditReport?: AuditReport;\n homeDir?: string;\n now?: Date;\n}\n\nexport interface UninstallReviewPlan {\n targetDir: string;\n backupRequested: boolean;\n backupDestinationPlan: BackupDestinationPlan | null;\n backupDestinationDir: string | null;\n auditReport: AuditReport;\n}\n\nexport type UninstallExecutionResult =\n | {\n status: \"cancelled\";\n checkpoint: \"warning\" | \"final\";\n plan: UninstallReviewPlan | null;\n }\n | {\n status: \"completed\";\n plan: UninstallReviewPlan;\n backupResult: BackupExecutionResult | null;\n removedFiles: string[];\n prunedDirectories: string[];\n };\n\nexport async function runUninstallCommand(\n options: UninstallCommandOptions,\n): Promise<UninstallExecutionResult> {\n const renderer = getLifecycleRenderer();\n const targetDir = path.resolve(options.targetDir);\n const homeDir = path.resolve(options.homeDir ?? os.homedir());\n const backupDestinationPlan = options.backup\n ? resolveBackupDestinationPlan(targetDir, options.now ?? new Date())\n : null;\n const backupDestinationDir = backupDestinationPlan?.destinationDir ?? null;\n\n renderer.beginWorkflow(\"make-docs uninstall\");\n renderer.renderUninstallWarning({\n targetDir,\n backupDestinationDir,\n });\n\n const warningApproved = await renderer.confirmUninstallWarning(\n options.permissions,\n );\n if (!warningApproved) {\n renderer.renderUninstallCancelled();\n return {\n status: \"cancelled\",\n checkpoint: \"warning\",\n plan: null,\n };\n }\n\n const auditReport =\n options.auditReport ??\n (await loadAuditReport({\n targetDir,\n homeDir,\n }));\n\n const plan: UninstallReviewPlan = {\n targetDir,\n backupRequested: options.backup,\n backupDestinationPlan,\n backupDestinationDir,\n auditReport,\n };\n\n renderer.renderUninstallAuditSummary({\n auditReport,\n backupDestinationDir,\n });\n\n const finalApproved = await renderer.confirmUninstallRun({\n permissions: options.permissions,\n backupRequested: options.backup,\n });\n if (!finalApproved) {\n renderer.renderUninstallCancelled();\n return {\n status: \"cancelled\",\n checkpoint: \"final\",\n plan,\n };\n }\n\n let backupResult: BackupExecutionResult | null = null;\n\n if (plan.backupRequested) {\n try {\n const preparedBackup = await prepareBackupExecution({\n targetDir,\n homeDir,\n now: options.now,\n auditReport: plan.auditReport,\n destinationPlan: plan.backupDestinationPlan,\n });\n backupResult = executePreparedBackup(preparedBackup);\n } catch (error) {\n throw createUninstallError(\n `Backup failed before uninstall removal began: ${toErrorMessage(error)}`,\n );\n }\n }\n\n const removedFiles: string[] = [];\n const prunedDirectories: string[] = [];\n\n try {\n for (const removableFile of plan.auditReport.removableFiles) {\n assertNotInsideBackupRoot(plan.targetDir, removableFile.absolutePath);\n if (fileUtils.removeFileIfPresent(removableFile.absolutePath)) {\n removedFiles.push(removableFile.path);\n }\n }\n\n for (const prunableDirectory of plan.auditReport.prunableDirectories) {\n assertNotInsideBackupRoot(plan.targetDir, prunableDirectory.absolutePath);\n if (fileUtils.pruneDirectoryIfEmpty(prunableDirectory.absolutePath)) {\n prunedDirectories.push(prunableDirectory.path);\n }\n }\n } catch (error) {\n renderer.renderUninstallFailureSummary({\n auditReport: plan.auditReport,\n removedFiles,\n prunedDirectories,\n backupResult,\n errorMessage: toErrorMessage(error),\n });\n throw createUninstallError(\n `Uninstall partially completed after removing ${removedFiles.length} file(s) and pruning ${prunedDirectories.length} director${prunedDirectories.length === 1 ? \"y\" : \"ies\"}: ${toErrorMessage(error)}`,\n );\n }\n\n renderer.renderUninstallCompletionSummary({\n auditReport: plan.auditReport,\n removedFiles,\n prunedDirectories,\n backupResult,\n });\n\n return {\n status: \"completed\",\n plan,\n backupResult,\n removedFiles,\n prunedDirectories,\n };\n}\n\nasync function loadAuditReport(options: {\n targetDir: string;\n homeDir: string;\n}): Promise<AuditReport> {\n const manifest = loadManifest(options.targetDir);\n return createAuditReport({\n targetDir: options.targetDir,\n manifest,\n homeDir: options.homeDir,\n });\n}\n\nfunction assertNotInsideBackupRoot(targetDir: string, candidatePath: string): void {\n const backupRoot = path.resolve(targetDir, \".backup\");\n const normalizedCandidate = path.resolve(candidatePath);\n const relativePath = path.relative(backupRoot, normalizedCandidate);\n\n if (relativePath === \"\" || (!relativePath.startsWith(\"..\") && !path.isAbsolute(relativePath))) {\n throw new Error(`Refusing to remove a path inside the project backup root: ${candidatePath}`);\n }\n}\n\nfunction createUninstallError(message: string): Error {\n return new Error(message);\n}\n\nfunction toErrorMessage(error: unknown): string {\n return error instanceof Error ? error.message : String(error);\n}\n"],"mappings":";;;;;;;;;;;;;;;AAAA,OAAO,QAAQ;AACf,OAAO,UAAU;AAkDjB,eAAsB,oBACpB,SACmC;AACnC,QAAM,WAAW,qBAAqB;AACtC,QAAM,YAAY,KAAK,QAAQ,QAAQ,SAAS;AAChD,QAAM,UAAU,KAAK,QAAQ,QAAQ,WAAW,GAAG,QAAQ,CAAC;AAC5D,QAAM,wBAAwB,QAAQ,SAClC,6BAA6B,WAAW,QAAQ,OAAO,oBAAI,KAAK,CAAC,IACjE;AACJ,QAAM,uBAAuB,uBAAuB,kBAAkB;AAEtE,WAAS,cAAc,qBAAqB;AAC5C,WAAS,uBAAuB;AAAA,IAC9B;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,kBAAkB,MAAM,SAAS;AAAA,IACrC,QAAQ;AAAA,EACV;AACA,MAAI,CAAC,iBAAiB;AACpB,aAAS,yBAAyB;AAClC,WAAO;AAAA,MACL,QAAQ;AAAA,MACR,YAAY;AAAA,MACZ,MAAM;AAAA,IACR;AAAA,EACF;AAEA,QAAM,cACJ,QAAQ,eACP,MAAM,gBAAgB;AAAA,IACrB;AAAA,IACA;AAAA,EACF,CAAC;AAEH,QAAM,OAA4B;AAAA,IAChC;AAAA,IACA,iBAAiB,QAAQ;AAAA,IACzB;AAAA,IACA;AAAA,IACA;AAAA,EACF;AAEA,WAAS,4BAA4B;AAAA,IACnC;AAAA,IACA;AAAA,EACF,CAAC;AAED,QAAM,gBAAgB,MAAM,SAAS,oBAAoB;AAAA,IACvD,aAAa,QAAQ;AAAA,IACrB,iBAAiB,QAAQ;AAAA,EAC3B,CAAC;AACD,MAAI,CAAC,eAAe;AAClB,aAAS,yBAAyB;AAClC,WAAO;AAAA,MACL,QAAQ;AAAA,MACR,YAAY;AAAA,MACZ;AAAA,IACF;AAAA,EACF;AAEA,MAAI,eAA6C;AAEjD,MAAI,KAAK,iBAAiB;AACxB,QAAI;AACF,YAAM,iBAAiB,MAAM,uBAAuB;AAAA,QAClD;AAAA,QACA;AAAA,QACA,KAAK,QAAQ;AAAA,QACb,aAAa,KAAK;AAAA,QAClB,iBAAiB,KAAK;AAAA,MACxB,CAAC;AACD,qBAAe,sBAAsB,cAAc;AAAA,IACrD,SAAS,OAAO;AACd,YAAM;AAAA,QACJ,iDAAiD,eAAe,KAAK,CAAC;AAAA,MACxE;AAAA,IACF;AAAA,EACF;AAEA,QAAM,eAAyB,CAAC;AAChC,QAAM,oBAA8B,CAAC;AAErC,MAAI;AACF,eAAW,iBAAiB,KAAK,YAAY,gBAAgB;AAC3D,gCAA0B,KAAK,WAAW,cAAc,YAAY;AACpE,UAAc,oBAAoB,cAAc,YAAY,GAAG;AAC7D,qBAAa,KAAK,cAAc,IAAI;AAAA,MACtC;AAAA,IACF;AAEA,eAAW,qBAAqB,KAAK,YAAY,qBAAqB;AACpE,gCAA0B,KAAK,WAAW,kBAAkB,YAAY;AACxE,UAAc,sBAAsB,kBAAkB,YAAY,GAAG;AACnE,0BAAkB,KAAK,kBAAkB,IAAI;AAAA,MAC/C;AAAA,IACF;AAAA,EACF,SAAS,OAAO;AACd,aAAS,8BAA8B;AAAA,MACrC,aAAa,KAAK;AAAA,MAClB;AAAA,MACA;AAAA,MACA;AAAA,MACA,cAAc,eAAe,KAAK;AAAA,IACpC,CAAC;AACD,UAAM;AAAA,MACJ,gDAAgD,aAAa,MAAM,wBAAwB,kBAAkB,MAAM,YAAY,kBAAkB,WAAW,IAAI,MAAM,KAAK,KAAK,eAAe,KAAK,CAAC;AAAA,IACvM;AAAA,EACF;AAEA,WAAS,iCAAiC;AAAA,IACxC,aAAa,KAAK;AAAA,IAClB;AAAA,IACA;AAAA,IACA;AAAA,EACF,CAAC;AAED,SAAO;AAAA,IACL,QAAQ;AAAA,IACR;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;AAEA,eAAe,gBAAgB,SAGN;AACvB,QAAM,WAAW,aAAa,QAAQ,SAAS;AAC/C,SAAO,kBAAkB;AAAA,IACvB,WAAW,QAAQ;AAAA,IACnB;AAAA,IACA,SAAS,QAAQ;AAAA,EACnB,CAAC;AACH;AAEA,SAAS,0BAA0B,WAAmB,eAA6B;AACjF,QAAM,aAAa,KAAK,QAAQ,WAAW,SAAS;AACpD,QAAM,sBAAsB,KAAK,QAAQ,aAAa;AACtD,QAAM,eAAe,KAAK,SAAS,YAAY,mBAAmB;AAElE,MAAI,iBAAiB,MAAO,CAAC,aAAa,WAAW,IAAI,KAAK,CAAC,KAAK,WAAW,YAAY,GAAI;AAC7F,UAAM,IAAI,MAAM,6DAA6D,aAAa,EAAE;AAAA,EAC9F;AACF;AAEA,SAAS,qBAAqB,SAAwB;AACpD,SAAO,IAAI,MAAM,OAAO;AAC1B;AAEA,SAAS,eAAe,OAAwB;AAC9C,SAAO,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AAC9D;","names":[]}
|
package/package.json
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@brucewaynedecoy/make-docs",
|
|
3
|
+
"version": "1.0.0-rc.1",
|
|
4
|
+
"description": "Drop-in documentation structure, templates, and AI agent instructions with an NPX installer.",
|
|
5
|
+
"license": "Apache-2.0",
|
|
6
|
+
"repository": {
|
|
7
|
+
"type": "git",
|
|
8
|
+
"url": "git+https://github.com/brucewaynedecoy/make-docs.git"
|
|
9
|
+
},
|
|
10
|
+
"homepage": "https://github.com/brucewaynedecoy/make-docs#readme",
|
|
11
|
+
"bugs": {
|
|
12
|
+
"url": "https://github.com/brucewaynedecoy/make-docs/issues"
|
|
13
|
+
},
|
|
14
|
+
"type": "module",
|
|
15
|
+
"bin": {
|
|
16
|
+
"make-docs": "dist/index.js"
|
|
17
|
+
},
|
|
18
|
+
"files": [
|
|
19
|
+
"dist",
|
|
20
|
+
"template",
|
|
21
|
+
"skill-registry.json",
|
|
22
|
+
"skill-registry.schema.json",
|
|
23
|
+
"README.md"
|
|
24
|
+
],
|
|
25
|
+
"engines": {
|
|
26
|
+
"node": ">=18"
|
|
27
|
+
},
|
|
28
|
+
"publishConfig": {
|
|
29
|
+
"access": "public"
|
|
30
|
+
},
|
|
31
|
+
"scripts": {
|
|
32
|
+
"build": "tsup",
|
|
33
|
+
"dev": "tsx src/index.ts",
|
|
34
|
+
"test": "vitest run",
|
|
35
|
+
"validate:defaults": "vitest run tests/consistency.test.ts",
|
|
36
|
+
"prepack": "node ../../scripts/copy-template-to-cli.mjs && npm run build"
|
|
37
|
+
},
|
|
38
|
+
"devDependencies": {
|
|
39
|
+
"@types/node": "^24.7.2",
|
|
40
|
+
"tsup": "^8.5.0",
|
|
41
|
+
"tsx": "^4.20.6",
|
|
42
|
+
"typescript": "^5.9.3",
|
|
43
|
+
"vitest": "^3.2.4"
|
|
44
|
+
},
|
|
45
|
+
"dependencies": {
|
|
46
|
+
"@clack/core": "^1.1.0",
|
|
47
|
+
"@clack/prompts": "^1.1.0"
|
|
48
|
+
}
|
|
49
|
+
}
|
|
@@ -0,0 +1,276 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "./skill-registry.schema.json",
|
|
3
|
+
"skills": [
|
|
4
|
+
{
|
|
5
|
+
"name": "archive-docs",
|
|
6
|
+
"source": "https://github.com/brucewaynedecoy/make-docs/tree/main/packages/skills/archive-docs",
|
|
7
|
+
"entryPoint": "SKILL.md",
|
|
8
|
+
"installName": "archive-docs",
|
|
9
|
+
"description": "Relationship-aware archival, staleness detection, deprecation, and impact analysis for docs/ artifacts.",
|
|
10
|
+
"assets": [
|
|
11
|
+
{
|
|
12
|
+
"source": "agents/openai.yaml",
|
|
13
|
+
"installPath": "agents/openai.yaml"
|
|
14
|
+
},
|
|
15
|
+
{
|
|
16
|
+
"source": "references/archive-workflow.md",
|
|
17
|
+
"installPath": "references/archive-workflow.md"
|
|
18
|
+
},
|
|
19
|
+
{
|
|
20
|
+
"source": "scripts/trace_relationships.py",
|
|
21
|
+
"installPath": "scripts/trace_relationships.py"
|
|
22
|
+
}
|
|
23
|
+
]
|
|
24
|
+
},
|
|
25
|
+
{
|
|
26
|
+
"name": "closeout-commit",
|
|
27
|
+
"source": "https://github.com/brucewaynedecoy/make-docs/tree/main/packages/skills/closeout-commit",
|
|
28
|
+
"entryPoint": "SKILL.md",
|
|
29
|
+
"installName": "closeout-commit",
|
|
30
|
+
"description": "Capture gaps, write history, and draft commit messages for uncommitted changes.",
|
|
31
|
+
"assets": [
|
|
32
|
+
{
|
|
33
|
+
"source": "agents/openai.yaml",
|
|
34
|
+
"installPath": "agents/openai.yaml"
|
|
35
|
+
},
|
|
36
|
+
{
|
|
37
|
+
"source": "references/closeout-commit-workflow.md",
|
|
38
|
+
"installPath": "references/closeout-commit-workflow.md"
|
|
39
|
+
},
|
|
40
|
+
{
|
|
41
|
+
"source": "scripts/closeout_probe.py",
|
|
42
|
+
"installPath": "scripts/closeout_probe.py"
|
|
43
|
+
},
|
|
44
|
+
{
|
|
45
|
+
"source": "scripts/closeout_validate.py",
|
|
46
|
+
"installPath": "scripts/closeout_validate.py"
|
|
47
|
+
},
|
|
48
|
+
{
|
|
49
|
+
"source": "scripts/closeout_history.py",
|
|
50
|
+
"installPath": "scripts/closeout_history.py"
|
|
51
|
+
}
|
|
52
|
+
]
|
|
53
|
+
},
|
|
54
|
+
{
|
|
55
|
+
"name": "closeout-phase",
|
|
56
|
+
"source": "https://github.com/brucewaynedecoy/make-docs/tree/main/packages/skills/closeout-phase",
|
|
57
|
+
"entryPoint": "SKILL.md",
|
|
58
|
+
"installName": "closeout-phase",
|
|
59
|
+
"description": "Close out completed work backlog phases with checked tasks, acceptance evidence, guides, gap capture, history, and commit-message drafts.",
|
|
60
|
+
"assets": [
|
|
61
|
+
{
|
|
62
|
+
"source": "agents/openai.yaml",
|
|
63
|
+
"installPath": "agents/openai.yaml"
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
"source": "references/closeout-workflow.md",
|
|
67
|
+
"installPath": "references/closeout-workflow.md"
|
|
68
|
+
},
|
|
69
|
+
{
|
|
70
|
+
"source": "scripts/closeout_probe.py",
|
|
71
|
+
"installPath": "scripts/closeout_probe.py"
|
|
72
|
+
},
|
|
73
|
+
{
|
|
74
|
+
"source": "scripts/closeout_validate.py",
|
|
75
|
+
"installPath": "scripts/closeout_validate.py"
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
"source": "scripts/closeout_history.py",
|
|
79
|
+
"installPath": "scripts/closeout_history.py"
|
|
80
|
+
},
|
|
81
|
+
{
|
|
82
|
+
"source": "scripts/work_phase_state.py",
|
|
83
|
+
"installPath": "scripts/work_phase_state.py"
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
"source": "scripts/guide_coverage_probe.py",
|
|
87
|
+
"installPath": "scripts/guide_coverage_probe.py"
|
|
88
|
+
}
|
|
89
|
+
]
|
|
90
|
+
},
|
|
91
|
+
{
|
|
92
|
+
"name": "cleanup-docs",
|
|
93
|
+
"source": "https://github.com/brucewaynedecoy/make-docs/tree/main/packages/skills/cleanup-docs",
|
|
94
|
+
"entryPoint": "SKILL.md",
|
|
95
|
+
"installName": "cleanup-docs",
|
|
96
|
+
"description": "Audit and clean Markdown docs formatting drift, hard-wrapped prose, list spacing, and document-contract issues.",
|
|
97
|
+
"assets": [
|
|
98
|
+
{
|
|
99
|
+
"source": "agents/openai.yaml",
|
|
100
|
+
"installPath": "agents/openai.yaml"
|
|
101
|
+
},
|
|
102
|
+
{
|
|
103
|
+
"source": "scripts/check_markdown_style.py",
|
|
104
|
+
"installPath": "scripts/check_markdown_style.py"
|
|
105
|
+
}
|
|
106
|
+
]
|
|
107
|
+
},
|
|
108
|
+
{
|
|
109
|
+
"name": "work-on-wave",
|
|
110
|
+
"source": "https://github.com/brucewaynedecoy/make-docs/tree/main/packages/skills/work-on-wave",
|
|
111
|
+
"entryPoint": "SKILL.md",
|
|
112
|
+
"installName": "work-on-wave",
|
|
113
|
+
"description": "Work on docs/work waves through implementation, validation, closeout, and phase commits.",
|
|
114
|
+
"assets": [
|
|
115
|
+
{
|
|
116
|
+
"source": "agents/openai.yaml",
|
|
117
|
+
"installPath": "agents/openai.yaml"
|
|
118
|
+
},
|
|
119
|
+
{
|
|
120
|
+
"source": "references/wave-implementation-workflow.md",
|
|
121
|
+
"installPath": "references/wave-implementation-workflow.md"
|
|
122
|
+
},
|
|
123
|
+
{
|
|
124
|
+
"source": "scripts/work_on_wave_common.py",
|
|
125
|
+
"installPath": "scripts/work_on_wave_common.py"
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
"source": "scripts/resolve_wave.py",
|
|
129
|
+
"installPath": "scripts/resolve_wave.py"
|
|
130
|
+
},
|
|
131
|
+
{
|
|
132
|
+
"source": "scripts/wave_status.py",
|
|
133
|
+
"installPath": "scripts/wave_status.py"
|
|
134
|
+
},
|
|
135
|
+
{
|
|
136
|
+
"source": "scripts/phase_plan.py",
|
|
137
|
+
"installPath": "scripts/phase_plan.py"
|
|
138
|
+
},
|
|
139
|
+
{
|
|
140
|
+
"source": "scripts/checkpoint.py",
|
|
141
|
+
"installPath": "scripts/checkpoint.py"
|
|
142
|
+
},
|
|
143
|
+
{
|
|
144
|
+
"source": "scripts/scope_guard.py",
|
|
145
|
+
"installPath": "scripts/scope_guard.py"
|
|
146
|
+
},
|
|
147
|
+
{
|
|
148
|
+
"source": "scripts/phase_gate.py",
|
|
149
|
+
"installPath": "scripts/phase_gate.py"
|
|
150
|
+
}
|
|
151
|
+
]
|
|
152
|
+
},
|
|
153
|
+
{
|
|
154
|
+
"name": "work-on-phase",
|
|
155
|
+
"source": "https://github.com/brucewaynedecoy/make-docs/tree/main/packages/skills/work-on-phase",
|
|
156
|
+
"entryPoint": "SKILL.md",
|
|
157
|
+
"installName": "work-on-phase",
|
|
158
|
+
"description": "Implement one explicit docs/work phase through planning, validation, closeout, and optional commit.",
|
|
159
|
+
"assets": [
|
|
160
|
+
{
|
|
161
|
+
"source": "agents/openai.yaml",
|
|
162
|
+
"installPath": "agents/openai.yaml"
|
|
163
|
+
},
|
|
164
|
+
{
|
|
165
|
+
"source": "references/phase-implementation-workflow.md",
|
|
166
|
+
"installPath": "references/phase-implementation-workflow.md"
|
|
167
|
+
},
|
|
168
|
+
{
|
|
169
|
+
"source": "scripts/work_on_wave_common.py",
|
|
170
|
+
"installPath": "scripts/work_on_wave_common.py"
|
|
171
|
+
},
|
|
172
|
+
{
|
|
173
|
+
"source": "scripts/resolve_wave.py",
|
|
174
|
+
"installPath": "scripts/resolve_wave.py"
|
|
175
|
+
},
|
|
176
|
+
{
|
|
177
|
+
"source": "scripts/phase_plan.py",
|
|
178
|
+
"installPath": "scripts/phase_plan.py"
|
|
179
|
+
},
|
|
180
|
+
{
|
|
181
|
+
"source": "scripts/checkpoint.py",
|
|
182
|
+
"installPath": "scripts/checkpoint.py"
|
|
183
|
+
},
|
|
184
|
+
{
|
|
185
|
+
"source": "scripts/scope_guard.py",
|
|
186
|
+
"installPath": "scripts/scope_guard.py"
|
|
187
|
+
},
|
|
188
|
+
{
|
|
189
|
+
"source": "scripts/phase_gate.py",
|
|
190
|
+
"installPath": "scripts/phase_gate.py"
|
|
191
|
+
}
|
|
192
|
+
]
|
|
193
|
+
},
|
|
194
|
+
{
|
|
195
|
+
"name": "decompose-codebase",
|
|
196
|
+
"source": "https://github.com/brucewaynedecoy/make-docs/tree/main/packages/skills/decompose-codebase",
|
|
197
|
+
"entryPoint": "SKILL.md",
|
|
198
|
+
"installName": "decompose-codebase",
|
|
199
|
+
"description": "Plan and reverse-engineer repos into structured PRDs.",
|
|
200
|
+
"assets": [
|
|
201
|
+
{
|
|
202
|
+
"source": "agents/openai.yaml",
|
|
203
|
+
"installPath": "agents/openai.yaml"
|
|
204
|
+
},
|
|
205
|
+
{
|
|
206
|
+
"source": "scripts/probe_environment.py",
|
|
207
|
+
"installPath": "scripts/probe_environment.py"
|
|
208
|
+
},
|
|
209
|
+
{
|
|
210
|
+
"source": "scripts/validate_output.py",
|
|
211
|
+
"installPath": "scripts/validate_output.py"
|
|
212
|
+
},
|
|
213
|
+
{
|
|
214
|
+
"source": "references/planning-workflow.md",
|
|
215
|
+
"installPath": "references/planning-workflow.md"
|
|
216
|
+
},
|
|
217
|
+
{
|
|
218
|
+
"source": "references/execution-workflow.md",
|
|
219
|
+
"installPath": "references/execution-workflow.md"
|
|
220
|
+
},
|
|
221
|
+
{
|
|
222
|
+
"source": "references/mcp-playbook.md",
|
|
223
|
+
"installPath": "references/mcp-playbook.md"
|
|
224
|
+
},
|
|
225
|
+
{
|
|
226
|
+
"source": "references/output-contract.md",
|
|
227
|
+
"installPath": "references/output-contract.md"
|
|
228
|
+
},
|
|
229
|
+
{
|
|
230
|
+
"source": "references/harness-capability-matrix.md",
|
|
231
|
+
"installPath": "references/harness-capability-matrix.md"
|
|
232
|
+
},
|
|
233
|
+
{
|
|
234
|
+
"source": "assets/templates/decomposition-plan.md",
|
|
235
|
+
"installPath": "assets/templates/decomposition-plan.md"
|
|
236
|
+
},
|
|
237
|
+
{
|
|
238
|
+
"source": "assets/templates/prd-index.md",
|
|
239
|
+
"installPath": "assets/templates/prd-index.md"
|
|
240
|
+
},
|
|
241
|
+
{
|
|
242
|
+
"source": "assets/templates/prd-overview.md",
|
|
243
|
+
"installPath": "assets/templates/prd-overview.md"
|
|
244
|
+
},
|
|
245
|
+
{
|
|
246
|
+
"source": "assets/templates/prd-architecture.md",
|
|
247
|
+
"installPath": "assets/templates/prd-architecture.md"
|
|
248
|
+
},
|
|
249
|
+
{
|
|
250
|
+
"source": "assets/templates/prd-subsystem.md",
|
|
251
|
+
"installPath": "assets/templates/prd-subsystem.md"
|
|
252
|
+
},
|
|
253
|
+
{
|
|
254
|
+
"source": "assets/templates/prd-reference.md",
|
|
255
|
+
"installPath": "assets/templates/prd-reference.md"
|
|
256
|
+
},
|
|
257
|
+
{
|
|
258
|
+
"source": "assets/templates/prd-risk-register.md",
|
|
259
|
+
"installPath": "assets/templates/prd-risk-register.md"
|
|
260
|
+
},
|
|
261
|
+
{
|
|
262
|
+
"source": "assets/templates/prd-glossary.md",
|
|
263
|
+
"installPath": "assets/templates/prd-glossary.md"
|
|
264
|
+
},
|
|
265
|
+
{
|
|
266
|
+
"source": "assets/templates/rebuild-backlog-index.md",
|
|
267
|
+
"installPath": "assets/templates/rebuild-backlog-index.md"
|
|
268
|
+
},
|
|
269
|
+
{
|
|
270
|
+
"source": "assets/templates/rebuild-backlog-phase.md",
|
|
271
|
+
"installPath": "assets/templates/rebuild-backlog-phase.md"
|
|
272
|
+
}
|
|
273
|
+
]
|
|
274
|
+
}
|
|
275
|
+
]
|
|
276
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
{
|
|
2
|
+
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
3
|
+
"$id": "./skill-registry.schema.json",
|
|
4
|
+
"title": "make-docs skill registry",
|
|
5
|
+
"type": "object",
|
|
6
|
+
"additionalProperties": false,
|
|
7
|
+
"required": ["skills"],
|
|
8
|
+
"properties": {
|
|
9
|
+
"skills": {
|
|
10
|
+
"type": "array",
|
|
11
|
+
"items": {
|
|
12
|
+
"type": "object",
|
|
13
|
+
"additionalProperties": false,
|
|
14
|
+
"required": [
|
|
15
|
+
"name",
|
|
16
|
+
"source",
|
|
17
|
+
"entryPoint",
|
|
18
|
+
"installName",
|
|
19
|
+
"description",
|
|
20
|
+
"assets"
|
|
21
|
+
],
|
|
22
|
+
"properties": {
|
|
23
|
+
"name": {
|
|
24
|
+
"type": "string",
|
|
25
|
+
"minLength": 1
|
|
26
|
+
},
|
|
27
|
+
"source": {
|
|
28
|
+
"type": "string",
|
|
29
|
+
"pattern": "^(https?://|github:|url:).+"
|
|
30
|
+
},
|
|
31
|
+
"entryPoint": {
|
|
32
|
+
"type": "string",
|
|
33
|
+
"minLength": 1
|
|
34
|
+
},
|
|
35
|
+
"installName": {
|
|
36
|
+
"type": "string",
|
|
37
|
+
"minLength": 1
|
|
38
|
+
},
|
|
39
|
+
"description": {
|
|
40
|
+
"type": "string"
|
|
41
|
+
},
|
|
42
|
+
"assets": {
|
|
43
|
+
"type": "array",
|
|
44
|
+
"items": {
|
|
45
|
+
"type": "object",
|
|
46
|
+
"additionalProperties": false,
|
|
47
|
+
"required": ["source", "installPath"],
|
|
48
|
+
"properties": {
|
|
49
|
+
"source": {
|
|
50
|
+
"type": "string",
|
|
51
|
+
"minLength": 1
|
|
52
|
+
},
|
|
53
|
+
"installPath": {
|
|
54
|
+
"type": "string",
|
|
55
|
+
"minLength": 1
|
|
56
|
+
}
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
}
|