@tallyrelease/core 0.4.1 → 0.4.2-beta.12

package/README.md

@@ -26,7 +26,7 @@ See `Plugin` in [`src/plugin.ts`](https://github.com/abinnovision/tallyrelease/b
 
 ## Testing
 
-The `@tallyrelease/core/testing` export provides in-memory fakes: `memoryFs`, `memoryCtx` and `memoryGit`.
+The `@tallyrelease/core/testing` export provides in-memory fakes: `memoryFs`, `memoryCtx` and `memoryGit`. The `@tallyrelease/core/testing/conformance` export provides `gitReaderConformance`, a shared `GitReader` spec that requires vitest.
 
 ## Licence
 

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+/** @deprecated Unused, will be removed in 1.0. */
 export declare const version = "0.0.0";
 export type { AffectedDoc, AffectedOptions, AffectedReason, AffectedUnit, BaseSource, } from "./affected.js";
 export type { ChangelogDependency, ChangelogInput } from "./changelog.js";

package/dist/index.js

@@ -1,3 +1,4 @@
+/** @deprecated Unused, will be removed in 1.0. */
 export const version = "0.0.0";
 export { computeAffected } from "./affected.js";
 export { maintenanceCut } from "./branches.js";

package/dist/testing/conformance.d.ts

@@ -0,0 +1,15 @@
+import type { Dag } from "./index.js";
+import type { GitReader, MaybePromise } from "../plugin.js";
+/** Builds a reader for `dag`; `sha` maps a commit id to the reader's sha. */
+export type ReaderFactory = (dag: Dag) => MaybePromise<{
+    git: GitReader;
+    sha: (id: string) => string;
+}>;
+/**
+ * Shared `GitReader` spec. Fixture: a - b - d - m - e - f on the first-parent
+ * chain, c branches from b and merges into m, d renames pkg/x.ts to pkg/y.ts,
+ * f adds a path with a quote, a tab and a non-ASCII character, g is empty and
+ * h carries footers. `a` has a later committer date than b, c and d.
+ * `introduced` runs on its own fixture.
+ */
+export declare const gitReaderConformance: (makeReader: ReaderFactory) => void;

package/dist/{testing.js → testing/conformance.js}

@@ -1,8 +1,5 @@
-import picomatch from "picomatch/posix.js";
 import { beforeAll, describe, expect, it } from "vitest";
-import { compare, uniqueSorted } from "./util.js";
-const SKIPPED = new Set([".git", "node_modules"]);
-const changed = (a, b) => uniqueSorted([...a.keys(), ...b.keys()]).filter((p) => a.get(p) !== b.get(p));
+import { compare } from "../util.js";
 /** Path git would C-quote without `-z`. */
 const ODD_PATH = 'odd/a "q"\tü.txt';
 const FOOTER_MESSAGE = "feat: h\n\nbody\n\nRelease-As: core@1.0.0\nRefs: #1";
@@ -63,145 +60,6 @@ const INTRODUCED_DAG = {
         { id: "v", files: { "pkg/a/x.ts": "v\n", "gone/x.ts": "v\n" } },
     ],
 };
