@bongos/core 1.19.410 → 1.19.411

package/tests/bump_version.mjs

@@ -4,7 +4,10 @@
 // These tests pin the three properties that must survive any refactor:
 //   1. the bumped literal keeps the exact `^const CORE_VERSION = '…';` shape
 //      deploy-divergence.js greps and regex-reads;
-//   2. a changelog entry lands inside the comment block, not after the const;
+//   2. a changelog entry lands above the ledger's closing divider in
+//      docs/module-api-changelog.md (ADR 0203 moved the ledger out of
+//      src/module-api.js — appending to it there grew the file past the
+//      oversized-file fitness ratchet and broke `unit` on main);
 //   3. unrecognizable input throws instead of silently mis-editing.
 
 import test from 'node:test';
@@ -22,16 +25,28 @@ const { bumpPatch, CONST_RE } = bump;
 const { execFileSync } = require('node:child_process');
 
 const SAMPLE = [
-  '// prologue',
-  '//   1.19.0 — some entry. (task 1)',
-  '//   1.19.1 — another entry. (task 2)',
   '// ---------------------------------------------------------------------------',
-  "const CORE_VERSION = '1.19.1'; // carrier; see changelog above",
+  '// CORE_VERSION — the changelog lives in docs/module-api-changelog.md.',
+  '// ---------------------------------------------------------------------------',
+  "const CORE_VERSION = '1.19.1'; // carrier; changelog: docs/module-api-changelog.md",
   '',
   'module.exports = { CORE_VERSION };',
   '',
 ].join('\n');
 
