@absolutejs/changelog 0.1.1 → 0.2.0

package/CHANGELOG.md

@@ -6,6 +6,27 @@ This file is generated by `absolute-changelog` from the entries in
 `changelog/`. Edit an entry, not this file — and add new ones under
 `changelog/unreleased/`.
 
+## 0.2.0 — 2026-09-10
+
+### Added
+
+- **Adopting writes a prepublishOnly gate, so no publish can go round the check**
+- **Entries can be written against the package's own API, so a symbol that is not an export is a compile error** (`Change`, `change`)
+- **Reconciliation reports migrations that do not describe what the package did** (`Reconciliation`)
+- **The gate catches a package that stopped shipping the documents, and files in the entry directory that no release will read** (`strayEntries`)
+- **The gate checks that a migration describes what the package actually did** (`reconcile`)
+
+### Fixed
+
+- **Compare against the newest published version, not the one being published** (`packageVersions`)
+- **Read a document written against an older contract rather than refusing it** (`parseChangelog`)
+
+## 0.1.2 — 2026-09-10
+
+### Fixed
+
+- **Keep each package.json's own indentation when writing it back** (`writeJsonLike`)
+
 ## 0.1.1 — 2026-09-10
 
 ### Fixed

package/changelog.json

@@ -1,31 +1,99 @@
 {
-  "contract": 1,
-  "name": "@absolutejs/changelog",
-  "releases": [
-    {
-      "changes": [
-        {
-          "kind": "fixed",
-          "summary": "Fall back to the full packument when the registry has not built the abbreviated one yet",
-          "symbols": ["packageVersions"]
-        },
-        {
-          "kind": "fixed",
-          "summary": "Keep the formatter off the generated changelog copies when adopting"
-        }
-      ],
-      "date": "2026-09-10",
-      "version": "0.1.1"
-    },
-    {
-      "changes": [
-        {
-          "kind": "added",
-          "summary": "The changelog contract: typed entries, a gate that checks them against the package's own types, and migrations as data"
-        }
-      ],
-      "date": "2026-09-10",
-      "version": "0.1.0"
-    }
-  ]
+	"contract": 1,
+	"name": "@absolutejs/changelog",
+	"releases": [
+		{
+			"changes": [
+				{
+					"kind": "added",
+					"summary": "Adopting writes a prepublishOnly gate, so no publish can go round the check"
+				},
+				{
+					"kind": "fixed",
+					"summary": "Compare against the newest published version, not the one being published",
+					"symbols": [
+						"packageVersions"
+					]
+				},
+				{
+					"kind": "added",
+					"summary": "Entries can be written against the package's own API, so a symbol that is not an export is a compile error",
+					"symbols": [
+						"Change",
+						"change"
+					]
+				},
+				{
+					"kind": "fixed",
+					"summary": "Read a document written against an older contract rather than refusing it",
+					"symbols": [
+						"parseChangelog"
+					]
+				},
+				{
+					"kind": "added",
+					"summary": "Reconciliation reports migrations that do not describe what the package did",
+					"symbols": [
+						"Reconciliation"
+					]
+				},
+				{
+					"kind": "added",
+					"summary": "The gate catches a package that stopped shipping the documents, and files in the entry directory that no release will read",
+					"symbols": [
+						"strayEntries"
+					]
+				},
+				{
+					"kind": "added",
+					"summary": "The gate checks that a migration describes what the package actually did",
+					"symbols": [
+						"reconcile"
+					]
+				}
+			],
+			"date": "2026-09-10",
+			"version": "0.2.0"
+		},
+		{
+			"changes": [
+				{
+					"kind": "fixed",
+					"summary": "Keep each package.json's own indentation when writing it back",
+					"symbols": [
+						"writeJsonLike"
+					]
+				}
+			],
+			"date": "2026-09-10",
+			"version": "0.1.2"
+		},
+		{
+			"changes": [
+				{
+					"kind": "fixed",
+					"summary": "Fall back to the full packument when the registry has not built the abbreviated one yet",
+					"symbols": [
+						"packageVersions"
+					]
+				},
+				{
+					"kind": "fixed",
+					"summary": "Keep the formatter off the generated changelog copies when adopting"
+				}
+			],
+			"date": "2026-09-10",
+			"version": "0.1.1"
+		},
+		{
+			"changes": [
+				{
+					"kind": "added",
+					"summary": "The changelog contract: typed entries, a gate that checks them against the package's own types, and migrations as data"
+				}
+			],
+			"date": "2026-09-10",
+			"version": "0.1.0"
+		}
+	]
 }

