@hominis/fireforge 0.51.0 → 0.53.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (254) hide show
  1. package/CHANGELOG.md +46 -0
  2. package/dist/build-info.json +4 -4
  3. package/dist/src/commands/bootstrap.js +2 -3
  4. package/dist/src/commands/build-prelock.d.ts +3 -3
  5. package/dist/src/commands/build-prelock.js +3 -3
  6. package/dist/src/commands/build.js +4 -0
  7. package/dist/src/commands/declarations-report.d.ts +9 -3
  8. package/dist/src/commands/declarations-report.js +18 -11
  9. package/dist/src/commands/discard.js +3 -3
  10. package/dist/src/commands/doctor-furnace-config-sync.js +4 -4
  11. package/dist/src/commands/doctor-furnace.js +5 -5
  12. package/dist/src/commands/export-adopt-check.d.ts +5 -6
  13. package/dist/src/commands/export-adopt-check.js +5 -6
  14. package/dist/src/commands/export-flow.js +6 -9
  15. package/dist/src/commands/export-staged-registration.d.ts +4 -4
  16. package/dist/src/commands/export-staged-registration.js +4 -4
  17. package/dist/src/commands/forward-import-remedy.d.ts +2 -3
  18. package/dist/src/commands/forward-import-remedy.js +2 -3
  19. package/dist/src/commands/furnace/create-dry-run.d.ts +2 -2
  20. package/dist/src/commands/furnace/deploy-fragment-includers.d.ts +2 -2
  21. package/dist/src/commands/furnace/deploy-fragment-includers.js +2 -2
  22. package/dist/src/commands/furnace/index.js +2 -2
  23. package/dist/src/commands/lint.js +4 -4
  24. package/dist/src/commands/patch/compact.js +1 -1
  25. package/dist/src/commands/patch/lint-ignore-from.d.ts +3 -4
  26. package/dist/src/commands/patch/lint-ignore-from.js +3 -4
  27. package/dist/src/commands/patch/move-files-adopt.d.ts +33 -0
  28. package/dist/src/commands/patch/move-files-adopt.js +65 -0
  29. package/dist/src/commands/patch/move-files-create.js +41 -20
  30. package/dist/src/commands/patch/move-files-into.d.ts +18 -0
  31. package/dist/src/commands/patch/move-files-into.js +125 -60
  32. package/dist/src/commands/patch/move-files-retire.d.ts +39 -0
  33. package/dist/src/commands/patch/move-files-retire.js +91 -0
  34. package/dist/src/commands/patch/move-files.d.ts +3 -0
  35. package/dist/src/commands/patch/move-files.js +42 -12
  36. package/dist/src/commands/patch/move-size-tier.d.ts +27 -0
  37. package/dist/src/commands/patch/move-size-tier.js +66 -0
  38. package/dist/src/commands/patch/rename.js +1 -1
  39. package/dist/src/commands/patch/reorder-projection.d.ts +17 -0
  40. package/dist/src/commands/patch/reorder-projection.js +49 -0
  41. package/dist/src/commands/patch/reorder-shift.d.ts +30 -0
  42. package/dist/src/commands/patch/reorder-shift.js +307 -0
  43. package/dist/src/commands/patch/reorder.d.ts +9 -15
  44. package/dist/src/commands/patch/reorder.js +52 -50
  45. package/dist/src/commands/patch/split-plan.d.ts +31 -3
  46. package/dist/src/commands/patch/split-plan.js +36 -12
  47. package/dist/src/commands/patch/split-staged.d.ts +2 -2
  48. package/dist/src/commands/patch/split-staged.js +2 -2
  49. package/dist/src/commands/patch/split.js +18 -5
  50. package/dist/src/commands/patch/staged-dependency-entries.d.ts +9 -1
  51. package/dist/src/commands/patch/staged-dependency-entries.js +32 -4
  52. package/dist/src/commands/patch/staged-dependency-from.js +15 -9
  53. package/dist/src/commands/patch/staged-dependency.js +13 -9
  54. package/dist/src/commands/patch/tier.js +2 -2
  55. package/dist/src/commands/patch-rename-map.d.ts +14 -3
  56. package/dist/src/commands/patch-rename-map.js +21 -3
  57. package/dist/src/commands/re-export-adjacent.d.ts +4 -5
  58. package/dist/src/commands/re-export-lint.d.ts +4 -3
  59. package/dist/src/commands/re-export-lint.js +4 -3
  60. package/dist/src/commands/re-export-preflight.js +1 -2
  61. package/dist/src/commands/re-export-purity-scope.d.ts +1 -1
  62. package/dist/src/commands/re-export-purity-scope.js +13 -7
  63. package/dist/src/commands/re-export-retired-declarations.d.ts +22 -0
  64. package/dist/src/commands/re-export-retired-declarations.js +113 -0
  65. package/dist/src/commands/re-export-single.js +2 -2
  66. package/dist/src/commands/re-export-stale-registrations.d.ts +27 -6
  67. package/dist/src/commands/re-export-stale-registrations.js +65 -21
  68. package/dist/src/commands/re-export.js +4 -0
  69. package/dist/src/commands/rebase/continue.js +3 -3
  70. package/dist/src/commands/register.js +5 -4
  71. package/dist/src/commands/status-output.js +5 -1
  72. package/dist/src/commands/status.js +1 -1
  73. package/dist/src/commands/test-build-furnace.d.ts +1 -2
  74. package/dist/src/commands/test-build-furnace.js +1 -2
  75. package/dist/src/commands/test-build-phase.d.ts +10 -0
  76. package/dist/src/commands/test-build-phase.js +51 -16
  77. package/dist/src/commands/test-control-restore.d.ts +40 -0
  78. package/dist/src/commands/test-control-restore.js +86 -0
  79. package/dist/src/commands/test-dispatch.js +83 -13
  80. package/dist/src/commands/test-multi-verdict.js +1 -0
  81. package/dist/src/commands/test-orchestrate.d.ts +11 -0
  82. package/dist/src/commands/test-orchestrate.js +33 -2
  83. package/dist/src/commands/test-perf-scope.d.ts +1 -1
  84. package/dist/src/commands/test-perf-scope.js +1 -1
  85. package/dist/src/commands/test-prelock.d.ts +7 -8
  86. package/dist/src/commands/test-prelock.js +15 -12
  87. package/dist/src/commands/test-register.js +2 -2
  88. package/dist/src/commands/test-results.d.ts +10 -1
  89. package/dist/src/commands/test-results.js +20 -3
  90. package/dist/src/commands/test-run.d.ts +6 -0
  91. package/dist/src/commands/test-run.js +23 -4
  92. package/dist/src/commands/test-shards.d.ts +7 -3
  93. package/dist/src/commands/test-shards.js +24 -7
  94. package/dist/src/commands/test-stale-gate.d.ts +6 -1
  95. package/dist/src/commands/test-stale-gate.js +47 -2
  96. package/dist/src/commands/test-verdict.d.ts +5 -3
  97. package/dist/src/commands/test.js +14 -1
  98. package/dist/src/commands/token.js +2 -2
  99. package/dist/src/commands/verify.js +1 -1
  100. package/dist/src/commands/watch.js +1 -1
  101. package/dist/src/commands/wire.js +1 -1
  102. package/dist/src/core/build-audit-resolve.d.ts +4 -5
  103. package/dist/src/core/build-audit-resolve.js +4 -5
  104. package/dist/src/core/build-audit-skip.d.ts +2 -2
  105. package/dist/src/core/build-audit.d.ts +3 -4
  106. package/dist/src/core/build-baseline-types.d.ts +37 -3
  107. package/dist/src/core/build-baseline-validate.d.ts +30 -1
  108. package/dist/src/core/build-baseline-validate.js +134 -33
  109. package/dist/src/core/build-baseline.d.ts +8 -2
  110. package/dist/src/core/build-baseline.js +32 -16
  111. package/dist/src/core/build-jar-escalation.d.ts +4 -4
  112. package/dist/src/core/build-jar-escalation.js +4 -4
  113. package/dist/src/core/build-prepare.js +4 -4
  114. package/dist/src/core/config-validate.js +4 -4
  115. package/dist/src/core/coverage-extend.d.ts +5 -3
  116. package/dist/src/core/coverage-extend.js +8 -3
  117. package/dist/src/core/coverage-records.d.ts +4 -5
  118. package/dist/src/core/coverage-records.js +4 -5
  119. package/dist/src/core/destructive.d.ts +2 -2
  120. package/dist/src/core/destructive.js +2 -2
  121. package/dist/src/core/discard-baseline.d.ts +2 -2
  122. package/dist/src/core/discard-baseline.js +3 -3
  123. package/dist/src/core/engine-session-lock.d.ts +1 -1
  124. package/dist/src/core/engine-session-lock.js +1 -1
  125. package/dist/src/core/file-lock-owner.d.ts +5 -5
  126. package/dist/src/core/file-lock-owner.js +5 -5
  127. package/dist/src/core/file-lock-queue.js +6 -8
  128. package/dist/src/core/file-lock-shared.d.ts +4 -4
  129. package/dist/src/core/file-lock-shared.js +4 -4
  130. package/dist/src/core/file-lock.js +7 -10
  131. package/dist/src/core/firefox.js +2 -2
  132. package/dist/src/core/furnace-apply-overwrite-warn.d.ts +1 -1
  133. package/dist/src/core/furnace-apply-overwrite-warn.js +1 -1
  134. package/dist/src/core/furnace-apply.js +3 -3
  135. package/dist/src/core/furnace-config-validate-exceptions.d.ts +4 -3
  136. package/dist/src/core/furnace-config-validate-exceptions.js +26 -6
  137. package/dist/src/core/furnace-operation.js +5 -5
  138. package/dist/src/core/furnace-registration-jar-inplace.js +5 -6
  139. package/dist/src/core/furnace-registration-rename.d.ts +5 -5
  140. package/dist/src/core/furnace-registration-rename.js +5 -5
  141. package/dist/src/core/furnace-registration-validate.d.ts +2 -1
  142. package/dist/src/core/furnace-registration-validate.js +2 -1
  143. package/dist/src/core/furnace-registration.js +2 -2
  144. package/dist/src/core/furnace-validate-accessibility.d.ts +1 -1
  145. package/dist/src/core/furnace-validate-accessibility.js +22 -11
  146. package/dist/src/core/furnace-validate-exceptions.d.ts +2 -1
  147. package/dist/src/core/furnace-validate-exceptions.js +31 -13
  148. package/dist/src/core/git-base.js +4 -3
  149. package/dist/src/core/git-diff.js +1 -1
  150. package/dist/src/core/git.js +1 -1
  151. package/dist/src/core/harness-orphans.d.ts +6 -6
  152. package/dist/src/core/harness-orphans.js +6 -6
  153. package/dist/src/core/harness-port-reservation.d.ts +60 -0
  154. package/dist/src/core/harness-port-reservation.js +122 -0
  155. package/dist/src/core/history-log-file.d.ts +9 -9
  156. package/dist/src/core/history-log-file.js +15 -15
  157. package/dist/src/core/history-log.d.ts +3 -3
  158. package/dist/src/core/history-log.js +3 -3
  159. package/dist/src/core/launchable-build.d.ts +39 -0
  160. package/dist/src/core/launchable-build.js +85 -0
  161. package/dist/src/core/marionette-port.js +1 -3
  162. package/dist/src/core/moz-manifest-rules.js +3 -2
  163. package/dist/src/core/negative-control-compiled.d.ts +22 -3
  164. package/dist/src/core/negative-control-compiled.js +41 -5
  165. package/dist/src/core/parser-fallback.d.ts +5 -5
  166. package/dist/src/core/parser-fallback.js +5 -5
  167. package/dist/src/core/patch-identifier-suggest.d.ts +6 -0
  168. package/dist/src/core/patch-identifier-suggest.js +11 -4
  169. package/dist/src/core/patch-lint-checkjs.d.ts +1 -1
  170. package/dist/src/core/patch-lint-checkjs.js +1 -1
  171. package/dist/src/core/patch-lint-css.js +2 -2
  172. package/dist/src/core/patch-lint-file-size.d.ts +5 -7
  173. package/dist/src/core/patch-lint-file-size.js +5 -7
  174. package/dist/src/core/patch-lint-ignore.d.ts +3 -3
  175. package/dist/src/core/patch-lint-ignore.js +3 -3
  176. package/dist/src/core/patch-lint-prettier.d.ts +4 -6
  177. package/dist/src/core/patch-lint-prettier.js +4 -6
  178. package/dist/src/core/patch-lint-projection.d.ts +1 -1
  179. package/dist/src/core/patch-lint-projection.js +1 -1
  180. package/dist/src/core/patch-lint-queue-types.d.ts +2 -2
  181. package/dist/src/core/patch-lint-queue-types.js +2 -2
  182. package/dist/src/core/patch-manifest-consistency.d.ts +2 -2
  183. package/dist/src/core/patch-manifest-consistency.js +2 -2
  184. package/dist/src/core/patch-manifest-io.d.ts +5 -1
  185. package/dist/src/core/patch-manifest-io.js +12 -10
  186. package/dist/src/core/patch-manifest-key-order.d.ts +3 -4
  187. package/dist/src/core/patch-manifest-key-order.js +3 -4
  188. package/dist/src/core/patch-parse.d.ts +3 -3
  189. package/dist/src/core/patch-parse.js +3 -3
  190. package/dist/src/core/patch-policy.d.ts +1 -1
  191. package/dist/src/core/patch-policy.js +1 -1
  192. package/dist/src/core/patch-source-metadata.d.ts +1 -1
  193. package/dist/src/core/patch-source-metadata.js +1 -1
  194. package/dist/src/core/patch-subset.d.ts +5 -3
  195. package/dist/src/core/patch-subset.js +8 -7
  196. package/dist/src/core/patch-transform.d.ts +2 -2
  197. package/dist/src/core/patch-transform.js +2 -2
  198. package/dist/src/core/rebase-session.js +4 -6
  199. package/dist/src/core/register-xpcshell-test.d.ts +28 -7
  200. package/dist/src/core/register-xpcshell-test.js +76 -27
  201. package/dist/src/core/run-log.d.ts +8 -8
  202. package/dist/src/core/run-log.js +8 -8
  203. package/dist/src/core/status-classify.d.ts +1 -2
  204. package/dist/src/core/status-classify.js +1 -2
  205. package/dist/src/core/test-harness-crash.d.ts +5 -3
  206. package/dist/src/core/test-harness-crash.js +13 -14
  207. package/dist/src/core/test-harness-infra.d.ts +32 -0
  208. package/dist/src/core/test-harness-infra.js +69 -0
  209. package/dist/src/core/test-harness-signature.d.ts +6 -0
  210. package/dist/src/core/test-run-completeness.d.ts +12 -5
  211. package/dist/src/core/test-run-completeness.js +15 -8
  212. package/dist/src/core/test-stale-check.d.ts +48 -1
  213. package/dist/src/core/test-stale-check.js +97 -2
  214. package/dist/src/core/test-stall-triage.js +5 -7
  215. package/dist/src/core/token-category.js +2 -2
  216. package/dist/src/core/token-inventory.js +3 -3
  217. package/dist/src/core/token-manager.d.ts +2 -2
  218. package/dist/src/core/token-manager.js +5 -7
  219. package/dist/src/core/token-variant.d.ts +6 -6
  220. package/dist/src/core/token-variant.js +7 -7
  221. package/dist/src/core/typecheck-shim.d.ts +2 -1
  222. package/dist/src/core/typecheck-shim.js +29 -5
  223. package/dist/src/core/wire-destroy.d.ts +1 -1
  224. package/dist/src/core/wire-destroy.js +1 -1
  225. package/dist/src/core/wire-dom-fragment.js +1 -1
  226. package/dist/src/core/wire-init.d.ts +1 -1
  227. package/dist/src/core/wire-init.js +1 -1
  228. package/dist/src/core/wire-subscript.d.ts +1 -1
  229. package/dist/src/core/wire-subscript.js +1 -1
  230. package/dist/src/core/wire-utils.d.ts +2 -2
  231. package/dist/src/core/wire-utils.js +3 -3
  232. package/dist/src/errors/base.d.ts +1 -1
  233. package/dist/src/errors/base.js +1 -1
  234. package/dist/src/errors/rebase.d.ts +1 -1
  235. package/dist/src/errors/rebase.js +1 -1
  236. package/dist/src/types/commands/options.d.ts +26 -3
  237. package/dist/src/types/config.d.ts +5 -7
  238. package/dist/src/types/furnace.d.ts +9 -0
  239. package/dist/src/utils/options.js +2 -2
  240. package/dist/src/utils/process.js +2 -2
  241. package/dist/src/utils/regex.d.ts +2 -2
  242. package/dist/src/utils/regex.js +3 -3
  243. package/dist/src/utils/sleep.d.ts +5 -6
  244. package/dist/src/utils/sleep.js +5 -6
  245. package/dist/src/utils/validation.js +2 -2
  246. package/docs/configuration.md +40 -26
  247. package/docs/exit-codes.md +8 -11
  248. package/docs/furnace.md +21 -3
  249. package/docs/lifecycle-invariants.md +36 -45
  250. package/docs/machine-output.md +43 -22
  251. package/docs/patch-workflow.md +129 -24
  252. package/docs/run-logs.md +8 -9
  253. package/docs/testing.md +118 -44
  254. package/package.json +1 -1