+// The ledger's shape: a fenced text block, oldest entry first, closed by the
+// divider each new entry is inserted immediately above.
+const SAMPLE_CHANGELOG = [
+  '# `CORE_VERSION` changelog',
+  '',
+  '```text',
+  '1.19.0 — some entry. (task 1)',
+  '  1.19.1 — another entry. (task 2)',
+  '---------------------------------------------------------------------------',
+  '```',
+  '',
+].join('\n');
+
 test('bumps patch and keeps the exact const line shape', () => {
   const { from, to, text } = bumpPatch(SAMPLE);
   assert.equal(from, '1.19.1');
@@ -43,13 +58,29 @@ test('bumps patch and keeps the exact const line shape', () => {
   assert.equal([...text.matchAll(/^const CORE_VERSION = /gm)].length, 1);
 });
 
+test('the const line points a reader at the ledger, wherever it moved to', () => {
+  // The pointer is the whole reason moving the changelog out is safe: someone
+  // grepping src/module-api.js for the history must be told where it went.
+  const { text } = bumpPatch(SAMPLE);
+  assert.match(text, /^const CORE_VERSION = .*docs\/module-api-changelog\.md/m);
+});
+
 test('inserts the changelog entry above the divider, mentioning both versions', () => {
-  const { text } = bumpPatch(SAMPLE, { note: 'run 42' });
-  const dividerAt = text.indexOf('// ------');
-  const entryAt = text.indexOf('1.19.2 — CI auto-patch');
+  const { changelogText } = bumpPatch(SAMPLE, { note: 'run 42', changelog: SAMPLE_CHANGELOG });
+  const dividerAt = changelogText.indexOf('\n---------');
+  const entryAt = changelogText.indexOf('1.19.2 — CI auto-patch');
   assert.ok(entryAt !== -1, 'entry exists');
-  assert.ok(entryAt < dividerAt, 'entry sits inside the changelog block, above the divider');
-  assert.match(text, /landed since 1\.19\.1 with no explicit bump\. run 42\./);
+  assert.ok(entryAt < dividerAt, 'entry sits inside the ledger, above its closing divider');
+  assert.match(changelogText, /landed since 1\.19\.1 with no explicit bump\. run 42\./);
+  // oldest-first ordering survives: the new entry is the LAST one.
+  assert.ok(changelogText.indexOf('1.19.1 — another entry') < entryAt, 'newest entry lands last');
+  // the entry is a comment-free ledger line — no `//` scaffolding leaks back in.
+  assert.equal(/^\s*\/\//m.test(changelogText.slice(entryAt - 4, entryAt)), false);
+});
+
+test('without a changelog the ledger is untouched, never silently half-written', () => {
+  const { changelogText } = bumpPatch(SAMPLE);
+  assert.equal(changelogText, null, 'no ledger in, no ledger out — main() refuses this case');
 });
 
 test('a 9→10 patch rollover carries, not truncates', () => {
@@ -61,16 +92,31 @@ test('a 9→10 patch rollover carries, not truncates', () => {
 test('unrecognizable input throws loudly instead of mis-editing', () => {
   assert.throws(() => bumpPatch('nothing here'), /could not find the CORE_VERSION literal/);
   assert.throws(
-    () => bumpPatch("const CORE_VERSION = '1.2.3'; // no divider above"),
+    () => bumpPatch(SAMPLE, { changelog: '# a ledger with no closing divider\n' }),
     /changelog closing divider/
   );
 });
 
-test('the REAL src/module-api.js is bumpable right now (shape not drifted)', () => {
+test('the REAL src/module-api.js + ledger are bumpable right now (shape not drifted)', () => {
   const real = fs.readFileSync(path.join(ROOT, 'src', 'module-api.js'), 'utf8');
-  const { from, to, text } = bumpPatch(real);
+  const ledger = fs.readFileSync(path.join(ROOT, 'docs', 'module-api-changelog.md'), 'utf8');
+  const { from, to, text, changelogText } = bumpPatch(real, { changelog: ledger });
   assert.match(from, /^\d+\.\d+\.\d+$/);
   assert.ok(text.includes(`const CORE_VERSION = '${to}';`));
+  assert.ok(changelogText.includes(`${to} — CI auto-patch`), 'the real ledger takes the entry');
+  assert.ok(changelogText.length > ledger.length, 'the real ledger grew');
+});
+
+test('the ledger is NOT a .js file — the ratchet that forced the move stays satisfied', () => {
+  // ADR 0203: the carrier appends on every release and pushes straight to main.
+  // Inside a .js file that growth trips scripts/gds/fitness-ratchets.js's
+  // oversized_file_count (it counts `git ls-files '*.js'`) and turns `unit` red
+  // for main and every open PR at once. Markdown is the whole fix.
+  const rel = 'docs/module-api-changelog.md';
+  assert.equal(rel.endsWith('.js'), false);
+  assert.ok(fs.existsSync(path.join(ROOT, rel)), 'the ledger exists where the carrier writes it');
+  const api = fs.readFileSync(path.join(ROOT, 'src', 'module-api.js'), 'utf8').split('\n').length;
+  assert.ok(api <= 1500, `src/module-api.js is ${api} lines — the 1500-line ratchet is the reason the ledger moved`);
 });
 
 // ---- isReleaseCommit: the cascade terminator (task 1002636) ----
@@ -108,6 +154,19 @@ test('work-merge subjects, junk, and empties never match', () => {
   assert.equal(RELEASE_COMMIT_RE.source.startsWith('^'), true, 'anchored — a subject QUOTING a release message must not match');
 });
 
+test('publish.yml stages BOTH files the bump writes (ADR 0203)', () => {
+  // The carrier writes two files now. Staging only src/module-api.js would push
+  // a version whose changelog entry never left the runner — the ledger main
+  // carries would fall one entry behind on every release, forever, and nobody
+  // would see it until someone went looking for a version's history.
+  const m = PUBLISH_YML.match(/^\s*git add (.+)$/m);
+  assert.ok(m, 'publish.yml must stage the bump');
+  const staged = m[1].trim().split(/\s+/);
+  for (const f of ['src/module-api.js', 'docs/module-api-changelog.md']) {
+    assert.ok(staged.includes(f), `publish.yml must \`git add\` ${f} — it is written by bump-version.js --apply`);
+  }
+});
+
 test('publish.yml wires the terminator: guard step present, every armed step gated', () => {
   assert.ok(PUBLISH_YML.includes('id: relhead'), 'the Already released? guard step exists');
   assert.match(PUBLISH_YML, /isReleaseCommit/, 'the guard delegates to bump-version.js — single source');