package/dist/cli.js

@@ -3,7 +3,7 @@
 
 // src/cli.ts
 import { existsSync } from "fs";
-import { mkdir, readFile as readFile2, rm, writeFile } from "fs/promises";
+import { mkdir, readFile as readFile3, rm, writeFile as writeFile2 } from "fs/promises";
 import { join as join2 } from "path";
 
 // src/entries.ts
@@ -235,8 +235,8 @@ var parseChangelog = (value) => {
     return { problems: ["not an object"] };
   if (!isText(value.name))
     problems.push("needs a package name");
-  if (value.contract !== CHANGELOG_CONTRACT)
-    problems.push(`contract ${JSON.stringify(value.contract)} is not ${CHANGELOG_CONTRACT}`);
+  if (typeof value.contract !== "number" || value.contract > CHANGELOG_CONTRACT)
+    problems.push(`contract ${JSON.stringify(value.contract)} is newer than ${CHANGELOG_CONTRACT}, which this reader understands`);
   const raw = value.releases;
   if (!Array.isArray(raw))
     problems.push("releases is not a list");
@@ -535,29 +535,84 @@ var readJsonFile = async (path) => {
     return;
   }
 };
+var strayEntries = async (packageRoot) => {
+  const names = await readdir(join(packageRoot, UNRELEASED_DIRECTORY)).catch(() => []);
+  return names.filter((name) => !ENTRY.test(name) && name !== ".gitkeep" && !name.startsWith("."));
+};
+
+// src/json.ts
+import { readFile as readFile2, writeFile } from "fs/promises";
+var indentOf = (source) => {
+  const found = /\n([\t ]+)\S/u.exec(source)?.[1];
+  return found === undefined || found === "" ? "\t" : found;
+};
+var writeJsonLike = async (path, document) => {
+  const source = await readFile2(path, "utf8").catch(() => "");
+  await writeFile(path, `${JSON.stringify(document, null, indentOf(source))}
+`);
+};
 
 // src/reconcile.ts