-/** In-memory `ReadonlyFs` over a path-to-content map. */
-export const memoryFs = (files) => {
-    const paths = Object.keys(files).sort(compare);
-    const dirs = uniqueSorted(paths.flatMap((p) => {
-        const parts = p.split("/");
-        return parts.slice(1).map((_, i) => parts.slice(0, i + 1).join("/"));
-    }));
-    const visible = (p) => {
-        const segments = p.split("/");
-        return segments[0] !== "vendor" && !segments.some((s) => SKIPPED.has(s));
-    };
-    return {
-        read: (path) => (Object.hasOwn(files, path) ? files[path] : undefined),
-        exists: (path) => path === "." || Object.hasOwn(files, path) || dirs.includes(path),
-        glob: (patterns, opts) => {
-            const match = picomatch(patterns, { dot: true });
-            return (opts?.dirs ? dirs : paths).filter((p) => visible(p) && match(p));
-        },
-    };
-};
-/** Plugin `Ctx` over `memoryFs`; collects `log.warn` messages in `warnings`. */
-export const memoryCtx = (opts = {}) => {
-    const warnings = [];
-    const options = opts.options ?? {};
-    return {
-        options: options,
-        repo: { name: opts.repo ?? "repo" },
-        fs: memoryFs(opts.files ?? {}),
-        log: { warn: (msg) => warnings.push(msg), debug: () => undefined },
-        warnings,
-    };
-};
-/** In-memory `GitReader` over a commit graph. */
-export const memoryGit = (dag) => {
-    const nodes = new Map();
-    const node = (ref) => {
-        const id = ref === "HEAD" ? dag.commits.at(-1)?.id : ref;
-        const found = nodes.get(id ?? "") ??
-            nodes.get(dag.tags?.find((t) => t.name === ref)?.commit ?? "");
-        if (!found) {
-            throw new Error(`unknown ref "${ref}"`);
-        }
-        return found;
-    };
-    const mergeBase = (a, b) => {
-        const common = [...a.ancestors].filter((id) => b.ancestors.has(id));
-        const best = common.find((id) => !common.some((o) => o !== id && node(o).ancestors.has(id)));
-        return best === undefined ? new Map() : node(best).tree;
-    };
-    dag.commits.forEach((c, i) => {
-        const prior = dag.commits[i - 1];
-        const parents = (c.parents ?? (prior ? [prior.id] : [])).map(node);
-        const [first, ...others] = parents;
-        const tree = new Map(first?.tree);
-        for (const other of others) {
-            const base = first ? mergeBase(first, other) : new Map();
-            for (const path of changed(base, other.tree)) {
-                const content = other.tree.get(path);
-                if (content === undefined) {
-                    tree.delete(path);
-                }
-                else {
-                    tree.set(path, content);
-                }
-            }
-        }
-        for (const [path, content] of Object.entries(c.files ?? {})) {
-            if (content === null) {
-                tree.delete(path);
-            }
-            else {
-                tree.set(path, content);
-            }
-        }
-        nodes.set(c.id, {
-            id: c.id,
-            parents: parents.map((p) => p.id),
-            message: c.message ?? c.id,
-            date: c.date ?? new Date(Date.UTC(2024, 0, 1, 0, i)).toISOString(),
-            tree,
-            ancestors: new Set([c.id, ...parents.flatMap((p) => [...p.ancestors])]),
-        });
-    });
-    const firstParentChain = (to) => {
-        const chain = [];
-        for (let n = node(to); n;) {
-            chain.push(n);
-            const parent = n.parents[0];
-            n = parent === undefined ? undefined : node(parent);
-        }
-        return chain;
-    };
-    const tagRefs = () => (dag.tags ?? [])
-        .map((t) => ({ name: t.name, sha: node(t.commit).id }))
-        .sort((a, b) => compare(a.name, b.name));
-    const excluded = (from) => from === null ? new Set() : node(from).ancestors;
-    return {
-        tags: tagRefs,
-        tagsMerged: (ref) => {
-            const reachable = node(ref).ancestors;
-            return tagRefs().filter((t) => reachable.has(t.sha));
-        },
-        isAncestor: (a, b) => node(b).ancestors.has(node(a).id),
-        isFirstParentAncestor: (a, b) => {
-            const id = node(a).id;
-            return firstParentChain(b).some((n) => n.id === id);
-        },
-        log: (from, to) => {
-            const skip = excluded(from);
-            const reachable = node(to).ancestors;
-            return dag.commits
-                .map((c) => node(c.id))
-                .filter((n) => reachable.has(n.id) && !skip.has(n.id))
-                .filter((n) => n.parents.length <= 1)
-                .reverse()
-                .map((n) => ({
-                sha: n.id,
-                parents: [...n.parents],
-                message: n.message,
-                files: changed(n.parents[0] === undefined ? new Map() : node(n.parents[0]).tree, n.tree),
-                date: n.date,
-            }));
-        },
-        countFirstParent: (from, to) => {
-            const skip = excluded(from);
-            return firstParentChain(to).filter((n) => !skip.has(n.id)).length;
-        },
-        diffFiles: (from, to) => changed(node(from).tree, node(to).tree),
-        introduced: (path, to) => {
-            const under = (p) => p === path || p.startsWith(`${path}/`);
-            const intro = firstParentChain(to)
-                .reverse()
-                .find((n) => changed(n.parents[0] === undefined ? new Map() : node(n.parents[0]).tree, n.tree).some(under));
-            return intro?.id ?? null;
-        },
-        tree: (ref) => Object.fromEntries(node(ref).tree),
-        parents: (ref) => [...node(ref).parents],
-    };
-};
 /**
  * Shared `GitReader` spec. Fixture: a - b - d - m - e - f on the first-parent
  * chain, c branches from b and merges into m, d renames pkg/x.ts to pkg/y.ts,

package/dist/{testing.d.ts → testing/index.d.ts}

@@ -1,4 +1,5 @@
-import type { Ctx, GitReader, MaybePromise, ReadonlyFs } from "./plugin.js";
+import type { Ctx, GitReader, ReadonlyFs } from "../plugin.js";
+import type { ReaderFactory } from "./conformance.js";
 /** In-memory `ReadonlyFs` over a path-to-content map. */
 export declare const memoryFs: (files: Record<string, string>) => ReadonlyFs;
 export interface MemoryCtxOptions<O> {
@@ -42,16 +43,6 @@ export interface MemoryGit extends GitReader {
 }
 /** In-memory `GitReader` over a commit graph. */
 export declare const memoryGit: (dag: Dag) => MemoryGit;
-/** Builds a reader for `dag`; `sha` maps a commit id to the reader's sha. */
-export type ReaderFactory = (dag: Dag) => MaybePromise<{
-    git: GitReader;
-    sha: (id: string) => string;
-}>;
-/**
- * Shared `GitReader` spec. Fixture: a - b - d - m - e - f on the first-parent
- * chain, c branches from b and merges into m, d renames pkg/x.ts to pkg/y.ts,
- * f adds a path with a quote, a tab and a non-ASCII character, g is empty and
- * h carries footers. `a` has a later committer date than b, c and d.
- * `introduced` runs on its own fixture.
- */
+export type { ReaderFactory } from "./conformance.js";
+/** Re-export of `@tallyrelease/core/testing/conformance`; requires vitest. */
 export declare const gitReaderConformance: (makeReader: ReaderFactory) => void;

package/dist/testing/index.js

@@ -0,0 +1,158 @@
+import picomatch from "picomatch/posix.js";
+import { compare, uniqueSorted } from "../util.js";
+// Loaded optionally so the fakes work without vitest installed.
+// eslint-disable-next-line no-restricted-syntax
+const conformance = await import("./conformance.js").catch((error) => {
+    if (error.code === "ERR_MODULE_NOT_FOUND") {
+        return null;
+    }
+    throw error;
+});
+const SKIPPED = new Set([".git", "node_modules"]);
+const changed = (a, b) => uniqueSorted([...a.keys(), ...b.keys()]).filter((p) => a.get(p) !== b.get(p));
+/** In-memory `ReadonlyFs` over a path-to-content map. */
+export const memoryFs = (files) => {
+    const paths = Object.keys(files).sort(compare);
+    const dirs = uniqueSorted(paths.flatMap((p) => {
+        const parts = p.split("/");
+        return parts.slice(1).map((_, i) => parts.slice(0, i + 1).join("/"));
+    }));
+    const visible = (p) => {
+        const segments = p.split("/");
+        return segments[0] !== "vendor" && !segments.some((s) => SKIPPED.has(s));
+    };
+    return {
+        read: (path) => (Object.hasOwn(files, path) ? files[path] : undefined),
+        exists: (path) => path === "." || Object.hasOwn(files, path) || dirs.includes(path),
+        glob: (patterns, opts) => {
+            const match = picomatch(patterns, { dot: true });
+            return (opts?.dirs ? dirs : paths).filter((p) => visible(p) && match(p));
+        },
+    };
+};
+/** Plugin `Ctx` over `memoryFs`; collects `log.warn` messages in `warnings`. */
+export const memoryCtx = (opts = {}) => {
+    const warnings = [];
+    const options = opts.options ?? {};
+    return {
+        options: options,
+        repo: { name: opts.repo ?? "repo" },
+        fs: memoryFs(opts.files ?? {}),
+        log: { warn: (msg) => warnings.push(msg), debug: () => undefined },
+        warnings,
+    };
+};
+/** In-memory `GitReader` over a commit graph. */
+export const memoryGit = (dag) => {
+    const nodes = new Map();
+    const node = (ref) => {
+        const id = ref === "HEAD" ? dag.commits.at(-1)?.id : ref;
+        const found = nodes.get(id ?? "") ??
+            nodes.get(dag.tags?.find((t) => t.name === ref)?.commit ?? "");
+        if (!found) {
+            throw new Error(`unknown ref "${ref}"`);
+        }
+        return found;
+    };
+    const mergeBase = (a, b) => {
+        const common = [...a.ancestors].filter((id) => b.ancestors.has(id));
+        const best = common.find((id) => !common.some((o) => o !== id && node(o).ancestors.has(id)));
+        return best === undefined ? new Map() : node(best).tree;
+    };
+    dag.commits.forEach((c, i) => {
+        const prior = dag.commits[i - 1];
+        const parents = (c.parents ?? (prior ? [prior.id] : [])).map(node);
+        const [first, ...others] = parents;
+        const tree = new Map(first?.tree);
+        for (const other of others) {
+            const base = first ? mergeBase(first, other) : new Map();
+            for (const path of changed(base, other.tree)) {
+                const content = other.tree.get(path);
+                if (content === undefined) {
+                    tree.delete(path);
+                }
+                else {
+                    tree.set(path, content);
+                }
+            }
+        }
+        for (const [path, content] of Object.entries(c.files ?? {})) {
+            if (content === null) {
+                tree.delete(path);
+            }
+            else {
+                tree.set(path, content);
+            }
+        }
+        nodes.set(c.id, {
+            id: c.id,
+            parents: parents.map((p) => p.id),
+            message: c.message ?? c.id,
+            date: c.date ?? new Date(Date.UTC(2024, 0, 1, 0, i)).toISOString(),
+            tree,
+            ancestors: new Set([c.id, ...parents.flatMap((p) => [...p.ancestors])]),
+        });
+    });
+    const firstParentChain = (to) => {
+        const chain = [];
+        for (let n = node(to); n;) {
+            chain.push(n);
+            const parent = n.parents[0];
+            n = parent === undefined ? undefined : node(parent);
+        }
+        return chain;
+    };
+    const tagRefs = () => (dag.tags ?? [])
+        .map((t) => ({ name: t.name, sha: node(t.commit).id }))
+        .sort((a, b) => compare(a.name, b.name));
+    const excluded = (from) => from === null ? new Set() : node(from).ancestors;
+    return {
+        tags: tagRefs,
+        tagsMerged: (ref) => {
+            const reachable = node(ref).ancestors;
+            return tagRefs().filter((t) => reachable.has(t.sha));
+        },
+        isAncestor: (a, b) => node(b).ancestors.has(node(a).id),
+        isFirstParentAncestor: (a, b) => {
+            const id = node(a).id;
+            return firstParentChain(b).some((n) => n.id === id);
+        },
+        log: (from, to) => {
+            const skip = excluded(from);
+            const reachable = node(to).ancestors;
+            return dag.commits
+                .map((c) => node(c.id))
+                .filter((n) => reachable.has(n.id) && !skip.has(n.id))
+                .filter((n) => n.parents.length <= 1)
+                .reverse()
+                .map((n) => ({
+                sha: n.id,
+                parents: [...n.parents],
+                message: n.message,
+                files: changed(n.parents[0] === undefined ? new Map() : node(n.parents[0]).tree, n.tree),
+                date: n.date,
+            }));
+        },
+        countFirstParent: (from, to) => {
+            const skip = excluded(from);
+            return firstParentChain(to).filter((n) => !skip.has(n.id)).length;
+        },
+        diffFiles: (from, to) => changed(node(from).tree, node(to).tree),
+        introduced: (path, to) => {
+            const under = (p) => p === path || p.startsWith(`${path}/`);
+            const intro = firstParentChain(to)
+                .reverse()
+                .find((n) => changed(n.parents[0] === undefined ? new Map() : node(n.parents[0]).tree, n.tree).some(under));
+            return intro?.id ?? null;
+        },
+        tree: (ref) => Object.fromEntries(node(ref).tree),
+        parents: (ref) => [...node(ref).parents],
+    };
+};
+/** Re-export of `@tallyrelease/core/testing/conformance`; requires vitest. */
+export const gitReaderConformance = (makeReader) => {
+    if (conformance === null) {
+        throw new Error("gitReaderConformance requires vitest");
+    }
+    conformance.gitReaderConformance(makeReader);
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tallyrelease/core",
-  "version": "0.4.1",
+  "version": "0.4.2-beta.12",
   "description": "Pure planning core of tallyrelease",
   "repository": {
     "type": "git",
@@ -21,9 +21,14 @@
       "default": "./dist/index.js"
     },
     "./testing": {
-      "types": "./dist/testing.d.ts",
-      "import": "./dist/testing.js",
-      "default": "./dist/testing.js"
+      "types": "./dist/testing/index.d.ts",
+      "import": "./dist/testing/index.js",
+      "default": "./dist/testing/index.js"
+    },
+    "./testing/conformance": {
+      "types": "./dist/testing/conformance.d.ts",
+      "import": "./dist/testing/conformance.js",
+      "default": "./dist/testing/conformance.js"
     }
   },
   "files": [
@@ -31,7 +36,7 @@
   ],
   "scripts": {
     "build": "tsc --build tsconfig.build.json",
-    "check:purity": "node scripts/check-purity.mjs src/index.ts",
+    "check:purity": "node ../../tools/check-purity.mjs src/index.ts",
     "format:check": "prettier --check '{{src,test}/**/*,*}.{{t,j}s{,x},json{,5},md,y{,a}ml,css,html,gql,graphql}'",
     "format:fix": "prettier --write '{{src,test}/**/*,*}.{{t,j}s{,x},json{,5},md,y{,a}ml,css,html,gql,graphql}'",
     "lint:check": "eslint '{{src,test}/**/*,*}.{t,j}s{,x}'",
@@ -58,7 +63,6 @@
     "@types/picomatch": "^4.0.3",
     "@types/semver": "^7.8.0",
     "@vitest/coverage-v8": "^5.0.4",
-    "esbuild": "^0.28.2",
     "eslint": "^10.12.0",
     "prettier": "^3.9.10",
     "typescript": "^6.0.3",
@@ -86,9 +90,14 @@
         "default": "./dist/index.js"
       },
       "./testing": {
-        "types": "./dist/testing.d.ts",
-        "import": "./dist/testing.js",
-        "default": "./dist/testing.js"
+        "types": "./dist/testing/index.d.ts",
+        "import": "./dist/testing/index.js",
+        "default": "./dist/testing/index.js"
+      },
+      "./testing/conformance": {
+        "types": "./dist/testing/conformance.d.ts",
+        "import": "./dist/testing/conformance.js",
+        "default": "./dist/testing/conformance.js"
       }
     },
     "npm": true