@cleocode/core 2026.11.1-canary.2 → 2026.11.1-canary.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 +2 -0
- package/binaries/README.md +30 -10
- package/dist/.source-stamp.json +1 -1
- package/dist/audit/reconstruct.d.ts.map +1 -1
- package/dist/audit/reconstruct.js +3 -13
- package/dist/audit/reconstruct.js.map +1 -1
- package/dist/build-provenance.json +2 -2
- package/dist/cloud/nexus-vault.d.ts.map +1 -1
- package/dist/cloud/nexus-vault.js +3 -9
- package/dist/cloud/nexus-vault.js.map +1 -1
- package/dist/docs/docs-fts.d.ts +102 -0
- package/dist/docs/docs-fts.d.ts.map +1 -0
- package/dist/docs/docs-fts.js +276 -0
- package/dist/docs/docs-fts.js.map +1 -0
- package/dist/docs/docs-ops.d.ts +40 -5
- package/dist/docs/docs-ops.d.ts.map +1 -1
- package/dist/docs/docs-ops.js +168 -19
- package/dist/docs/docs-ops.js.map +1 -1
- package/dist/docs/docs-read-model.d.ts +41 -14
- package/dist/docs/docs-read-model.d.ts.map +1 -1
- package/dist/docs/docs-read-model.js +13 -99
- package/dist/docs/docs-read-model.js.map +1 -1
- package/dist/docs/doctor.d.ts +39 -0
- package/dist/docs/doctor.d.ts.map +1 -1
- package/dist/docs/doctor.js +111 -31
- package/dist/docs/doctor.js.map +1 -1
- package/dist/docs/lineage.d.ts +16 -1
- package/dist/docs/lineage.d.ts.map +1 -1
- package/dist/docs/lineage.js +73 -0
- package/dist/docs/lineage.js.map +1 -1
- package/dist/docs/modernize/apply.d.ts +16 -2
- package/dist/docs/modernize/apply.d.ts.map +1 -1
- package/dist/docs/modernize/apply.js +116 -28
- package/dist/docs/modernize/apply.js.map +1 -1
- package/dist/docs/modernize/guard.d.ts +27 -7
- package/dist/docs/modernize/guard.d.ts.map +1 -1
- package/dist/docs/modernize/guard.js +110 -14
- package/dist/docs/modernize/guard.js.map +1 -1
- package/dist/docs/modernize/index.d.ts +11 -2
- package/dist/docs/modernize/index.d.ts.map +1 -1
- package/dist/docs/modernize/index.js +20 -10
- package/dist/docs/modernize/index.js.map +1 -1
- package/dist/docs/modernize/plan.d.ts.map +1 -1
- package/dist/docs/modernize/plan.js +113 -5
- package/dist/docs/modernize/plan.js.map +1 -1
- package/dist/docs/modernize/rules.d.ts +92 -8
- package/dist/docs/modernize/rules.d.ts.map +1 -1
- package/dist/docs/modernize/rules.js +224 -28
- package/dist/docs/modernize/rules.js.map +1 -1
- package/dist/docs/publish-pr.d.ts.map +1 -1
- package/dist/docs/publish-pr.js +3 -1
- package/dist/docs/publish-pr.js.map +1 -1
- package/dist/gateway-client/generated/index.d.ts +2 -2
- package/dist/gateway-client/generated/index.d.ts.map +1 -1
- package/dist/gateway-client/generated/index.js +1 -1
- package/dist/gateway-client/generated/index.js.map +1 -1
- package/dist/gateway-client/generated/namespaces.gen.d.ts +1 -0
- package/dist/gateway-client/generated/namespaces.gen.d.ts.map +1 -1
- package/dist/gateway-client/generated/namespaces.gen.js +2 -1
- package/dist/gateway-client/generated/namespaces.gen.js.map +1 -1
- package/dist/gateway-client/generated/sdk.gen.d.ts +5 -1
- package/dist/gateway-client/generated/sdk.gen.d.ts.map +1 -1
- package/dist/gateway-client/generated/sdk.gen.js +11 -0
- package/dist/gateway-client/generated/sdk.gen.js.map +1 -1
- package/dist/gateway-client/generated/types.gen.d.ts +54 -0
- package/dist/gateway-client/generated/types.gen.d.ts.map +1 -1
- package/dist/git/work-tree.d.ts +24 -0
- package/dist/git/work-tree.d.ts.map +1 -1
- package/dist/git/work-tree.js +12 -1
- package/dist/git/work-tree.js.map +1 -1
- package/dist/init.d.ts.map +1 -1
- package/dist/init.js +13 -5
- package/dist/init.js.map +1 -1
- package/dist/internal.d.ts +1 -1
- package/dist/internal.d.ts.map +1 -1
- package/dist/internal.js +1 -1
- package/dist/internal.js.map +1 -1
- package/dist/memory/engine-compat.d.ts.map +1 -1
- package/dist/memory/engine-compat.js +44 -12
- package/dist/memory/engine-compat.js.map +1 -1
- package/dist/orchestration/spawn-prompt.d.ts +17 -0
- package/dist/orchestration/spawn-prompt.d.ts.map +1 -1
- package/dist/orchestration/spawn-prompt.js +41 -3
- package/dist/orchestration/spawn-prompt.js.map +1 -1
- package/dist/orchestration/spawn.d.ts.map +1 -1
- package/dist/orchestration/spawn.js +12 -0
- package/dist/orchestration/spawn.js.map +1 -1
- package/dist/paths.d.ts +20 -0
- package/dist/paths.d.ts.map +1 -1
- package/dist/paths.js +26 -0
- package/dist/paths.js.map +1 -1
- package/dist/release/ci-evidence.d.ts +7 -3
- package/dist/release/ci-evidence.d.ts.map +1 -1
- package/dist/release/ci-evidence.js +77 -14
- package/dist/release/ci-evidence.js.map +1 -1
- package/dist/release/cut.d.ts +13 -0
- package/dist/release/cut.d.ts.map +1 -1
- package/dist/release/cut.js +63 -9
- package/dist/release/cut.js.map +1 -1
- package/dist/release/engine-ops.d.ts.map +1 -1
- package/dist/release/engine-ops.js +10 -4
- package/dist/release/engine-ops.js.map +1 -1
- package/dist/release/plan.d.ts +3 -1
- package/dist/release/plan.d.ts.map +1 -1
- package/dist/release/plan.js +4 -2
- package/dist/release/plan.js.map +1 -1
- package/dist/release/reconcile.d.ts +3 -1
- package/dist/release/reconcile.d.ts.map +1 -1
- package/dist/release/reconcile.js +18 -6
- package/dist/release/reconcile.js.map +1 -1
- package/dist/release/release-published.d.ts +27 -0
- package/dist/release/release-published.d.ts.map +1 -0
- package/dist/release/release-published.js +35 -0
- package/dist/release/release-published.js.map +1 -0
- package/dist/remote/index.js +1 -1
- package/dist/remote/index.js.map +1 -1
- package/dist/scaffold/ensure-dirs.d.ts.map +1 -1
- package/dist/scaffold/ensure-dirs.js +8 -6
- package/dist/scaffold/ensure-dirs.js.map +1 -1
- package/dist/selfimprove/draft-pr.d.ts.map +1 -1
- package/dist/selfimprove/draft-pr.js +4 -1
- package/dist/selfimprove/draft-pr.js.map +1 -1
- package/dist/skills/propose-patch.d.ts.map +1 -1
- package/dist/skills/propose-patch.js +4 -1
- package/dist/skills/propose-patch.js.map +1 -1
- package/dist/store/ac-binding-prune.d.ts +3 -2
- package/dist/store/ac-binding-prune.d.ts.map +1 -1
- package/dist/store/ac-binding-prune.js +4 -3
- package/dist/store/ac-binding-prune.js.map +1 -1
- package/dist/store/git-checkpoint.d.ts +11 -1
- package/dist/store/git-checkpoint.d.ts.map +1 -1
- package/dist/store/git-checkpoint.js +14 -3
- package/dist/store/git-checkpoint.js.map +1 -1
- package/dist/store/schema/tasks.d.ts +1 -1
- package/dist/store/schema/tasks.d.ts.map +1 -1
- package/dist/store/schema/tasks.js +2 -0
- package/dist/store/schema/tasks.js.map +1 -1
- package/dist/store/table-classification.d.ts.map +1 -1
- package/dist/store/table-classification.js +8 -0
- package/dist/store/table-classification.js.map +1 -1
- package/dist/system/dependencies.d.ts +22 -0
- package/dist/system/dependencies.d.ts.map +1 -1
- package/dist/system/dependencies.js +49 -2
- package/dist/system/dependencies.js.map +1 -1
- package/dist/system/health.d.ts.map +1 -1
- package/dist/system/health.js +3 -1
- package/dist/system/health.js.map +1 -1
- package/dist/task-work/index.d.ts.map +1 -1
- package/dist/task-work/index.js +3 -1
- package/dist/task-work/index.js.map +1 -1
- package/dist/tasks/ac-immutability.d.ts +21 -2
- package/dist/tasks/ac-immutability.d.ts.map +1 -1
- package/dist/tasks/ac-immutability.js +25 -0
- package/dist/tasks/ac-immutability.js.map +1 -1
- package/dist/tasks/ac-table.d.ts +15 -1
- package/dist/tasks/ac-table.d.ts.map +1 -1
- package/dist/tasks/ac-table.js +21 -0
- package/dist/tasks/ac-table.js.map +1 -1
- package/dist/tasks/add.d.ts +8 -0
- package/dist/tasks/add.d.ts.map +1 -1
- package/dist/tasks/add.js +12 -3
- package/dist/tasks/add.js.map +1 -1
- package/dist/tasks/change-set.d.ts.map +1 -1
- package/dist/tasks/change-set.js +92 -27
- package/dist/tasks/change-set.js.map +1 -1
- package/dist/tasks/complete.d.ts.map +1 -1
- package/dist/tasks/complete.js +23 -14
- package/dist/tasks/complete.js.map +1 -1
- package/dist/tasks/component-pr.d.ts.map +1 -1
- package/dist/tasks/component-pr.js +4 -3
- package/dist/tasks/component-pr.js.map +1 -1
- package/dist/tasks/criterion-receipt.d.ts +63 -0
- package/dist/tasks/criterion-receipt.d.ts.map +1 -0
- package/dist/tasks/criterion-receipt.js +145 -0
- package/dist/tasks/criterion-receipt.js.map +1 -0
- package/dist/tasks/done-plan.d.ts.map +1 -1
- package/dist/tasks/done-plan.js +70 -6
- package/dist/tasks/done-plan.js.map +1 -1
- package/dist/tasks/evidence.d.ts +8 -2
- package/dist/tasks/evidence.d.ts.map +1 -1
- package/dist/tasks/evidence.js +51 -15
- package/dist/tasks/evidence.js.map +1 -1
- package/dist/tasks/gate-notes.d.ts +17 -0
- package/dist/tasks/gate-notes.d.ts.map +1 -1
- package/dist/tasks/gate-notes.js.map +1 -1
- package/dist/tasks/manifest-scope.d.ts +42 -5
- package/dist/tasks/manifest-scope.d.ts.map +1 -1
- package/dist/tasks/manifest-scope.js +162 -9
- package/dist/tasks/manifest-scope.js.map +1 -1
- package/dist/tasks/merge-close.d.ts +25 -2
- package/dist/tasks/merge-close.d.ts.map +1 -1
- package/dist/tasks/merge-close.js +30 -2
- package/dist/tasks/merge-close.js.map +1 -1
- package/dist/tasks/req.d.ts +49 -0
- package/dist/tasks/req.d.ts.map +1 -1
- package/dist/tasks/req.js +156 -2
- package/dist/tasks/req.js.map +1 -1
- package/dist/tasks/verification-policy.d.ts +34 -0
- package/dist/tasks/verification-policy.d.ts.map +1 -1
- package/dist/tasks/verification-policy.js +77 -5
- package/dist/tasks/verification-policy.js.map +1 -1
- package/dist/validation/doctor/checks.d.ts +20 -0
- package/dist/validation/doctor/checks.d.ts.map +1 -1
- package/dist/validation/doctor/checks.js +112 -0
- package/dist/validation/doctor/checks.js.map +1 -1
- package/dist/validation/engine-ops.d.ts.map +1 -1
- package/dist/validation/engine-ops.js +11 -4
- package/dist/validation/engine-ops.js.map +1 -1
- package/dist/worktree/merged-cleanup.d.ts +10 -0
- package/dist/worktree/merged-cleanup.d.ts.map +1 -1
- package/dist/worktree/merged-cleanup.js +12 -1
- package/dist/worktree/merged-cleanup.js.map +1 -1
- package/package.json +12 -12
- package/templates/CLEO-INJECTION.md +1 -1
- package/templates/CLEO-REFERENCE.md +6 -2
- package/templates/git-hooks/legacy-hashes.json +2 -1
- package/templates/git-hooks/pre-commit +43 -11
|
@@ -10,6 +10,8 @@
|
|
|
10
10
|
import { existsSync, lstatSync, realpathSync } from 'node:fs';
|
|
11
11
|
import { dirname, isAbsolute, relative, resolve, sep } from 'node:path';
|
|
12
12
|
import { docsModernizeOverridesSchema, docsModernizePlanSchema, docsModernizeReceiptSchema, } from '@cleocode/contracts/docs/modernize.js';
|
|
13
|
+
import { gitCommonDir } from '../../git/work-tree.js';
|
|
14
|
+
import { repoLinkFixAllowed } from './rules.js';
|
|
13
15
|
/** Raised when a plan, receipt or path fails a guard. */
|
|
14
16
|
export class DocsModernizeUnsafeError extends Error {
|
|
15
17
|
/** Stable code for the envelope. */
|
|
@@ -59,18 +61,44 @@ export function safeJoin(root, rel) {
|
|
|
59
61
|
return abs;
|
|
60
62
|
}
|
|
61
63
|
/**
|
|
62
|
-
* Check that
|
|
64
|
+
* Check that the invoking checkout is the project root or a git worktree of
|
|
65
|
+
* the SAME repository (one git common dir), so no checkout of an unrelated
|
|
66
|
+
* repository can be written to or read as the project's (T14188).
|
|
67
|
+
*
|
|
68
|
+
* @param projectRoot - Project root.
|
|
69
|
+
* @param checkoutRoot - The invoking checkout.
|
|
70
|
+
* @throws DocsModernizeUnsafeError when it is another repository, or git cannot tell.
|
|
71
|
+
*/
|
|
72
|
+
export function assertCheckoutOfProject(projectRoot, checkoutRoot) {
|
|
73
|
+
if (resolve(projectRoot) === resolve(checkoutRoot))
|
|
74
|
+
return;
|
|
75
|
+
const project = gitCommonDir(projectRoot);
|
|
76
|
+
const checkout = gitCommonDir(checkoutRoot);
|
|
77
|
+
if (project === null || project !== checkout) {
|
|
78
|
+
// @sync-invariant none:input-shape a checkout of another repository is refused before any read or write
|
|
79
|
+
throw new DocsModernizeUnsafeError(`checkout ${checkoutRoot} is not a worktree of the project ${projectRoot} ` +
|
|
80
|
+
`(git common dir ${checkout ?? 'unknown'} vs ${project ?? 'unknown'})`);
|
|
81
|
+
}
|
|
82
|
+
}
|
|
83
|
+
/**
|
|
84
|
+
* Check that a modernize root sits inside the project, or inside the checkout
|
|
85
|
+
* the command was started from, once that checkout is proven a worktree of
|
|
86
|
+
* the project's repository ({@link assertCheckoutOfProject}, T14188).
|
|
63
87
|
*
|
|
64
88
|
* @param projectRoot - Project root.
|
|
65
89
|
* @param root - Absolute modernize root.
|
|
66
|
-
* @
|
|
90
|
+
* @param checkoutRoot - The invoking checkout (default: the project root).
|
|
91
|
+
* @throws DocsModernizeUnsafeError when it sits in neither, or the checkout is
|
|
92
|
+
* another repository's.
|
|
67
93
|
*/
|
|
68
|
-
export function assertRootInProject(projectRoot, root) {
|
|
94
|
+
export function assertRootInProject(projectRoot, root, checkoutRoot = projectRoot) {
|
|
95
|
+
assertCheckoutOfProject(projectRoot, checkoutRoot);
|
|
69
96
|
if (!isAbsolute(root) ||
|
|
70
97
|
!existsSync(root) ||
|
|
71
|
-
!within(realpathSync(
|
|
98
|
+
![projectRoot, checkoutRoot].some((r) => within(realpathSync(r), realpathSync(root)))) {
|
|
72
99
|
// @sync-invariant none:input-shape a modernize root outside the project is refused before any write
|
|
73
|
-
throw new DocsModernizeUnsafeError(`modernize root ${root} is not inside the project ${projectRoot}`
|
|
100
|
+
throw new DocsModernizeUnsafeError(`modernize root ${root} is not inside the project ${projectRoot}` +
|
|
101
|
+
(checkoutRoot === projectRoot ? '' : ` or the checkout ${checkoutRoot}`));
|
|
74
102
|
}
|
|
75
103
|
}
|
|
76
104
|
/**
|
|
@@ -78,17 +106,18 @@ export function assertRootInProject(projectRoot, root) {
|
|
|
78
106
|
*
|
|
79
107
|
* @param raw - File text.
|
|
80
108
|
* @param projectRoot - Project root.
|
|
109
|
+
* @param checkoutRoot - The invoking checkout (default: the project root).
|
|
81
110
|
* @returns The plan, with every path checked.
|
|
82
111
|
* @throws DocsModernizeUnsafeError on a bad shape or an unsafe path.
|
|
83
112
|
*/
|
|
84
|
-
export function parseModernizePlan(raw, projectRoot) {
|
|
113
|
+
export function parseModernizePlan(raw, projectRoot, checkoutRoot = projectRoot) {
|
|
85
114
|
const parsed = docsModernizePlanSchema.safeParse(JSON.parse(raw));
|
|
86
115
|
if (!parsed.success) {
|
|
87
116
|
// @sync-invariant none:input-shape a malformed plan file is refused before any write
|
|
88
117
|
throw new DocsModernizeUnsafeError(`plan file does not match the plan schema: ${parsed.error.message}`);
|
|
89
118
|
}
|
|
90
119
|
const plan = parsed.data;
|
|
91
|
-
assertPlanPaths(plan, projectRoot);
|
|
120
|
+
assertPlanPaths(plan, projectRoot, checkoutRoot);
|
|
92
121
|
return plan;
|
|
93
122
|
}
|
|
94
123
|
/**
|
|
@@ -96,40 +125,84 @@ export function parseModernizePlan(raw, projectRoot) {
|
|
|
96
125
|
*
|
|
97
126
|
* @param plan - The plan.
|
|
98
127
|
* @param projectRoot - Project root.
|
|
128
|
+
* @param checkoutRoot - The invoking checkout (default: the project root).
|
|
99
129
|
*/
|
|
100
|
-
export function assertPlanPaths(plan, projectRoot) {
|
|
101
|
-
assertRootInProject(projectRoot, plan.root);
|
|
130
|
+
export function assertPlanPaths(plan, projectRoot, checkoutRoot = projectRoot) {
|
|
131
|
+
assertRootInProject(projectRoot, plan.root, checkoutRoot);
|
|
102
132
|
for (const row of plan.rows) {
|
|
103
133
|
safeJoin(plan.root, row.path);
|
|
104
134
|
if ((row.disposition === 'keep' || row.disposition === 'rename') && row.target) {
|
|
105
135
|
safeJoin(plan.root, row.target);
|
|
106
136
|
}
|
|
107
137
|
}
|
|
138
|
+
const repoFixes = (plan.linkFixes ?? []).filter((f) => f.base === 'repo');
|
|
139
|
+
if (repoFixes.length > 0)
|
|
140
|
+
assertRepoBase(projectRoot, plan.root, plan.repoRoot, checkoutRoot);
|
|
141
|
+
for (const fix of plan.linkFixes ?? []) {
|
|
142
|
+
if (fix.base !== 'repo')
|
|
143
|
+
safeJoin(plan.root, fix.path);
|
|
144
|
+
else
|
|
145
|
+
safeJoin(plan.repoRoot ?? '', fix.path);
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
/**
|
|
149
|
+
* Check the second write base of a plan or receipt (T14196): it exists, it is
|
|
150
|
+
* the project root or the invoking checkout (a worktree of this repository),
|
|
151
|
+
* and the modernize root sits inside it.
|
|
152
|
+
*
|
|
153
|
+
* @param projectRoot - Project root.
|
|
154
|
+
* @param root - Absolute modernize root.
|
|
155
|
+
* @param repoRoot - The base `repo` paths are relative to.
|
|
156
|
+
* @param checkoutRoot - The invoking checkout.
|
|
157
|
+
* @throws DocsModernizeUnsafeError when any of that fails.
|
|
158
|
+
*/
|
|
159
|
+
function assertRepoBase(projectRoot, root, repoRoot, checkoutRoot) {
|
|
160
|
+
if (!repoRoot) {
|
|
161
|
+
// @sync-invariant none:input-shape a repo-base link fix with no repo root is refused before any write
|
|
162
|
+
throw new DocsModernizeUnsafeError('a base:repo entry needs the plan or receipt repoRoot');
|
|
163
|
+
}
|
|
164
|
+
assertRootInProject(projectRoot, repoRoot, checkoutRoot);
|
|
165
|
+
if (!within(realpathSync(repoRoot), realpathSync(root))) {
|
|
166
|
+
// @sync-invariant none:input-shape a repo root that does not hold the modernize root is refused before any write
|
|
167
|
+
throw new DocsModernizeUnsafeError(`repoRoot ${repoRoot} does not hold the modernize root ${root}`);
|
|
168
|
+
}
|
|
108
169
|
}
|
|
109
170
|
/**
|
|
110
171
|
* Parse and check a receipt read back for rollback.
|
|
111
172
|
*
|
|
112
173
|
* @param raw - File text.
|
|
113
174
|
* @param projectRoot - Project root.
|
|
175
|
+
* @param checkoutRoot - The invoking checkout (default: the project root).
|
|
114
176
|
* @returns The receipt, with every path checked.
|
|
115
177
|
*/
|
|
116
|
-
export function parseModernizeReceipt(raw, projectRoot) {
|
|
178
|
+
export function parseModernizeReceipt(raw, projectRoot, checkoutRoot = projectRoot) {
|
|
117
179
|
const parsed = docsModernizeReceiptSchema.safeParse(JSON.parse(raw));
|
|
118
180
|
if (!parsed.success) {
|
|
119
181
|
// @sync-invariant none:input-shape a malformed receipt is refused before any rollback step
|
|
120
182
|
throw new DocsModernizeUnsafeError(`receipt does not match the receipt schema: ${parsed.error.message}`);
|
|
121
183
|
}
|
|
122
184
|
const receipt = parsed.data;
|
|
123
|
-
assertRootInProject(projectRoot, receipt.root);
|
|
124
|
-
|
|
125
|
-
|
|
185
|
+
assertRootInProject(projectRoot, receipt.root, checkoutRoot);
|
|
186
|
+
if (receipt.ops.some((op) => op.base === 'repo')) {
|
|
187
|
+
assertRepoBase(projectRoot, receipt.root, receipt.repoRoot, checkoutRoot);
|
|
188
|
+
}
|
|
189
|
+
for (const op of receipt.ops) {
|
|
190
|
+
if (!op.path)
|
|
191
|
+
continue;
|
|
192
|
+
if (op.base === 'repo')
|
|
193
|
+
safeJoin(receipt.repoRoot ?? '', op.path);
|
|
194
|
+
else
|
|
126
195
|
safeJoin(receipt.root, op.path);
|
|
196
|
+
}
|
|
127
197
|
return receipt;
|
|
128
198
|
}
|
|
129
199
|
/**
|
|
130
200
|
* Check that a plan hangs together: every `merge-into`/`delete` row names a
|
|
131
201
|
* survivor's slug (so its content has somewhere to go), every `keep` row
|
|
132
|
-
* targets its own path,
|
|
202
|
+
* targets its own path, every survivor target is a `.md`/`.txt` file, and
|
|
203
|
+
* every `link-fix` names a kept file, an unscanned file (with its sha256), or
|
|
204
|
+
* (`base: 'repo'`, T14196) an editable markdown file outside the root (with its
|
|
205
|
+
* sha256), of a tree plan.
|
|
133
206
|
*
|
|
134
207
|
* @param plan - The plan.
|
|
135
208
|
* @throws DocsModernizeUnsafeError on the first inconsistent row.
|
|
@@ -155,6 +228,29 @@ export function assertPlanConsistent(plan) {
|
|
|
155
228
|
bad('a survivor must target a .md or .txt file');
|
|
156
229
|
}
|
|
157
230
|
}
|
|
231
|
+
// A link-fix names a kept row, or a file the plan neither scans nor writes
|
|
232
|
+
// (T14194), which must carry the bytes it was planned against.
|
|
233
|
+
const kept = new Set(plan.rows.filter((r) => r.disposition === 'keep').map((r) => r.path));
|
|
234
|
+
const touched = new Set(plan.rows.flatMap((r) => [r.path, r.target ?? r.path]));
|
|
235
|
+
// A repo-base fix (T14196) names a file outside the root that policy lets
|
|
236
|
+
// modernize edit; changelogs, changesets and CLEO state never are.
|
|
237
|
+
const rootInRepo = plan.repoRoot === undefined
|
|
238
|
+
? null
|
|
239
|
+
: relative(realpathSync(plan.repoRoot), realpathSync(plan.root)).split(sep).join('/');
|
|
240
|
+
for (const fix of plan.linkFixes ?? []) {
|
|
241
|
+
const ok = plan.mode === 'tree' &&
|
|
242
|
+
(fix.base === 'repo'
|
|
243
|
+
? fix.sha256 !== undefined &&
|
|
244
|
+
rootInRepo !== null &&
|
|
245
|
+
rootInRepo !== '' &&
|
|
246
|
+
!`${fix.path}/`.startsWith(`${rootInRepo}/`) &&
|
|
247
|
+
repoLinkFixAllowed(fix.path)
|
|
248
|
+
: kept.has(fix.path) || (!touched.has(fix.path) && fix.sha256 !== undefined));
|
|
249
|
+
if (!ok) {
|
|
250
|
+
// @sync-invariant none:input-shape a link fix for a file the plan moves or does not vouch for is refused before any write
|
|
251
|
+
throw new DocsModernizeUnsafeError(`link-fix ${fix.path}: only a kept file, an unscanned file with its sha256, or (base repo) an editable markdown file outside the root with its sha256, of a tree plan`);
|
|
252
|
+
}
|
|
253
|
+
}
|
|
158
254
|
}
|
|
159
255
|
/**
|
|
160
256
|
* Parse and check an `--overrides` file.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"guard.js","sourceRoot":"","sources":["../../../src/docs/modernize/guard.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAMxE,OAAO,EACL,4BAA4B,EAC5B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,uCAAuC,CAAC;
|
|
1
|
+
{"version":3,"file":"guard.js","sourceRoot":"","sources":["../../../src/docs/modernize/guard.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,WAAW,CAAC;AAMxE,OAAO,EACL,4BAA4B,EAC5B,uBAAuB,EACvB,0BAA0B,GAC3B,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAEhD,yDAAyD;AACzD,MAAM,OAAO,wBAAyB,SAAQ,KAAK;IACjD,oCAAoC;IAC3B,IAAI,GAAG,oBAAoB,CAAC;CACtC;AAED,0EAA0E;AAC1E,SAAS,MAAM,CAAC,MAAc,EAAE,KAAa;IAC3C,MAAM,GAAG,GAAG,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACpC,OAAO,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,sFAAsF;AACtF,SAAS,aAAa,CAAC,CAAS;IAC9B,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,MAAM,IAAI,GAAa,EAAE,CAAC;IAC1B,OAAO,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QAC5B,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;QAChC,IAAI,MAAM,KAAK,OAAO;YAAE,MAAM;QAC9B,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC;QAC/C,OAAO,GAAG,MAAM,CAAC;IACnB,CAAC;IACD,OAAO,OAAO,CAAC,YAAY,CAAC,OAAO,CAAC,EAAE,GAAG,IAAI,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,GAAW;IAChD,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QAC/E,iHAAiH;QACjH,MAAM,IAAI,wBAAwB,CAChC,eAAe,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,gCAAgC,CACnE,CAAC;IACJ,CAAC;IACD,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IACpD,MAAM,QAAQ,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACpC,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,aAAa,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC;QAC1C,yHAAyH;QACzH,MAAM,IAAI,wBAAwB,CAAC,eAAe,GAAG,sBAAsB,IAAI,EAAE,CAAC,CAAC;IACrF,CAAC;IACD,IAAI,UAAU,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CAAC;QACvD,2HAA2H;QAC3H,MAAM,IAAI,wBAAwB,CAAC,eAAe,GAAG,gBAAgB,CAAC,CAAC;IACzE,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,uBAAuB,CAAC,WAAmB,EAAE,YAAoB;IAC/E,IAAI,OAAO,CAAC,WAAW,CAAC,KAAK,OAAO,CAAC,YAAY,CAAC;QAAE,OAAO;IAC3D,MAAM,OAAO,GAAG,YAAY,CAAC,WAAW,CAAC,CAAC;IAC1C,MAAM,QAAQ,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;IAC5C,IAAI,OAAO,KAAK,IAAI,IAAI,OAAO,KAAK,QAAQ,EAAE,CAAC;QAC7C,wGAAwG;QACxG,MAAM,IAAI,wBAAwB,CAChC,YAAY,YAAY,qCAAqC,WAAW,GAAG;YACzE,mBAAmB,QAAQ,IAAI,SAAS,OAAO,OAAO,IAAI,SAAS,GAAG,CACzE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,mBAAmB,CACjC,WAAmB,EACnB,IAAY,EACZ,eAAuB,WAAW;IAElC,uBAAuB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACnD,IACE,CAAC,UAAU,CAAC,IAAI,CAAC;QACjB,CAAC,UAAU,CAAC,IAAI,CAAC;QACjB,CAAC,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EACrF,CAAC;QACD,oGAAoG;QACpG,MAAM,IAAI,wBAAwB,CAChC,kBAAkB,IAAI,8BAA8B,WAAW,EAAE;YAC/D,CAAC,YAAY,KAAK,WAAW,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,oBAAoB,YAAY,EAAE,CAAC,CAC3E,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,kBAAkB,CAChC,GAAW,EACX,WAAmB,EACnB,eAAuB,WAAW;IAElC,MAAM,MAAM,GAAG,uBAAuB,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IAClE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,qFAAqF;QACrF,MAAM,IAAI,wBAAwB,CAChC,6CAA6C,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CACpE,CAAC;IACJ,CAAC;IACD,MAAM,IAAI,GAAsB,MAAM,CAAC,IAAI,CAAC;IAC5C,eAAe,CAAC,IAAI,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IACjD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAuB,EACvB,WAAmB,EACnB,eAAuB,WAAW;IAElC,mBAAmB,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC1D,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9B,IAAI,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,IAAI,GAAG,CAAC,WAAW,KAAK,QAAQ,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC;YAC/E,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC;IACH,CAAC;IACD,MAAM,SAAS,GAAG,CAAC,IAAI,CAAC,SAAS,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC;IAC1E,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC;QAAE,cAAc,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC9F,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;QACvC,IAAI,GAAG,CAAC,IAAI,KAAK,MAAM;YAAE,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;;YAClD,QAAQ,CAAC,IAAI,CAAC,QAAQ,IAAI,EAAE,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAC/C,CAAC;AACH,CAAC;AAED;;;;;;;;;;GAUG;AACH,SAAS,cAAc,CACrB,WAAmB,EACnB,IAAY,EACZ,QAA4B,EAC5B,YAAoB;IAEpB,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,sGAAsG;QACtG,MAAM,IAAI,wBAAwB,CAAC,sDAAsD,CAAC,CAAC;IAC7F,CAAC;IACD,mBAAmB,CAAC,WAAW,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;IACzD,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACxD,iHAAiH;QACjH,MAAM,IAAI,wBAAwB,CAChC,YAAY,QAAQ,qCAAqC,IAAI,EAAE,CAChE,CAAC;IACJ,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,qBAAqB,CACnC,GAAW,EACX,WAAmB,EACnB,eAAuB,WAAW;IAElC,MAAM,MAAM,GAAG,0BAA0B,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,2FAA2F;QAC3F,MAAM,IAAI,wBAAwB,CAChC,8CAA8C,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CACrE,CAAC;IACJ,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC;IAC5B,mBAAmB,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC7D,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,IAAI,KAAK,MAAM,CAAC,EAAE,CAAC;QACjD,cAAc,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,QAAQ,EAAE,YAAY,CAAC,CAAC;IAC5E,CAAC;IACD,KAAK,MAAM,EAAE,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;QAC7B,IAAI,CAAC,EAAE,CAAC,IAAI;YAAE,SAAS;QACvB,IAAI,EAAE,CAAC,IAAI,KAAK,MAAM;YAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,IAAI,EAAE,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;;YAC7D,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,CAAC;IACvC,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,oBAAoB,CAAC,IAAuB;IAC1D,MAAM,SAAS,GAAG,IAAI,GAAG,CACvB,IAAI,CAAC,IAAI;SACN,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,CAAC,WAAW,KAAK,QAAQ,CAAC;SACrE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CACtB,CAAC;IACF,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QAC5B,MAAM,GAAG,GAAG,CAAC,GAAW,EAAS,EAAE;YACjC,wFAAwF;YACxF,MAAM,IAAI,wBAAwB,CAAC,YAAY,GAAG,CAAC,IAAI,KAAK,GAAG,EAAE,CAAC,CAAC;QACrE,CAAC,CAAC;QACF,IAAI,GAAG,CAAC,WAAW,KAAK,YAAY,IAAI,GAAG,CAAC,WAAW,KAAK,QAAQ,EAAE,CAAC;YACrE,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,CAAC;gBAC9C,GAAG,CAAC,GAAG,GAAG,CAAC,WAAW,qCAAqC,GAAG,CAAC,MAAM,IAAI,MAAM,GAAG,CAAC,CAAC;YACtF,CAAC;QACH,CAAC;aAAM,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YACtC,IAAI,GAAG,CAAC,WAAW,KAAK,MAAM,IAAI,GAAG,CAAC,MAAM,KAAK,GAAG,CAAC,IAAI;gBACvD,GAAG,CAAC,+BAA+B,CAAC,CAAC;YACvC,IAAI,CAAC,GAAG,CAAC,MAAM,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC;gBACjD,GAAG,CAAC,2CAA2C,CAAC,CAAC;QACrD,CAAC;IACH,CAAC;IACD,2EAA2E;IAC3E,+DAA+D;IAC/D,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,WAAW,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3F,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAChF,0EAA0E;IAC1E,mEAAmE;IACnE,MAAM,UAAU,GACd,IAAI,CAAC,QAAQ,KAAK,SAAS;QACzB,CAAC,CAAC,IAAI;QACN,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC1F,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;QACvC,MAAM,EAAE,GACN,IAAI,CAAC,IAAI,KAAK,MAAM;YACpB,CAAC,GAAG,CAAC,IAAI,KAAK,MAAM;gBAClB,CAAC,CAAC,GAAG,CAAC,MAAM,KAAK,SAAS;oBACxB,UAAU,KAAK,IAAI;oBACnB,UAAU,KAAK,EAAE;oBACjB,CAAC,GAAG,GAAG,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,GAAG,UAAU,GAAG,CAAC;oBAC5C,kBAAkB,CAAC,GAAG,CAAC,IAAI,CAAC;gBAC9B,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC;QAClF,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,0HAA0H;YAC1H,MAAM,IAAI,wBAAwB,CAChC,YAAY,GAAG,CAAC,IAAI,kJAAkJ,CACvK,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CAAC,GAAW;IACjD,MAAM,MAAM,GAAG,4BAA4B,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;IACvE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,0FAA0F;QAC1F,MAAM,IAAI,wBAAwB,CAChC,6CAA6C,MAAM,CAAC,KAAK,CAAC,OAAO,EAAE,CACpE,CAAC;IACJ,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC"}
|
|
@@ -11,7 +11,7 @@ export { applyDocsModernize, DocsModernizeBlobError, DocsModernizeDirtyError, Do
|
|
|
11
11
|
export { DocsModernizeOverrideError, planDocsModernize } from './plan.js';
|
|
12
12
|
/** Parameters of `docs.modernize`. */
|
|
13
13
|
export interface RunDocsModernizeParams {
|
|
14
|
-
/** Folder to modernize (relative to the
|
|
14
|
+
/** Folder to modernize (relative to the invoking checkout, or absolute). Required unless `rollback`. */
|
|
15
15
|
readonly path?: string;
|
|
16
16
|
/** Execute the plan; otherwise the run is a dry run. */
|
|
17
17
|
readonly apply?: boolean;
|
|
@@ -31,6 +31,8 @@ export interface RunDocsModernizeParams {
|
|
|
31
31
|
readonly storeOnly?: boolean;
|
|
32
32
|
/** Apply even when the root is not a clean git checkout. */
|
|
33
33
|
readonly allowDirty?: boolean;
|
|
34
|
+
/** Rewrite relative links to planned docs as `[[slug]]` wikilinks (opt-in; default keeps markdown links). */
|
|
35
|
+
readonly wikilinks?: boolean;
|
|
34
36
|
/** Modernize the docs already in the store (re-kind, re-slug, ADR numbers) instead of a folder. */
|
|
35
37
|
readonly store?: boolean;
|
|
36
38
|
}
|
|
@@ -48,12 +50,19 @@ export interface RunDocsModernizeResult {
|
|
|
48
50
|
/**
|
|
49
51
|
* Run `cleo docs modernize`.
|
|
50
52
|
*
|
|
53
|
+
* The store, publication ledger, journal and backups live at `projectRoot`;
|
|
54
|
+
* the folder, plan, overrides and `--out` paths resolve against
|
|
55
|
+
* `checkoutRoot`, the checkout the command was started from (a CLEO
|
|
56
|
+
* worktree, T14188).
|
|
57
|
+
*
|
|
51
58
|
* @param projectRoot - Project root.
|
|
52
59
|
* @param params - Path and mode flags.
|
|
53
|
-
* @param overrides - System One and clock overrides (tests).
|
|
60
|
+
* @param overrides - Invoking checkout, plus System One and clock overrides (tests).
|
|
54
61
|
* @returns What ran, with its plan and/or receipt.
|
|
55
62
|
*/
|
|
56
63
|
export declare function runDocsModernize(projectRoot: string, params: RunDocsModernizeParams, overrides?: Pick<PlanDocsModernizeOptions, 'mode' | 'decide' | 'now'> & {
|
|
57
64
|
readonly allowDirty?: boolean;
|
|
65
|
+
/** The checkout the command was started from (default: the project root). */
|
|
66
|
+
readonly checkoutRoot?: string;
|
|
58
67
|
}): Promise<RunDocsModernizeResult>;
|
|
59
68
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs/modernize/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,KAAK,EAEV,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EAAE,KAAK,wBAAwB,EAAqB,MAAM,WAAW,CAAC;AAE7E,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE1E,sCAAsC;AACtC,MAAM,WAAW,sBAAsB;IACrC,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs/modernize/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAIH,OAAO,KAAK,EAEV,iBAAiB,EACjB,oBAAoB,EACrB,MAAM,qBAAqB,CAAC;AAI7B,OAAO,EAAE,KAAK,wBAAwB,EAAqB,MAAM,WAAW,CAAC;AAE7E,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE1E,sCAAsC;AACtC,MAAM,WAAW,sBAAsB;IACrC,wGAAwG;IACxG,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,wDAAwD;IACxD,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IACzB,kEAAkE;IAClE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,wCAAwC;IACxC,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,CAAC;IACtB,sCAAsC;IACtC,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAC3B,kCAAkC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,6EAA6E;IAC7E,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,uEAAuE;IACvE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,4DAA4D;IAC5D,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,6GAA6G;IAC7G,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,mGAAmG;IACnG,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,0CAA0C;AAC1C,MAAM,WAAW,sBAAsB;IACrC,gBAAgB;IAChB,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,OAAO,GAAG,UAAU,CAAC;IAChD,oCAAoC;IACpC,QAAQ,CAAC,IAAI,EAAE,iBAAiB,GAAG,IAAI,CAAC;IACxC,sDAAsD;IACtD,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,GAAG,IAAI,CAAC;CAC/C;AAED;;;;;;;;;;;;GAYG;AACH,wBAAsB,gBAAgB,CACpC,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,sBAAsB,EAC9B,SAAS,GAAE,IAAI,CAAC,wBAAwB,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC,GAAG;IACrE,QAAQ,CAAC,UAAU,CAAC,EAAE,OAAO,CAAC;IAC9B,6EAA6E;IAC7E,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAC3B,GACL,OAAO,CAAC,sBAAsB,CAAC,CAuEjC"}
|
|
@@ -9,24 +9,31 @@ import { existsSync, readFileSync } from 'node:fs';
|
|
|
9
9
|
import { isAbsolute, resolve } from 'node:path';
|
|
10
10
|
import { writeFileAtomic } from '../../tools/fs.js';
|
|
11
11
|
import { applyDocsModernize, DocsModernizeReceiptError, rollbackDocsModernize } from './apply.js';
|
|
12
|
-
import { parseModernizeOverrides, parseModernizePlan } from './guard.js';
|
|
12
|
+
import { assertCheckoutOfProject, parseModernizeOverrides, parseModernizePlan } from './guard.js';
|
|
13
13
|
import { planDocsModernize } from './plan.js';
|
|
14
14
|
export { applyDocsModernize, DocsModernizeBlobError, DocsModernizeDirtyError, DocsModernizeReceiptError, DocsModernizeStaleError, modernizeReceiptPath, readDocsModernizeReceipt, rollbackDocsModernize, } from './apply.js';
|
|
15
15
|
export { DocsModernizeOverrideError, planDocsModernize } from './plan.js';
|
|
16
16
|
/**
|
|
17
17
|
* Run `cleo docs modernize`.
|
|
18
18
|
*
|
|
19
|
+
* The store, publication ledger, journal and backups live at `projectRoot`;
|
|
20
|
+
* the folder, plan, overrides and `--out` paths resolve against
|
|
21
|
+
* `checkoutRoot`, the checkout the command was started from (a CLEO
|
|
22
|
+
* worktree, T14188).
|
|
23
|
+
*
|
|
19
24
|
* @param projectRoot - Project root.
|
|
20
25
|
* @param params - Path and mode flags.
|
|
21
|
-
* @param overrides - System One and clock overrides (tests).
|
|
26
|
+
* @param overrides - Invoking checkout, plus System One and clock overrides (tests).
|
|
22
27
|
* @returns What ran, with its plan and/or receipt.
|
|
23
28
|
*/
|
|
24
29
|
export async function runDocsModernize(projectRoot, params, overrides = {}) {
|
|
30
|
+
const { checkoutRoot = projectRoot, ...judge } = overrides;
|
|
31
|
+
assertCheckoutOfProject(projectRoot, checkoutRoot);
|
|
25
32
|
if (params.rollback) {
|
|
26
|
-
const receipt = await rollbackDocsModernize(projectRoot, params.rollback,
|
|
33
|
+
const receipt = await rollbackDocsModernize(projectRoot, params.rollback, judge.now, checkoutRoot);
|
|
27
34
|
return { mode: 'rollback', plan: null, planPath: null, receipt };
|
|
28
35
|
}
|
|
29
|
-
const abs = (p) => (isAbsolute(p) ? p : resolve(
|
|
36
|
+
const abs = (p) => (isAbsolute(p) ? p : resolve(checkoutRoot, p));
|
|
30
37
|
let plan;
|
|
31
38
|
if (params.planFile) {
|
|
32
39
|
const file = abs(params.planFile);
|
|
@@ -34,11 +41,11 @@ export async function runDocsModernize(projectRoot, params, overrides = {}) {
|
|
|
34
41
|
// @sync-invariant none:input-shape a missing plan file is refused before any write
|
|
35
42
|
throw new DocsModernizeReceiptError(`plan file ${params.planFile} does not exist`);
|
|
36
43
|
}
|
|
37
|
-
plan = parseModernizePlan(readFileSync(file, 'utf-8'), projectRoot);
|
|
44
|
+
plan = parseModernizePlan(readFileSync(file, 'utf-8'), projectRoot, checkoutRoot);
|
|
38
45
|
}
|
|
39
46
|
else if (params.store) {
|
|
40
47
|
const { planDocsStoreModernize } = await import('./store.js');
|
|
41
|
-
plan = await planDocsStoreModernize({ projectRoot, ...
|
|
48
|
+
plan = await planDocsStoreModernize({ projectRoot, ...judge });
|
|
42
49
|
}
|
|
43
50
|
else {
|
|
44
51
|
if (!params.path || !existsSync(abs(params.path))) {
|
|
@@ -61,7 +68,8 @@ export async function runDocsModernize(projectRoot, params, overrides = {}) {
|
|
|
61
68
|
overrides: reviewed,
|
|
62
69
|
kind: params.kind,
|
|
63
70
|
storeOnly: params.storeOnly,
|
|
64
|
-
|
|
71
|
+
repoRoot: checkoutRoot,
|
|
72
|
+
...judge,
|
|
65
73
|
});
|
|
66
74
|
}
|
|
67
75
|
let planPath = null;
|
|
@@ -73,14 +81,16 @@ export async function runDocsModernize(projectRoot, params, overrides = {}) {
|
|
|
73
81
|
return { mode: 'dry-run', plan, planPath, receipt: null };
|
|
74
82
|
if (plan.mode === 'store') {
|
|
75
83
|
const { applyDocsStoreModernize } = await import('./store.js');
|
|
76
|
-
const receipt = await applyDocsStoreModernize(plan, projectRoot,
|
|
84
|
+
const receipt = await applyDocsStoreModernize(plan, projectRoot, judge.now);
|
|
77
85
|
return { mode: 'apply', plan, planPath, receipt };
|
|
78
86
|
}
|
|
79
87
|
const receipt = await applyDocsModernize({
|
|
80
88
|
plan,
|
|
81
89
|
projectRoot,
|
|
82
|
-
now:
|
|
83
|
-
allowDirty: params.allowDirty === true ||
|
|
90
|
+
now: judge.now,
|
|
91
|
+
allowDirty: params.allowDirty === true || judge.allowDirty === true,
|
|
92
|
+
wikilinks: params.wikilinks === true,
|
|
93
|
+
checkoutRoot,
|
|
84
94
|
});
|
|
85
95
|
return { mode: 'apply', plan, planPath, receipt };
|
|
86
96
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/docs/modernize/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMhD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAClG,OAAO,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/docs/modernize/index.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAMhD,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAClG,OAAO,EAAE,uBAAuB,EAAE,uBAAuB,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAC;AAClG,OAAO,EAAiC,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE7E,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,uBAAuB,EACvB,oBAAoB,EACpB,wBAAwB,EACxB,qBAAqB,GACtB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,0BAA0B,EAAE,iBAAiB,EAAE,MAAM,WAAW,CAAC;AA0C1E;;;;;;;;;;;;GAYG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,WAAmB,EACnB,MAA8B,EAC9B,YAII,EAAE;IAEN,MAAM,EAAE,YAAY,GAAG,WAAW,EAAE,GAAG,KAAK,EAAE,GAAG,SAAS,CAAC;IAC3D,uBAAuB,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IACnD,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,MAAM,OAAO,GAAG,MAAM,qBAAqB,CACzC,WAAW,EACX,MAAM,CAAC,QAAQ,EACf,KAAK,CAAC,GAAG,EACT,YAAY,CACb,CAAC;QACF,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC;IACnE,CAAC;IACD,MAAM,GAAG,GAAG,CAAC,CAAS,EAAU,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC,CAAC,CAAC;IAClF,IAAI,IAAuB,CAAC;IAC5B,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;QACpB,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAClC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YACtB,mFAAmF;YACnF,MAAM,IAAI,yBAAyB,CAAC,aAAa,MAAM,CAAC,QAAQ,iBAAiB,CAAC,CAAC;QACrF,CAAC;QACD,IAAI,GAAG,kBAAkB,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IACpF,CAAC;SAAM,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACxB,MAAM,EAAE,sBAAsB,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,GAAG,MAAM,sBAAsB,CAAC,EAAE,WAAW,EAAE,GAAG,KAAK,EAAE,CAAC,CAAC;IACjE,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,MAAM,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YAClD,wFAAwF;YACxF,MAAM,IAAI,yBAAyB,CACjC,kBAAkB,MAAM,CAAC,IAAI,IAAI,QAAQ,iBAAiB,CAC3D,CAAC;QACJ,CAAC;QACD,IAAI,QAA4C,CAAC;QACjD,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;YACrB,MAAM,IAAI,GAAG,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;YACnC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;gBACtB,wFAAwF;gBACxF,MAAM,IAAI,yBAAyB,CAAC,kBAAkB,MAAM,CAAC,SAAS,iBAAiB,CAAC,CAAC;YAC3F,CAAC;YACD,QAAQ,GAAG,uBAAuB,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,CAAC;QAClE,CAAC;QACD,IAAI,GAAG,MAAM,iBAAiB,CAAC;YAC7B,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;YACtB,WAAW;YACX,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,SAAS,EAAE,QAAQ;YACnB,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,QAAQ,EAAE,YAAY;YACtB,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;IACD,IAAI,QAAQ,GAAkB,IAAI,CAAC;IACnC,IAAI,MAAM,CAAC,GAAG,EAAE,CAAC;QACf,QAAQ,GAAG,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAC3B,MAAM,eAAe,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IAC3F,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,KAAK;QAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC;IAC7E,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC1B,MAAM,EAAE,uBAAuB,EAAE,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,CAAC;QAC/D,MAAM,OAAO,GAAG,MAAM,uBAAuB,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QAC5E,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpD,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,kBAAkB,CAAC;QACvC,IAAI;QACJ,WAAW;QACX,GAAG,EAAE,KAAK,CAAC,GAAG;QACd,UAAU,EAAE,MAAM,CAAC,UAAU,KAAK,IAAI,IAAI,KAAK,CAAC,UAAU,KAAK,IAAI;QACnE,SAAS,EAAE,MAAM,CAAC,SAAS,KAAK,IAAI;QACpC,YAAY;KACb,CAAC,CAAC;IACH,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC;AACpD,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../../src/docs/modernize/plan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;
|
|
1
|
+
{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../../src/docs/modernize/plan.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAMH,OAAO,KAAK,EACV,eAAe,EAKf,sBAAsB,EACtB,iBAAiB,EAElB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAqB7D,4EAA4E;AAC5E,eAAO,MAAM,sBAAsB,EAAE,WAAW,CAAC,MAAM,CAKrD,CAAC;AAEH,uCAAuC;AACvC,eAAO,MAAM,oBAAoB,EAAE,SAAS,MAAM,EAAoB,CAAC;AAEvE,6CAA6C;AAC7C,MAAM,WAAW,wBAAwB;IACvC,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,4DAA4D;IAC5D,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,kCAAkC;IAClC,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,4EAA4E;IAC5E,QAAQ,CAAC,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACjC,uDAAuD;IACvD,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAChC,8BAA8B;IAC9B,QAAQ,CAAC,GAAG,CAAC,EAAE,MAAM,IAAI,CAAC;IAC1B,4EAA4E;IAC5E,QAAQ,CAAC,SAAS,CAAC,EAAE,sBAAsB,CAAC;IAC5C,yEAAyE;IACzE,QAAQ,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC;IACvB,uEAAuE;IACvE,QAAQ,CAAC,SAAS,CAAC,EAAE,OAAO,CAAC;IAC7B,uEAAuE;IACvE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAQD;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAM1D;AAsID,oEAAoE;AACpE,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,eAAe,EAAE,GAAG,MAAM,CAIlF;AA2FD;;;;;GAKG;AACH,wBAAsB,iBAAiB,CACrC,OAAO,EAAE,wBAAwB,GAChC,OAAO,CAAC,iBAAiB,CAAC,CAmN5B;AAyJD,kEAAkE;AAClE,qBAAa,0BAA2B,SAAQ,KAAK;IACnD,oCAAoC;IACpC,QAAQ,CAAC,IAAI,0BAA0B;CACxC"}
|
|
@@ -23,13 +23,16 @@
|
|
|
23
23
|
* @epic T14106
|
|
24
24
|
*/
|
|
25
25
|
import { execFileSync } from 'node:child_process';
|
|
26
|
-
import {
|
|
26
|
+
import { createHash } from 'node:crypto';
|
|
27
|
+
import { readFileSync, realpathSync } from 'node:fs';
|
|
28
|
+
import { extname, join, relative, resolve, sep } from 'node:path';
|
|
27
29
|
import { DocKindRegistry } from '@cleocode/contracts/docs-taxonomy.js';
|
|
30
|
+
import { discoveryEnv } from '../../git/work-tree.js';
|
|
28
31
|
import { createAttachmentStore } from '../../store/attachment-store.js';
|
|
29
32
|
import { docNameViolation } from '../doc-name-rule.js';
|
|
30
33
|
import { DEFAULT_EXCLUDE_DIRS, scanDirectory } from '../import/scanner.js';
|
|
31
34
|
import { judgeDocKind, judgeDocMerge, resolveModernizeJudgeSettings } from './judge.js';
|
|
32
|
-
import { classifyDocByRules, docSimilarity, folderKind, MODERNIZE_CLASSIFY_FLOOR, MODERNIZE_MERGE_APART, MODERNIZE_MERGE_SURE, readTitle, stableSlugFor, versionOf, } from './rules.js';
|
|
35
|
+
import { classifyDocByRules, docSimilarity, finalPaths, folderKind, MODERNIZE_CLASSIFY_FLOOR, MODERNIZE_MERGE_APART, MODERNIZE_MERGE_SURE, markdownLinkFixes, readTitle, repoLinkFixAllowed, stableSlugFor, versionOf, } from './rules.js';
|
|
33
36
|
/** Folders modernize never descends into, beyond the scanner's defaults. */
|
|
34
37
|
export const MODERNIZE_EXCLUDE_DIRS = new Set([
|
|
35
38
|
...DEFAULT_EXCLUDE_DIRS,
|
|
@@ -107,6 +110,73 @@ function findRefs(repoRoot, root, paths) {
|
|
|
107
110
|
}
|
|
108
111
|
return out;
|
|
109
112
|
}
|
|
113
|
+
/**
|
|
114
|
+
* `link-fix` rows for tracked markdown OUTSIDE the modernize root whose
|
|
115
|
+
* relative links point at files the plan moves (T14196): the repo README,
|
|
116
|
+
* AGENTS.md, package READMEs. Read-only. Paths are relative to `repoRoot`;
|
|
117
|
+
* each row pins the file's bytes. Changelogs, changesets and CLEO, vendored
|
|
118
|
+
* or built folders are never edited ({@link repoLinkFixAllowed}).
|
|
119
|
+
*
|
|
120
|
+
* @param repoRoot - Repository checkout root.
|
|
121
|
+
* @param root - Absolute modernize root.
|
|
122
|
+
* @param finalPathOf - Root-relative old path → final path.
|
|
123
|
+
* @returns The rows, in file then link order.
|
|
124
|
+
*/
|
|
125
|
+
function repoLinkFixes(repoRoot, root, finalPathOf) {
|
|
126
|
+
let prefix;
|
|
127
|
+
try {
|
|
128
|
+
prefix = relative(realpathSync(repoRoot), realpathSync(root)).split(sep).join('/');
|
|
129
|
+
}
|
|
130
|
+
catch {
|
|
131
|
+
return [];
|
|
132
|
+
}
|
|
133
|
+
if (prefix === '' || prefix.startsWith('..'))
|
|
134
|
+
return [];
|
|
135
|
+
const moved = [...finalPathOf].filter(([from, to]) => from !== to);
|
|
136
|
+
if (moved.length === 0)
|
|
137
|
+
return [];
|
|
138
|
+
const finalRepo = new Map(moved.map(([from, to]) => [`${prefix}/${from}`, `${prefix}/${to}`]));
|
|
139
|
+
const names = [...new Set(moved.map(([from]) => from.split('/').pop() ?? from))];
|
|
140
|
+
let stdout = '';
|
|
141
|
+
try {
|
|
142
|
+
stdout = execFileSync('git', [
|
|
143
|
+
'grep',
|
|
144
|
+
'-l',
|
|
145
|
+
'-F',
|
|
146
|
+
'-I',
|
|
147
|
+
...names.flatMap((n) => ['-e', n]),
|
|
148
|
+
'--',
|
|
149
|
+
'*.md',
|
|
150
|
+
`:!${prefix}/**`,
|
|
151
|
+
], {
|
|
152
|
+
cwd: repoRoot,
|
|
153
|
+
env: discoveryEnv(),
|
|
154
|
+
encoding: 'utf-8',
|
|
155
|
+
maxBuffer: 64 * 1024 * 1024,
|
|
156
|
+
stdio: ['ignore', 'pipe', 'ignore'],
|
|
157
|
+
});
|
|
158
|
+
}
|
|
159
|
+
catch {
|
|
160
|
+
return []; // exit 1 = no match; not a repo = nothing to fix
|
|
161
|
+
}
|
|
162
|
+
const fixes = [];
|
|
163
|
+
for (const path of stdout.split('\n').filter(Boolean).sort()) {
|
|
164
|
+
if (!repoLinkFixAllowed(path))
|
|
165
|
+
continue;
|
|
166
|
+
let content;
|
|
167
|
+
try {
|
|
168
|
+
content = readFileSync(join(repoRoot, path), 'utf-8');
|
|
169
|
+
}
|
|
170
|
+
catch {
|
|
171
|
+
continue;
|
|
172
|
+
}
|
|
173
|
+
const sha256 = createHash('sha256').update(content).digest('hex');
|
|
174
|
+
for (const fix of markdownLinkFixes(content, path, finalRepo)) {
|
|
175
|
+
fixes.push({ kind: 'link-fix', base: 'repo', path, ...fix, sha256 });
|
|
176
|
+
}
|
|
177
|
+
}
|
|
178
|
+
return fixes;
|
|
179
|
+
}
|
|
110
180
|
/** The folder, relative to the root, that a kind's docs live in. */
|
|
111
181
|
export function kindFolder(kind, kinds) {
|
|
112
182
|
const publishDir = kinds.find((k) => k.kind === kind)?.publishDir ?? kind;
|
|
@@ -374,7 +444,19 @@ export async function planDocsModernize(options) {
|
|
|
374
444
|
],
|
|
375
445
|
};
|
|
376
446
|
}
|
|
377
|
-
|
|
447
|
+
// Markdown under the root that the plan does not scan (an --exclude'd
|
|
448
|
+
// folder) is read, never planned: its links to moved files become
|
|
449
|
+
// link-fix rows (T14194).
|
|
450
|
+
let outOfScope = [];
|
|
451
|
+
if ((options.exclude ?? []).length > 0) {
|
|
452
|
+
const scanned = new Set(files.map((f) => f.relPath));
|
|
453
|
+
outOfScope = (await scanDirectory({
|
|
454
|
+
root: options.root,
|
|
455
|
+
extensions: MODERNIZE_EXTENSIONS,
|
|
456
|
+
excludeDirs: MODERNIZE_EXCLUDE_DIRS,
|
|
457
|
+
})).filter((f) => !scanned.has(f.relPath));
|
|
458
|
+
}
|
|
459
|
+
return finishPlan(options, kinds, rows, files, outOfScope);
|
|
378
460
|
}
|
|
379
461
|
/** A store-only row: ingest the file as is, owned by its task, without a slug. */
|
|
380
462
|
function storeOnlyRow(c) {
|
|
@@ -395,12 +477,13 @@ function storeOnlyRow(c) {
|
|
|
395
477
|
};
|
|
396
478
|
}
|
|
397
479
|
/** Apply overrides, add links, category and refs, sort and count. */
|
|
398
|
-
function finishPlan(options, kinds, coreRows, files) {
|
|
480
|
+
function finishPlan(options, kinds, coreRows, files, outOfScope = []) {
|
|
399
481
|
const overrides = options.overrides ?? {};
|
|
400
482
|
const moved = options.storeOnly
|
|
401
483
|
? []
|
|
402
484
|
: coreRows.filter((r) => r.disposition !== 'keep' || overrides[r.path]).map((r) => r.path);
|
|
403
|
-
const
|
|
485
|
+
const repoRoot = options.repoRoot ?? options.projectRoot;
|
|
486
|
+
const refs = findRefs(repoRoot, options.root, moved);
|
|
404
487
|
const scanned = new Set(files.map((f) => f.relPath));
|
|
405
488
|
const rows = coreRows.map((row) => {
|
|
406
489
|
const override = overrides[row.path];
|
|
@@ -443,12 +526,37 @@ function finishPlan(options, kinds, coreRows, files) {
|
|
|
443
526
|
};
|
|
444
527
|
for (const row of rows)
|
|
445
528
|
counts[row.disposition] += 1;
|
|
529
|
+
// A kept file, a file the plan does not scan, and a tracked markdown file
|
|
530
|
+
// outside the root stay byte-identical except for hrefs whose targets
|
|
531
|
+
// move; each such edit is a plan row, so --apply never does more than the
|
|
532
|
+
// dry run showed (T14185, T14194, T14196).
|
|
533
|
+
const linkFixes = [];
|
|
534
|
+
if (!options.storeOnly) {
|
|
535
|
+
const finalPathOf = finalPaths(rows);
|
|
536
|
+
const contentOf = new Map(files.map((f) => [f.relPath, f.content]));
|
|
537
|
+
for (const row of rows) {
|
|
538
|
+
if (row.disposition !== 'keep')
|
|
539
|
+
continue;
|
|
540
|
+
for (const fix of markdownLinkFixes(contentOf.get(row.path) ?? '', row.path, finalPathOf)) {
|
|
541
|
+
linkFixes.push({ kind: 'link-fix', path: row.path, ...fix });
|
|
542
|
+
}
|
|
543
|
+
}
|
|
544
|
+
for (const file of outOfScope) {
|
|
545
|
+
for (const fix of markdownLinkFixes(file.content, file.relPath, finalPathOf)) {
|
|
546
|
+
linkFixes.push({ kind: 'link-fix', path: file.relPath, ...fix, sha256: file.contentSha });
|
|
547
|
+
}
|
|
548
|
+
}
|
|
549
|
+
linkFixes.push(...repoLinkFixes(repoRoot, options.root, finalPathOf));
|
|
550
|
+
}
|
|
551
|
+
const hasRepoFixes = linkFixes.some((f) => f.base === 'repo');
|
|
446
552
|
return {
|
|
447
553
|
root: options.root,
|
|
448
554
|
generatedAt: (options.now?.() ?? new Date()).toISOString(),
|
|
449
555
|
rows,
|
|
450
556
|
counts,
|
|
451
557
|
mode: options.storeOnly ? 'store-only' : 'tree',
|
|
558
|
+
...(linkFixes.length > 0 ? { linkFixes } : {}),
|
|
559
|
+
...(hasRepoFixes ? { repoRoot: resolve(repoRoot) } : {}),
|
|
452
560
|
};
|
|
453
561
|
}
|
|
454
562
|
/**
|