+var migrationHolds = (input) => {
+  const { after, change, subpaths } = input;
+  const wrong = [];
+  const { migration } = change;
+  if ("rename" in migration) {
+    const { from } = migration.rename;
+    const into = migration.rename.to;
+    if (!after.has(into))
+      wrong.push(`\`${change.summary}\` renames to \`${into}\`, which this version does not export`);
+    if (after.has(from))
+      wrong.push(`\`${change.summary}\` renames \`${from}\` away, but this version still exports it`);
+    if (!change.symbols.includes(from))
+      wrong.push(`\`${change.summary}\` renames \`${from}\`, which is not in its own symbols`);
+  }
+  if ("moved" in migration) {
+    const { symbol } = migration.moved;
+    const into = migration.moved.to;
+    if (!after.has(symbol))
+      wrong.push(`\`${change.summary}\` moves \`${symbol}\`, which this version does not export`);
+    if (subpaths.size > 0 && !subpaths.has(into))
+      wrong.push(`\`${change.summary}\` moves \`${symbol}\` to \`${into}\`, which is not an entry point of this package`);
+  }
+  if ("resubpath" in migration && subpaths.size > 0 && !subpaths.has(migration.resubpath.to))
+    wrong.push(`\`${change.summary}\` points at \`${migration.resubpath.to}\`, which is not an entry point of this package`);
+  if (change.kind === "removed") {
+    for (const symbol of change.symbols)
+      if (after.has(symbol))
+        wrong.push(`\`${change.summary}\` says \`${symbol}\` was removed, but this version still exports it`);
+  }
+  return wrong;
+};
 var describeReconciliation = (found) => {
   const lines = [];
   for (const entry of found.unannounced)
     lines.push(entry.kind === "removed" ? `\`${entry.name}\` is no longer exported and no entry says so` : `\`${entry.name}\` changed its ${entry.kind} and no entry says so`);
   for (const name of found.unknownSymbols)
     lines.push(`an entry names \`${name}\`, which this package does not export`);
+  lines.push(...found.wrongMigrations);
   return lines;
 };
 var reconcile = (input) => {
-  const announced = new Set(input.changes.filter(isDisruptive).flatMap((change) => [...change.symbols]));
+  const disruptive = new Set(input.changes.filter(isDisruptive).flatMap((change) => [...change.symbols]));
+  const mentioned = new Set(input.changes.flatMap((change) => [...change.symbols ?? []]));
   const unannounced = [
-    ...input.diff.removed.map((name) => ({ kind: "removed", name })),
-    ...notable(input.diff).map((change) => ({
+    ...input.diff.removed.filter((name) => !disruptive.has(name)).map((name) => ({ kind: "removed", name })),
+    ...notable(input.diff).filter((change) => !mentioned.has(change.name)).map((change) => ({
       kind: change.shape === "parameters" ? "parameters" : "members",
       name: change.name
     }))
-  ].filter((entry) => !announced.has(entry.name));
+  ];
   const unknownSymbols = [
     ...new Set(input.changes.flatMap((change) => [...change.symbols ?? []]).filter((name) => !input.known.has(name)))
   ];
-  return { unannounced, unknownSymbols };
+  const { after } = input;
+  const wrongMigrations = after === undefined ? [] : input.changes.filter(isDisruptive).flatMap((change) => migrationHolds({
+    after,
+    change,
+    subpaths: input.subpaths ?? new Set
+  }));
+  return { unannounced, unknownSymbols, wrongMigrations };
 };
 
 // src/registry.ts
@@ -798,16 +853,22 @@ var readChangelog = async (root, name) => {
   `));
   return read.changelog;
 };
-var historyOf = async (root) => readFile2(changelogPaths(root).history, "utf8").catch(() => {
+var historyOf = async (root) => readFile3(changelogPaths(root).history, "utf8").catch(() => {
   return;
 });
 var writeBoth = async (root, changelog) => {
   const paths = changelogPaths(root);
   const history = await historyOf(root);
-  await writeFile(paths.json, renderChangelogJson(changelog));
-  await writeFile(paths.markdown, renderMarkdown(changelog, history === undefined ? {} : { history }));
+  await writeFile2(paths.json, renderChangelogJson(changelog));
+  await writeFile2(paths.markdown, renderMarkdown(changelog, history === undefined ? {} : { history }));
 };
 var slug = (summary) => summary.toLowerCase().replace(/[^a-z0-9]+/gu, "-").replace(/^-|-$/gu, "").slice(0, SLUG_MAX_LENGTH) || "change";
+var sourceEntryOf = (root) => {
+  for (const candidate of ["src/index.ts", "src/index.tsx", "index.ts"])
+    if (existsSync(join2(root, candidate)))
+      return `../../${candidate.replace(/\.tsx?$/u, "")}`;
+  return;
+};
 var add = async (root, flags) => {
   const kind = text(flags, "kind");
   const summary = text(flags, "summary");
@@ -831,10 +892,12 @@ var add = async (root, flags) => {
   ] : [
     `	migration: { instruction: ${JSON.stringify(instruction)}, manual: true },`
   ];
+  const api = sourceEntryOf(root);
   const body = [
+    ...api === undefined ? [] : [`import type * as Api from '${api}';`],
     "import type { Change } from '@absolutejs/changelog';",
     "",
-    "export const change: Change = {",
+    `export const change: Change${api === undefined ? "" : "<typeof Api>"} = {`,
     `	kind: ${JSON.stringify(kind)},`,
     ...disruptive ? migration : [],
     `	summary: ${JSON.stringify(summary)}${symbols.length > 0 ? "," : ""}`,
@@ -846,7 +909,7 @@ var add = async (root, flags) => {
   const directory = join2(root, UNRELEASED_DIRECTORY);
   await mkdir(directory, { recursive: true });
   const file = join2(directory, `${slug(summary)}.ts`);
-  await writeFile(file, body);
+  await writeFile2(file, body);
   console.log(`wrote ${file}`);
 };
 var release = async (root, flags) => {
@@ -892,8 +955,7 @@ var release = async (root, flags) => {
     return;
   }
   await writeBoth(root, written);
-  await writeFile(join2(root, "package.json"), `${JSON.stringify({ ...manifest, version }, null, "\t")}
-`);
+  await writeJsonLike(join2(root, "package.json"), { ...manifest, version });
   await Promise.all(entries.map((entry) => rm(join2(root, entry.file), { force: true })));
   console.log(`${manifest.name} ${manifest.version} \u2192 ${version} (${entries.length} change${entries.length === 1 ? "" : "s"})`);
 };
@@ -919,7 +981,7 @@ var check = async (root, flags) => {
     failures.push(`${CHANGELOG_FILE} is for ${current.name}, not ${manifest.name}`);
   const history = await historyOf(root);
   const expected = renderMarkdown(current, history === undefined ? {} : { history });
-  const actual = await readFile2(changelogPaths(root).markdown, "utf8").catch(() => {
+  const actual = await readFile3(changelogPaths(root).markdown, "utf8").catch(() => {
     return;
   });
   if (newest !== undefined && actual !== expected)
@@ -928,23 +990,46 @@ var check = async (root, flags) => {
   const include = isPackage(tsconfig) ? tsconfig.include : undefined;
   if (Array.isArray(include) && !coversEntries(include))
     failures.push('tsconfig.json does not compile changelog/, so nothing is checking the entries \u2014 add "changelog/**/*" to its include list');
+  for (const stray of await strayEntries(root))
+    failures.push(`${UNRELEASED_DIRECTORY}/${stray} is not an entry, so no release will ever read it`);
+  const shipped = Array.isArray(manifest.files) ? manifest.files : [];
+  for (const file of [CHANGELOG_FILE, CHANGELOG_MARKDOWN])
+    if (shipped.length > 0 && !shipped.includes(file))
+      failures.push(`package.json does not ship ${file}`);
   const offline = flags.offline === true;
   const built = await builtSurface(root);
-  if (!offline && built !== undefined && newest !== undefined) {
-    const published = await publishedSurface(manifest.name ?? "", newest.version);
+  const versions = offline ? undefined : await packageVersions(manifest.name ?? "");
+  const baseline = (versions?.published ?? []).filter((version) => compareVersions(version, manifest.version) <= 0).sort(compareVersions).at(LAST3);
+  if (!offline && built !== undefined && baseline !== undefined) {
+    const published = await publishedSurface(manifest.name ?? "", baseline);
     if (published === undefined)
-      console.warn(`  (could not read ${manifest.name}@${newest.version} from the registry; the types were not checked)`);
+      console.warn(`  (could not read ${manifest.name}@${baseline} from the registry; the types were not checked)`);
+    const speaking = [
+      ...entries.map((entry) => entry.change),
+      ...current.releases.filter((entry) => compareVersions(entry.version, baseline) > 0).flatMap((entry) => [...entry.changes])
+    ];
     failures.push(...published === undefined ? [] : describeReconciliation(reconcile({
-      changes: entries.map((entry) => entry.change),
+      after: new Set(built.keys()),
+      changes: speaking,
       diff: diffSurface(published, built),
-      known: new Set([...published.keys(), ...built.keys()])
+      known: new Set([...published.keys(), ...built.keys()]),
+      subpaths: subpathsOf(manifest)
     })));
   }
+  if (!offline && built === undefined)
+    console.warn("  (no dist to read, so the types were not checked \u2014 run the build before the gate)");
   if (failures.length > 0)
     throw new CliError(["This package\u2019s changelog does not hold:", ...failures].join(`
   `));
   console.log(`${manifest.name}@${manifest.version}: changelog holds (${entries.length} pending, ${current.releases.length} released)`);
 };
+var LAST3 = -1;
+var subpathsOf = (manifest) => {
+  const { exports } = manifest;
+  if (typeof exports !== "object" || exports === null)
+    return new Set;
+  return new Set(Object.keys(exports).map((key) => key === "." ? manifest.name ?? "" : `${manifest.name}${key.slice(1)}`));
+};
 var CHECKING_CONFIGS = ["tsconfig.json", "tsconfig.eslint.json"];
 var coversEntries = (include) => Array.isArray(include) && include.some((entry) => typeof entry === "string" && entry.startsWith("changelog"));
 var includeEntriesIn = async (root, file) => {
@@ -954,8 +1039,10 @@ var includeEntriesIn = async (root, file) => {
     return false;
   if (coversEntries(document.include))
     return false;
-  await writeFile(path, `${JSON.stringify({ ...document, include: [...document.include, "changelog/**/*"] }, null, "\t")}
-`);
+  await writeJsonLike(path, {
+    ...document,
+    include: [...document.include, "changelog/**/*"]
+  });
   return true;
 };
 var includeEntries = async (root) => {
@@ -964,7 +1051,7 @@ var includeEntries = async (root) => {
 };
 var ignoreGenerated = async (root) => {
   const path = join2(root, ".prettierignore");
-  const existing = await readFile2(path, "utf8").catch(() => "");
+  const existing = await readFile3(path, "utf8").catch(() => "");
   const wanted = [CHANGELOG_FILE, CHANGELOG_MARKDOWN].filter((name) => !existing.split(`
 `).includes(name));
   if (wanted.length === 0)
@@ -972,26 +1059,40 @@ var ignoreGenerated = async (root) => {
   const head = existing.trim() === "" ? `# Generated by absolute-changelog. Edit the entries, not these.
 ` : `${existing.trimEnd()}
 `;
-  await writeFile(path, `${head}${wanted.join(`
+  await writeFile2(path, `${head}${wanted.join(`
 `)}
 `);
 };
+var PUBLISH_GATE = "absolute-changelog check";
+var withPublishGate = (scripts) => {
+  const existing = scripts.prepublishOnly;
+  if (typeof existing === "string" && existing.includes(PUBLISH_GATE))
+    return;
+  return {
+    ...scripts,
+    prepublishOnly: typeof existing === "string" && existing.trim() !== "" ? `${existing} && ${PUBLISH_GATE}` : PUBLISH_GATE
+  };
+};
 var adopt = async (root) => {
   const manifest = await readPackage(root);
   const paths = changelogPaths(root);
   await mkdir(paths.unreleased, { recursive: true });
-  await writeFile(join2(paths.unreleased, ".gitkeep"), "# Entries wait here. One file per change; `absolute-changelog release` consumes them.\n");
+  await writeFile2(join2(paths.unreleased, ".gitkeep"), "# Entries wait here. One file per change; `absolute-changelog release` consumes them.\n");
   if (existsSync(paths.markdown) && !existsSync(paths.history)) {
-    const previous = await readFile2(paths.markdown, "utf8");
+    const previous = await readFile3(paths.markdown, "utf8");
     await mkdir(join2(root, "changelog"), { recursive: true });
-    await writeFile(paths.history, previous.replace(/^#\s+Changelog\s*/u, "").trimStart());
+    await writeFile2(paths.history, previous.replace(/^#\s+Changelog\s*/u, "").trimStart());
     await rm(paths.markdown, { force: true });
   }
   const files = manifest.files ?? [];
   const wanted = [CHANGELOG_FILE, CHANGELOG_MARKDOWN].filter((entry) => !files.includes(entry));
-  if (wanted.length > 0)
-    await writeFile(join2(root, "package.json"), `${JSON.stringify({ ...manifest, files: [...files, ...wanted].sort() }, null, "\t")}
-`);
+  const scripts = typeof manifest.scripts === "object" && manifest.scripts !== null ? withPublishGate(manifest.scripts) : undefined;
+  if (wanted.length > 0 || scripts !== undefined)
+    await writeJsonLike(join2(root, "package.json"), {
+      ...manifest,
+      ...scripts === undefined ? {} : { scripts },
+      files: [...files, ...wanted].sort()
+    });
   await ignoreGenerated(root);
   const note = await includeEntries(root);
   if (note !== undefined)
@@ -1019,5 +1120,5 @@ await main().catch((error) => {
   process.exit(1);
 });
 
-//# debugId=20166C506E99909264756E2164756E21
+//# debugId=7CE32A12E2B0BC0C64756E2164756E21
 //# sourceMappingURL=cli.js.map