@@ -11,7 +11,7 @@
11
11
  import { FurnaceError } from '../errors/furnace.js';
12
12
  import { FURNACE_OPT_IN_CHECKS, } from '../types/furnace.js';
13
13
  import { isArray, isObject, isString } from '../utils/validation.js';
14
- const EXCEPTION_KEYS = new Set(['component', 'check', 'tag', 'reason']);
14
+ const EXCEPTION_KEYS = new Set(['component', 'check', 'tag', 'file', 'reason']);
15
15
  function requireNonEmptyString(entry, key, field) {
16
16
  const value = entry[key];
17
17
  if (!isString(value) || value.trim().length === 0) {
@@ -20,9 +20,10 @@ function requireNonEmptyString(entry, key, field) {
20
20
  return value;
21
21
  }
22
22
  /**
23
- * Parses `validationExceptions[]`: `{ component, check, tag?, reason }`
24
- * objects, no other keys, every field a non-empty string, and no two
25
- * entries for the same component, check and tag.
23
+ * Parses `validationExceptions[]`: `{ component, check, tag?, file?, reason }`
24
+ * objects, no other keys, every field a non-empty string, at most one of
25
+ * `tag` and `file` (a bare file name of the component), and no two entries
26
+ * for the same component, check and scope.
26
27
  */
27
28
  export function parseValidationExceptions(raw) {
28
29
  if (!isArray(raw)) {
@@ -46,9 +47,28 @@ export function parseValidationExceptions(raw) {
46
47
  };
47
48
  if (entry['tag'] !== undefined)
48
49
  exception.tag = requireNonEmptyString(entry, 'tag', field);
49
- const identity = `${exception.component}\u0000${exception.check}\u0000${exception.tag ?? ''}`;
50
+ if (entry['file'] !== undefined) {
51
+ if (exception.tag !== undefined) {
52
+ throw new FurnaceError(`Furnace config: "${field}" may name a "tag" or a "file", not both`);
53
+ }
54
+ const file = requireNonEmptyString(entry, 'file', field);
55
+ if (/[\\/]/.test(file) || file === '.' || file === '..') {
56
+ throw new FurnaceError(`Furnace config: "${field}.file" must be a file name in the component's directory, not a path`);
57
+ }
58
+ exception.file = file;
59
+ }
60
+ const scope = exception.tag !== undefined
61
+ ? `tag:${exception.tag}`
62
+ : exception.file !== undefined
63
+ ? `file:${exception.file}`
64
+ : '';
65
+ const identity = `${exception.component}\u0000${exception.check}\u0000${scope}`;
50
66
  if (seen.has(identity)) {
51
- const on = exception.tag !== undefined ? ` on <${exception.tag}>` : '';
67
+ const on = exception.tag !== undefined
68
+ ? ` on <${exception.tag}>`
69
+ : exception.file !== undefined
70
+ ? ` in ${exception.file}`
71
+ : '';
52
72
  throw new FurnaceError(`Furnace config: "${field}" repeats the exception for ${exception.component} [${exception.check}]${on}`);
53
73
  }
54
74
  seen.add(identity);
@@ -305,11 +305,11 @@ export async function completeJournalRollback(ctx, journal, error, options) {
305
305
  export async function forceReleaseFurnaceLocksForActiveOperations() {
306
306
  const paths = new Set([...activeOperations.values()].map((op) => getFurnaceLockPath(op.root)));
307
307
  for (const lockPath of paths) {
308
- // Ownership-checked, like every other release path. The bare `rm` this
309
- // replaced would delete a lock a different process had acquired in the
310
- // window between our operation dying and this sweep running. That is the
311
- // exact race `releaseLock`'s PID verification was added to close, reopened
312
- // here because the sweeper has no acquisition token to check.
308
+ // Ownership-checked, like every other release path. A bare `rm` would
309
+ // delete a lock a different process had acquired in the window between
310
+ // our operation dying and this sweep running. That is the exact race
311
+ // `releaseLock`'s PID verification closes, and the sweeper has no
312
+ // acquisition token to check.
313
313
  const removed = await releaseLockIfOwned(lockPath);
314
314
  verbose(removed
315
315
  ? `Removed furnace lock at ${lockPath} during signal teardown`
@@ -2,10 +2,9 @@
2
2
  /**
3
3
  * In-place edits to a widget's `toolkit/content/jar.mn` block.
4
4
  *
5
- * Undeploying one file and renaming a component used to drop every line of
6
- * the widget and re-add the live ones, which re-sorted the whole block and
7
- * left the owning patch carrying reorder hunks. These helpers touch only
8
- * the lines that change: a deleted file's line goes, a renamed component's
5
+ * Dropping every line of the widget and re-adding the live ones would
6
+ * re-sort the whole block and leave the owning patch carrying reorder
7
+ * hunks. These helpers touch only the lines that change: a deleted file's line goes, a renamed component's
9
8
  * lines are rewritten where they stand, and anything still missing is left
10
9
  * for `addJarMnEntries` to insert.
11
10
  */
@@ -15,8 +14,8 @@ import { escapeRegex } from '../utils/regex.js';
15
14
  import { JAR_MN } from './furnace-constants.js';
16
15
  /**
17
16
  * The file a widget jar.mn line registers: the `(widgets/<tag>/<file>)`
18
- * source mapping, or the legacy `content/global/elements/<tag>.<ext>`
19
- * target written before the mapping existed. Undefined when the line is
17
+ * source mapping, or the `content/global/elements/<tag>.<ext>` target of a
18
+ * line that carries no source mapping. Undefined when the line is
20
19
  * not one of this tag's.
21
20
  */
22
21
  function registeredFile(line, tagName) {
@@ -1,11 +1,11 @@
1
1
  /**
2
2
  * In-place rename of a custom element registration in customElements.js.
3
3
  *
4
- * `furnace rename` used to remove the old entry and add a new one. On a
5
- * registration list the remove path could not see, that left the old entry
6
- * beside the new one, and the new entry was written without the project
7
- * marker every sibling line carries (`// <MARKER>:`), so the next lint
8
- * flagged it as an unmarked engine edit. Rewriting the tag and module
4
+ * Removing the old entry and adding a new one would, on a registration
5
+ * list the remove path cannot see, leave the old entry beside the new one,
6
+ * and the new entry would lack the project marker every sibling line
7
+ * carries (`// <MARKER>:`), so the next lint would flag it as an unmarked
8
+ * engine edit. Rewriting the tag and module
9
9
  * literals inside the existing entry keeps the entry's position, layout and
10
10
  * trailing marker comments exactly as they were.
11
11
  */
@@ -2,11 +2,11 @@
2
2
  /**
3
3
  * In-place rename of a custom element registration in customElements.js.
4
4
  *
5
- * `furnace rename` used to remove the old entry and add a new one. On a
6
- * registration list the remove path could not see, that left the old entry
7
- * beside the new one, and the new entry was written without the project
8
- * marker every sibling line carries (`// <MARKER>:`), so the next lint
9
- * flagged it as an unmarked engine edit. Rewriting the tag and module
5
+ * Removing the old entry and adding a new one would, on a registration
6
+ * list the remove path cannot see, leave the old entry beside the new one,
7
+ * and the new entry would lack the project marker every sibling line
8
+ * carries (`// <MARKER>:`), so the next lint would flag it as an unmarked
9
+ * engine edit. Rewriting the tag and module
10
10
  * literals inside the existing entry keeps the entry's position, layout and
11
11
  * trailing marker comments exactly as they were.
12
12
  */
@@ -1,6 +1,7 @@
1
1
  /**
2
2
  * Shared validation for furnace custom element registration placement.
3
- * Used after both AST and legacy code paths to avoid duplicating logic.
3
+ * Shared by the AST registration editor and the registration validator to
4
+ * avoid duplicating logic.
4
5
  */
5
6
  /**
6
7
  * Regex for valid custom element tag names. A valid name is lowercase, starts
@@ -1,7 +1,8 @@
1
1
  // SPDX-License-Identifier: EUPL-1.2
2
2
  /**
3
3
  * Shared validation for furnace custom element registration placement.
4
- * Used after both AST and legacy code paths to avoid duplicating logic.
4
+ * Shared by the AST registration editor and the registration validator to
5
+ * avoid duplicating logic.
5
6
  */
6
7
  import { FurnaceError } from '../errors/furnace.js';
7
8
  import { escapeRegex, stripJsComments } from '../utils/regex.js';
@@ -252,8 +252,8 @@ export async function removeJarMnEntries(engineDir, tagName) {
252
252
  // line the component registered is removed regardless of the target
253
253
  // basename. A helper `.mjs` whose name does not start with the tag (e.g.
254
254
  // a renamed `foo-utils.mjs`) otherwise survives the remove pass and leaves
255
- // a stale registration that breaks packaging. The legacy target-path match
256
- // is kept as an OR for lines written before the source mapping existed.
255
+ // a stale registration that breaks packaging. The target-path match is
256
+ // kept as an OR for lines that carry no source mapping.
257
257
  // Word boundaries keep "moz-card" from matching "moz-card-group".
258
258
  const sourcePattern = new RegExp(`\\(widgets/${escapeRegex(tagName)}/`);
259
259
  const legacyTargetPattern = new RegExp(`content/global/elements/${escapeRegex(tagName)}\\.`);
@@ -34,6 +34,6 @@ export declare function validateAccessibility(componentDir: string, tagName: str
34
34
  * `title=`, or `tooltiptext=` attribute when constructing DOM in JS.
35
35
  *
36
36
  * A file-wide `// furnace-ignore: hardcoded-text` comment suppresses all
37
- * findings (matches the pre-existing escape hatch).
37
+ * findings in that file (matches the pre-existing escape hatch).
38
38
  */
39
39
  export declare function containsHardcodedTemplateText(content: string): boolean;
@@ -11,8 +11,9 @@ import { collectLitTemplateRegions, parseTemplateAttributes } from './lit-templa
11
11
  * findings do not depend on which of the component's modules it lives in.
12
12
  * Returns undefined when the host module is missing.
13
13
  */
14
- async function readComposedComponentSource(componentDir, tagName) {
15
- const hostPath = join(componentDir, `${tagName}.mjs`);
14
+ async function readComposedComponentModules(componentDir, tagName) {
15
+ const hostName = `${tagName}.mjs`;
16
+ const hostPath = join(componentDir, hostName);
16
17
  if (!(await pathExists(hostPath)))
17
18
  return undefined;
18
19
  const entries = await readdir(componentDir).catch(() => []);
@@ -21,10 +22,11 @@ async function readComposedComponentSource(componentDir, tagName) {
21
22
  name.endsWith('.mjs') &&
22
23
  !/\.(test|spec|stories)\./.test(name))
23
24
  .sort();
24
- const sources = [await readText(hostPath)];
25
- for (const name of companions)
26
- sources.push(await readText(join(componentDir, name)));
27
- return sources.join('\n');
25
+ const modules = [{ name: hostName, content: await readText(hostPath) }];
26
+ for (const name of companions) {
27
+ modules.push({ name, content: await readText(join(componentDir, name)) });
28
+ }
29
+ return modules;
28
30
  }
29
31
  /**
30
32
  * Validates accessibility patterns in a component's composed source: its
@@ -44,9 +46,10 @@ async function readComposedComponentSource(componentDir, tagName) {
44
46
  * adds the icon-only `<moz-button>` naming check.
45
47
  */
46
48
  export async function validateAccessibility(componentDir, tagName, customConfig, optInChecks = []) {
47
- const content = await readComposedComponentSource(componentDir, tagName);
48
- if (content === undefined)
49
+ const modules = await readComposedComponentModules(componentDir, tagName);
50
+ if (modules === undefined)
49
51
  return [];
52
+ const content = modules.map((module) => module.content).join('\n');
50
53
  const issues = [];
51
54
  if (!hasAriaRole(content) && hasGenericInteractiveElement(content)) {
52
55
  issues.push(createIssue(tagName, 'warning', 'no-aria-role', 'Generic interactive markup has no native semantics. Prefer native elements, or add role= when native markup cannot provide the semantics.'));
@@ -72,8 +75,16 @@ export async function validateAccessibility(componentDir, tagName, customConfig,
72
75
  tags: syntheticTags,
73
76
  });
74
77
  }
75
- if (containsHardcodedTemplateText(content)) {
76
- issues.push(createIssue(tagName, 'warning', 'hardcoded-text', 'Possible hardcoded string found. Use data-l10n-id for localization.'));
78
+ // Judged per module, so the finding names its files and an exception can
79
+ // accept one module (a vendored bundle) without muting the others.
80
+ const textFiles = modules
81
+ .filter((module) => containsHardcodedTemplateText(module.content))
82
+ .map((module) => module.name);
83
+ if (textFiles.length > 0) {
84
+ issues.push({
85
+ ...createIssue(tagName, 'warning', 'hardcoded-text', `Possible hardcoded string found in ${textFiles.join(', ')}. Use data-l10n-id for localization.`),
86
+ files: textFiles,
87
+ });
77
88
  }
78
89
  const isInteractive = hasClick || hasKeyboardHandler;
79
90
  if (isInteractive && !hasDelegatesFocusEnabled(content)) {
@@ -337,7 +348,7 @@ function isWithinLocalizedElement(content, matchIndex) {
337
348
  * `title=`, or `tooltiptext=` attribute when constructing DOM in JS.
338
349
  *
339
350
  * A file-wide `// furnace-ignore: hardcoded-text` comment suppresses all
340
- * findings (matches the pre-existing escape hatch).
351
+ * findings in that file (matches the pre-existing escape hatch).
341
352
  */
342
353
  export function containsHardcodedTemplateText(content) {
343
354
  if (/furnace-ignore:\s*hardcoded-text/.test(content)) {
@@ -2,7 +2,8 @@
2
2
  * Applies `furnace.json#validationExceptions[]` to a `furnace validate`
3
3
  * result. An exception suppresses every finding of its check on its
4
4
  * component, or with `tag`, a finding whose element tags it (and its
5
- * sibling tag entries) cover. One that suppresses nothing is stale: the
5
+ * sibling tag entries) cover, or with `file`, a finding whose module files
6
+ * it (and its sibling file entries) cover. One that suppresses nothing is stale: the
6
7
  * finding was fixed (or renamed) and the review record outlived it, so it
7
8
  * is reported as a warning naming the entry to delete, which keeps the
8
9
  * list honest under `--max-warnings 0`.
@@ -6,19 +6,34 @@ export const EXCEPTION_ON_ERROR_CHECK = 'validation-exception-on-error';
6
6
  function matches(exception, issue) {
7
7
  return exception.component === issue.component && exception.check === issue.check;
8
8
  }
9
+ /** An exception's narrowing: the finding field it reads and its value. */
10
+ function scopeOf(entry) {
11
+ if (entry.tag !== undefined)
12
+ return { key: 'tags', value: entry.tag };
13
+ if (entry.file !== undefined)
14
+ return { key: 'files', value: entry.file };
15
+ return undefined;
16
+ }
9
17
  /**
10
- * The exceptions that suppress a warning: an untagged one alone, or tagged
11
- * ones that together cover every tag the finding names.
18
+ * The exceptions that suppress a warning: an unscoped one alone, or scoped
19
+ * ones that together cover every tag (or every file) the finding names.
12
20
  */
13
21
  function coveringExceptions(issue, candidates) {
14
- const untagged = candidates.find((entry) => entry.tag === undefined);
15
- if (untagged !== undefined)
16
- return [untagged];
17
- const tags = issue.tags ?? [];
18
- if (tags.length === 0)
19
- return [];
20
- const covering = tags.map((tag) => candidates.find((entry) => entry.tag === tag));
21
- return covering.every((entry) => entry !== undefined) ? [...new Set(covering)] : [];
22
+ const unscoped = candidates.find((entry) => scopeOf(entry) === undefined);
23
+ if (unscoped !== undefined)
24
+ return [unscoped];
25
+ for (const key of ['tags', 'files']) {
26
+ const named = issue[key] ?? [];
27
+ if (named.length === 0)
28
+ continue;
29
+ const covering = named.map((value) => candidates.find((entry) => {
30
+ const scope = scopeOf(entry);
31
+ return scope?.key === key && scope.value === value;
32
+ }));
33
+ if (covering.every((entry) => entry !== undefined))
34
+ return [...new Set(covering)];
35
+ }
36
+ return [];
22
37
  }
23
38
  /**
24
39
  * Splits findings into counted and excepted, and reports stale exceptions.
@@ -47,11 +62,14 @@ export function applyValidationExceptions(issues, exceptions, judged) {
47
62
  }
48
63
  const covering = coveringExceptions(issue, candidates);
49
64
  if (covering.length === 0) {
50
- // A tagged exception that covers some of the tags is not stale: its
51
- // element still carries the finding, beside one it does not cover.
65
+ // A scoped exception that covers some of the tags (or files) is not
66
+ // stale: its element still carries the finding, beside one it does
67
+ // not cover.
52
68
  for (const entry of candidates) {
53
- if (entry.tag !== undefined && issue.tags?.includes(entry.tag) === true)
69
+ const scope = scopeOf(entry);
70
+ if (scope !== undefined && issue[scope.key]?.includes(scope.value) === true) {
54
71
  used.add(entry);
72
+ }
55
73
  }
56
74
  outcome.issues.push(issue);
57
75
  continue;
@@ -45,9 +45,10 @@ export const GIT_ADD_CHUNK_TIMEOUT_MS = resolveTimeoutFromEnv(GIT_ADD_CHUNK_TIME
45
45
  /**
46
46
  * In-flight or settled successful `git` availability probe.
47
47
  *
48
- * The probe spawns `which git` (or `where` on Windows), and every git wrapper
49
- * in this layer used to run it before each command, which meant dozens of
50
- * extra spawns per `fireforge export`. Only success is cached: a rejection
48
+ * The probe spawns `which git` (or `where` on Windows); running it before
49
+ * every command would mean dozens of extra spawns per `fireforge export`, so
50
+ * the result is shared by every git wrapper in this layer. Only success is
51
+ * cached: a rejection
51
52
  * clears the slot so a run that installs git mid-flight (or a test that flips
52
53
  * the probe) sees the new answer instead of a sticky refusal.
53
54
  */
@@ -521,7 +521,7 @@ async function generateBinaryFilePatchWithConfig(repoDir, filePath, gitConfigArg
521
521
  * "absent", and this branch only runs for files untracked in HEAD). A prior
522
522
  * stage-0 entry is re-pointed at its recorded mode and blob. Unmerged entries
523
523
  * (stages 1 to 3) cannot be rebuilt through `--cacheinfo`. That degenerate
524
- * state keeps the legacy reset-to-HEAD behavior rather than corrupting the
524
+ * state falls back to the reset-to-HEAD restore rather than corrupting the
525
525
  * conflict.
526
526
  * @param repoDir - Repository directory
527
527
  * @param filePath - File path (relative to repo root)
@@ -46,7 +46,7 @@ const GIT_ADD_ENV = { GIT_INDEX_THREADS: '0' };
46
46
  * AbortError when the signal fires, so both shapes have to be recognised.
47
47
  */
48
48
  function isTimeoutError(error) {
49
- // `exec` now rejects with a typed ExecTimeoutError when its `timeout`
49
+ // `exec` rejects with a typed ExecTimeoutError when its `timeout`
50
50
  // option fires (the raw AbortError check below is kept for defence in
51
51
  // depth against other abort paths).
52
52
  if (error instanceof ExecTimeoutError)
@@ -45,12 +45,12 @@ export interface OrphanedHarnessProcess {
45
45
  * True when `command` IS a harness helper: its executable is a helper
46
46
  * binary, or an interpreter whose first argument is a helper script.
47
47
  *
48
- * Structural on purpose. An earlier version matched the helper names
49
- * anywhere in the command line, which is right for the httpd (`xpcshell -g
50
- * … -f …/server.js`) and wrong for everything that merely mentions such a
51
- * path: an editor opened on `server.js`, a shell whose command text quotes
52
- * it, a `grep` over the objdir. Report-only, that printed a misleading
53
- * `kill`; under the reap posture it terminated the operator's shell.
48
+ * Structural on purpose. Matching the helper names anywhere in the command
49
+ * line is right for the httpd (`xpcshell -g … -f …/server.js`) and wrong for
50
+ * everything that merely mentions such a path: an editor opened on
51
+ * `server.js`, a shell whose command text quotes it, a `grep` over the
52
+ * objdir. Report-only, that would print a misleading `kill`; under the reap
53
+ * posture it would terminate the operator's shell.
54
54
  */
55
55
  export declare function matchesHarnessHelper(command: string): boolean;
56
56
  /** Objdir provenance: an explicit objdir path, a `obj-…` path segment, or `_tests/`. */
@@ -55,12 +55,12 @@ function basename(token) {
55
55
  * True when `command` IS a harness helper: its executable is a helper
56
56
  * binary, or an interpreter whose first argument is a helper script.
57
57
  *
58
- * Structural on purpose. An earlier version matched the helper names
59
- * anywhere in the command line, which is right for the httpd (`xpcshell -g
60
- * … -f …/server.js`) and wrong for everything that merely mentions such a
61
- * path: an editor opened on `server.js`, a shell whose command text quotes
62
- * it, a `grep` over the objdir. Report-only, that printed a misleading
63
- * `kill`; under the reap posture it terminated the operator's shell.
58
+ * Structural on purpose. Matching the helper names anywhere in the command
59
+ * line is right for the httpd (`xpcshell -g … -f …/server.js`) and wrong for
60
+ * everything that merely mentions such a path: an editor opened on
61
+ * `server.js`, a shell whose command text quotes it, a `grep` over the
62
+ * objdir. Report-only, that would print a misleading `kill`; under the reap
63
+ * posture it would terminate the operator's shell.
64
64
  */
65
65
  export function matchesHarnessHelper(command) {
66
66
  const [exe, first] = command.trim().split(/\s+/);
@@ -0,0 +1,60 @@
1
+ /**
2
+ * Mochitest server ports for `fireforge test --jobs <n>`: placeholder
3
+ * listeners that push every parallel harness instance onto its own ports,
4
+ * and the parse of the ports each instance actually took.
5
+ *
6
+ * Desktop `mach mochitest` has no `--http-port`, `--ssl-port` or
7
+ * `--websocket-port`. Its `startServers` (`testing/mochitest/runtests.py`)
8
+ * bind-probes the HTTP server, ssltunnel and WebSocket ports (8888, 4443,
9
+ * 9988) and moves only a busy one to a free port; see
10
+ * `harness-port-fallback.ts`. Instances started at the same moment all
11
+ * pass that probe on a free 8888, then race to bind it: the losers die with
12
+ * `could not start server on port 8888` before any test runs. Holding the
13
+ * three ports for the whole parallel run makes every instance's probe fail,
14
+ * so each one falls back to an OS-assigned port of its own.
15
+ */
16
+ /** Which mochitest server a port belongs to, as the verdict line names it. */
17
+ export type HarnessServerPortKey = 'http' | 'ssl' | 'ws';
18
+ /** Placeholder listeners held for a parallel run. */
19
+ export interface HarnessPortReservation {
20
+ /** Ports this process now holds. A port that was already busy is not listed. */
21
+ held: number[];
22
+ /** Closes every placeholder. Safe to call more than once. */
23
+ release(): Promise<void>;
24
+ }
25
+ /**
26
+ * Holds a placeholder listener on `127.0.0.1` on each mochitest server
27
+ * port, so the harness's busy-port probe moves every instance elsewhere.
28
+ * A port that cannot be bound is skipped, not refused: whatever holds it
29
+ * already makes the probe fail, which is all the placeholder is for (the
30
+ * preflight has already ruled out this checkout's own stale httpd).
31
+ *
32
+ * @param ports - Ports to hold (default: {@link HARNESS_SERVER_PORTS})
33
+ */
34
+ export declare function reserveHarnessServerPorts(ports?: readonly number[]): Promise<HarnessPortReservation>;
35
+ /** The server ports one harness invocation reported, by server. */
36
+ export type HarnessServerPorts = Partial<Record<HarnessServerPortKey, number>>;
37
+ /**
38
+ * Records the port one output line reports, if it reports one: the
39
+ * fallback port of a "falling back" line, or the port itself otherwise.
40
+ *
41
+ * @param line - One line of harness output
42
+ * @param into - Collected ports; a later line for the same server wins
43
+ */
44
+ export declare function recordHarnessServerPortLine(line: string, into: HarnessServerPorts): void;
45
+ /** Collects server ports from streamed output chunks. */
46
+ export interface HarnessPortTracker {
47
+ onChunk(stream: 'stdout' | 'stderr', chunk: string): void;
48
+ /** The ports seen so far, including an unterminated last line. */
49
+ ports(): HarnessServerPorts;
50
+ }
51
+ /**
52
+ * A tracker over the full output stream. The ports are printed at harness
53
+ * start, so the capped capture tail a long run keeps would lose them.
54
+ */
55
+ export declare function createHarnessPortTracker(): HarnessPortTracker;
56
+ /**
57
+ * The `http:N,ssl:N,ws:N` value of a `ports=` key, in probe order, or
58
+ * undefined when no port is known.
59
+ */
60
+ export declare function formatHarnessServerPorts(ports: HarnessServerPorts | undefined): string | undefined;
@@ -0,0 +1,122 @@
1
+ // SPDX-License-Identifier: EUPL-1.2
2
+ /**
3
+ * Mochitest server ports for `fireforge test --jobs <n>`: placeholder
4
+ * listeners that push every parallel harness instance onto its own ports,
5
+ * and the parse of the ports each instance actually took.
6
+ *
7
+ * Desktop `mach mochitest` has no `--http-port`, `--ssl-port` or
8
+ * `--websocket-port`. Its `startServers` (`testing/mochitest/runtests.py`)
9
+ * bind-probes the HTTP server, ssltunnel and WebSocket ports (8888, 4443,
10
+ * 9988) and moves only a busy one to a free port; see
11
+ * `harness-port-fallback.ts`. Instances started at the same moment all
12
+ * pass that probe on a free 8888, then race to bind it: the losers die with
13
+ * `could not start server on port 8888` before any test runs. Holding the
14
+ * three ports for the whole parallel run makes every instance's probe fail,
15
+ * so each one falls back to an OS-assigned port of its own.
16
+ */
17
+ import { createServer } from 'node:net';
18
+ /**
19
+ * The ports `startServers` probes, in the order it probes them. Desktop
20
+ * mochitest cannot configure them, so the engine defaults are the ports.
21
+ */
22
+ const HARNESS_SERVER_PORTS = [
23
+ { key: 'http', port: 8888, label: 'HTTP test server' },
24
+ { key: 'ssl', port: 4443, label: 'ssltunnel' },
25
+ { key: 'ws', port: 9988, label: 'WebSocket server' },
26
+ ];
27
+ /** Listens on `127.0.0.1:port`, or resolves undefined when the bind fails. */
28
+ async function holdPort(port) {
29
+ return new Promise((resolve) => {
30
+ const server = createServer((socket) => {
31
+ // Nothing should connect: the harness only probes with a bind. Anyone
32
+ // who does gets a closed socket instead of a hang.
33
+ socket.destroy();
34
+ });
35
+ server.once('error', () => {
36
+ resolve(undefined);
37
+ });
38
+ server.listen({ port, host: '127.0.0.1', exclusive: true }, () => {
39
+ server.unref();
40
+ resolve(server);
41
+ });
42
+ });
43
+ }
44
+ /**
45
+ * Holds a placeholder listener on `127.0.0.1` on each mochitest server
46
+ * port, so the harness's busy-port probe moves every instance elsewhere.
47
+ * A port that cannot be bound is skipped, not refused: whatever holds it
48
+ * already makes the probe fail, which is all the placeholder is for (the
49
+ * preflight has already ruled out this checkout's own stale httpd).
50
+ *
51
+ * @param ports - Ports to hold (default: {@link HARNESS_SERVER_PORTS})
52
+ */
53
+ export async function reserveHarnessServerPorts(ports = HARNESS_SERVER_PORTS.map((spec) => spec.port)) {
54
+ const servers = (await Promise.all(ports.map(holdPort))).filter((server) => server !== undefined);
55
+ const held = servers.map((server) => {
56
+ const address = server.address();
57
+ return typeof address === 'object' && address !== null ? address.port : 0;
58
+ });
59
+ let released = false;
60
+ return {
61
+ held,
62
+ async release() {
63
+ if (released)
64
+ return;
65
+ released = true;
66
+ await Promise.all(servers.map((server) => new Promise((resolve) => {
67
+ server.close(() => {
68
+ resolve();
69
+ });
70
+ })));
71
+ },
72
+ };
73
+ }
74
+ const PORT_LINE_PATTERN = /\b(HTTP test server|ssltunnel|WebSocket server) port (\d+)(?: already in use, falling back to port (\d+))?/;
75
+ /**
76
+ * Records the port one output line reports, if it reports one: the
77
+ * fallback port of a "falling back" line, or the port itself otherwise.
78
+ *
79
+ * @param line - One line of harness output
80
+ * @param into - Collected ports; a later line for the same server wins
81
+ */
82
+ export function recordHarnessServerPortLine(line, into) {
83
+ const match = PORT_LINE_PATTERN.exec(line);
84
+ if (match === null)
85
+ return;
86
+ const spec = HARNESS_SERVER_PORTS.find((entry) => entry.label === match[1]);
87
+ const port = Number.parseInt(match[3] ?? match[2] ?? '', 10);
88
+ if (spec !== undefined && Number.isInteger(port))
89
+ into[spec.key] = port;
90
+ }
91
+ /**
92
+ * A tracker over the full output stream. The ports are printed at harness
93
+ * start, so the capped capture tail a long run keeps would lose them.
94
+ */
95
+ export function createHarnessPortTracker() {
96
+ const collected = {};
97
+ const pending = { stdout: '', stderr: '' };
98
+ return {
99
+ onChunk(stream, chunk) {
100
+ const lines = `${pending[stream]}${chunk}`.split(/\r?\n/);
101
+ pending[stream] = lines.pop() ?? '';
102
+ for (const line of lines)
103
+ recordHarnessServerPortLine(line, collected);
104
+ },
105
+ ports() {
106
+ const result = { ...collected };
107
+ recordHarnessServerPortLine(pending.stdout, result);
108
+ recordHarnessServerPortLine(pending.stderr, result);
109
+ return result;
110
+ },
111
+ };
112
+ }
113
+ /**
114
+ * The `http:N,ssl:N,ws:N` value of a `ports=` key, in probe order, or
115
+ * undefined when no port is known.
116
+ */
117
+ export function formatHarnessServerPorts(ports) {
118
+ if (ports === undefined)
119
+ return undefined;
120
+ const parts = HARNESS_SERVER_PORTS.flatMap(({ key }) => ports[key] === undefined ? [] : [`${key}:${ports[key]}`]);
121
+ return parts.length > 0 ? parts.join(',') : undefined;
122
+ }
@@ -1,4 +1,4 @@
1
- /** Filename of the history log at its pre-0.50 location, inside `patches/`. */
1
+ /** Filename of a history log inside `patches/`, which is moved out of the queue. */
2
2
  export declare const LEGACY_HISTORY_LOG_FILENAME = ".fireforge-history.jsonl";
3
3
  /** Default history log location, relative to the project root. */
4
4
  export declare const DEFAULT_HISTORY_LOG_PATH: string;
@@ -29,30 +29,30 @@ export declare function historyRecordIdentity(): HistoryRecordIdentity;
29
29
  */
30
30
  export declare function resolveHistoryLogPath(projectRoot: string): Promise<string>;
31
31
  /**
32
- * Moves a history log left at the legacy `patches/` path to `target`.
32
+ * Moves a history log found at the `patches/` path to `target`.
33
33
  *
34
34
  * Records are never dropped, whatever else is happening:
35
- * - The legacy file is first claimed by renaming it aside, so of two
35
+ * - The in-queue file is first claimed by renaming it aside, so of two
36
36
  * commands migrating at once exactly one does the work and neither
37
37
  * duplicates it.
38
38
  * - When `target` does not exist yet (the first run), the claimed file is
39
39
  * hard-linked into place, which cannot overwrite a log another command
40
40
  * created in the meantime, and keeps a large log a constant-time move.
41
- * - When both exist (an older FireForge appended to the legacy path after
42
- * a migration, or `history.path` changed), the legacy records are
41
+ * - When both exist (a log reappeared at the `patches/` path after a
42
+ * migration, or `history.path` changed), the in-queue records are
43
43
  * appended to the target in one write. They then follow newer records;
44
44
  * every record carries its own `ts`.
45
45
  *
46
46
  * A crash between the claim and the move leaves the records in a
47
- * `.migrating-*` file next to the legacy path, never deleted.
47
+ * `.migrating-*` file next to the in-queue path, never deleted.
48
48
  *
49
- * @param patchesDir - The patches directory that may hold a legacy log
49
+ * @param patchesDir - The patches directory that may hold an in-queue log
50
50
  * @param target - Absolute path of the history log
51
51
  */
52
52
  export declare function migrateLegacyHistoryLog(patchesDir: string, target: string): Promise<void>;
53
53
  /**
54
- * Appends one serialized record to the project's history log, migrating a
55
- * legacy log first.
54
+ * Appends one serialized record to the project's history log, first moving
55
+ * a log found inside `patches/`.
56
56
  *
57
57
  * @param patchesDir - The project's `patches/` directory; the project root is
58
58
  * its parent, as every caller derives it from `getProjectPaths`