docsgov 0.1.0 → 0.1.1

package/dist/repo/repo.test.js

@@ -5,27 +5,27 @@ import { find } from "./repo.js";
 import { makeDir } from "./testutil.js";
 const dec = new TextDecoder();
 describe("find: repo-root discovery", () => {
-    // WHY: when a .docgov/ exists in the ancestor chain, that ancestor is the
+    // WHY: when a .docsgov/ exists in the ancestor chain, that ancestor is the
     // repo root — governance config lives relative to it.
-    test("returns the ancestor that owns .docgov/ when CWD is the root", async () => {
-        const root = await makeDir(".docgov");
+    test("returns the ancestor that owns .docsgov/ when CWD is the root", async () => {
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         expect(r.root()).toBe(root);
         // The FS must be usable — list the sentinel dir through it.
         const entries = await r.fs().readDir(".");
-        expect(entries.map((e) => e.name())).toContain(".docgov");
+        expect(entries.map((e) => e.name())).toContain(".docsgov");
     });
-    // WHY: gen/add must be able to bootstrap a repo that has no .docgov/ yet;
+    // WHY: gen/add must be able to bootstrap a repo that has no .docsgov/ yet;
     // falling back to the supplied dir is what makes that possible.
-    test("falls back to the supplied dir when no .docgov/ exists (bootstrapping)", async () => {
-        const root = await makeDir(); // no .docgov
+    test("falls back to the supplied dir when no .docsgov/ exists (bootstrapping)", async () => {
+        const root = await makeDir(); // no .docsgov
         const r = await find(root);
         expect(r.root()).toBe(root);
     });
     // WHY: a check run from a nested working directory must resolve the same repo
     // root as a run from the top — the walk-up is what guarantees that.
-    test("walks up from a nested directory to the .docgov/ owner", async () => {
-        const root = await makeDir(".docgov", "a/b/c");
+    test("walks up from a nested directory to the .docsgov/ owner", async () => {
+        const root = await makeDir(".docsgov", "a/b/c");
         const nested = path.join(root, "a", "b", "c");
         const r = await find(nested);
         expect(r.root()).toBe(root);
@@ -35,7 +35,7 @@ describe("find: repo-root discovery", () => {
 // boundary keeps every downstream parser CRLF-agnostic and reports
 // byte-identical across platforms.
 test("readFile normalises CRLF to LF so callers never see CR", async () => {
-    const root = await makeDir(".docgov");
+    const root = await makeDir(".docsgov");
     await nodefs.writeFile(path.join(root, "test.txt"), "line one\r\nline two\r\n");
     const r = await find(root);
     const got = dec.decode(await r.readFile("test.txt"));
@@ -47,7 +47,7 @@ describe("exists: exact-case file presence for the docs guard", () => {
     // WHY: the docs guard validates file references; a real regular file at the
     // exact path must report present so a valid reference is not flagged broken.
     test("returns true for an existing regular file (exact case)", async () => {
-        const root = await makeDir(".docgov", "docs/adr");
+        const root = await makeDir(".docsgov", "docs/adr");
         const r = await find(root);
         await r.writeFile("docs/adr/0001.md", enc.encode("x\n"));
         expect(await r.exists("docs/adr/0001.md")).toBe(true);
@@ -55,7 +55,7 @@ describe("exists: exact-case file presence for the docs guard", () => {
     // WHY: host filesystems case-fold on macOS/Windows; exists() must NOT, or a
     // wrong-case reference ("Docs/...") would be wrongly accepted and ship broken.
     test("returns false when a path segment differs only in case", async () => {
-        const root = await makeDir(".docgov", "docs/adr");
+        const root = await makeDir(".docsgov", "docs/adr");
         const r = await find(root);
         await r.writeFile("docs/adr/0001.md", enc.encode("x\n"));
         expect(await r.exists("Docs/adr/0001.md")).toBe(false);
@@ -64,14 +64,14 @@ describe("exists: exact-case file presence for the docs guard", () => {
     // WHY: the guard checks file references, not directory references; a reference
     // that resolves to a directory must be rejected as not-a-file.
     test("returns false when the final segment is a directory", async () => {
-        const root = await makeDir(".docgov", "docs/adr");
+        const root = await makeDir(".docsgov", "docs/adr");
         const r = await find(root);
         expect(await r.exists("docs/adr")).toBe(false);
     });
     // WHY: a reference whose interior segment is a file (not a dir) cannot be
     // descended into; treating it as present would mask a malformed reference.
     test("returns false when an interior segment is a file, not a directory", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         await r.writeFile("docs/a.md", enc.encode("x\n"));
         // a.md is a file, so "a.md/inner.md" cannot descend.
@@ -80,14 +80,14 @@ describe("exists: exact-case file presence for the docs guard", () => {
     // WHY: a missing leaf in an existing directory is the common "broken
     // reference" case the guard must catch — it must report absent, not error.
     test("returns false for a missing final segment", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         expect(await r.exists("docs/missing.md")).toBe(false);
     });
     // WHY: an empty or root-only path is never a file reference; returning false
     // keeps the guard from treating "." as a present file.
     test("returns false for the root / empty path", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         expect(await r.exists("/")).toBe(false);
         expect(await r.exists("")).toBe(false);
@@ -95,7 +95,7 @@ describe("exists: exact-case file presence for the docs guard", () => {
     // WHY: a leading slash is a slash-relative reference, not an absolute OS path;
     // it must be stripped so the lookup still resolves under the repo root.
     test("strips a leading slash before resolving", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         await r.writeFile("docs/a.md", enc.encode("x\n"));
         expect(await r.exists("/docs/a.md")).toBe(true);
@@ -105,7 +105,7 @@ describe("fileExists / dirExists: write-with-backup precondition checks", () =>
     // WHY: the write-with-backup layer asks "is there already a file here?"; a
     // genuine file must report true so it backs up instead of clobbering.
     test("fileExists is true for a file and false for a directory or missing path", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         await r.writeFile("docs/a.md", enc.encode("x\n"));
         expect(await r.fileExists("docs/a.md")).toBe(true);
@@ -116,14 +116,14 @@ describe("fileExists / dirExists: write-with-backup precondition checks", () =>
     // so the caller falls through to the write that surfaces a richer error; an
     // escaping path must therefore be reported absent, not throw here.
     test("fileExists returns false for a path that escapes the repo root", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         expect(await r.fileExists("../outside.md")).toBe(false);
     });
     // WHY: dirExists gates directory operations (rename targets, group dirs); a
     // real directory must report true and a file or missing path false.
     test("dirExists is true for a directory and false for a file or missing path", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         await r.writeFile("docs/a.md", enc.encode("x\n"));
         expect(await r.dirExists("docs")).toBe(true);
@@ -133,16 +133,16 @@ describe("fileExists / dirExists: write-with-backup precondition checks", () =>
     // WHY: same swallow-faults contract — an escaping directory path must be
     // reported absent rather than throwing, so callers branch on a boolean.
     test("dirExists returns false for a path that escapes the repo root", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         expect(await r.dirExists("../outside")).toBe(false);
     });
 });
 describe("writeFile: the sole owner of OS writes", () => {
-    // WHY: docgov generates files into nested doc dirs that may not exist yet;
+    // WHY: docsgov generates files into nested doc dirs that may not exist yet;
     // writeFile must create parents so generation does not fail on a fresh repo.
     test("creates missing parent directories", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await r.writeFile("docs/deep/nested/a.md", enc.encode("hello\n"));
         expect(dec.decode(await r.readFile("docs/deep/nested/a.md"))).toBe("hello\n");
@@ -151,7 +151,7 @@ describe("writeFile: the sole owner of OS writes", () => {
     // root must be refused (via toAbs) so generation can never scribble outside
     // the repo. The error names the offending path for diagnosis.
     test("refuses a path that escapes the repo root", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await expect(r.writeFile("../escape.md", enc.encode("x"))).rejects.toThrow(/escapes repository root/);
     });
@@ -160,7 +160,7 @@ describe("renameDir / removeAll: directory lifecycle", () => {
     // WHY: rename is used to move a generated group dir into place; it must move
     // the tree atomically so a half-renamed dir never appears.
     test("renameDir moves a directory tree to a new name", async () => {
-        const root = await makeDir(".docgov", "old");
+        const root = await makeDir(".docsgov", "old");
         const r = await find(root);
         await r.writeFile("old/a.md", enc.encode("x\n"));
         await r.renameDir("old", "new");
@@ -170,14 +170,14 @@ describe("renameDir / removeAll: directory lifecycle", () => {
     // WHY: a failed rename (e.g. missing source) must throw with context naming
     // both paths so the operator can see which move broke — Rule 12 fail loud.
     test("renameDir throws with both paths when the source is missing", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await expect(r.renameDir("missing", "dest")).rejects.toThrow(/repo\.renameDir/);
     });
     // WHY: removeAll backs the stale-.bak cleanup; it must delete an existing tree
     // so a leftover backup dir does not block the next write.
     test("removeAll deletes an existing directory tree", async () => {
-        const root = await makeDir(".docgov", "junk");
+        const root = await makeDir(".docsgov", "junk");
         const r = await find(root);
         await r.writeFile("junk/a.md", enc.encode("x\n"));
         await r.removeAll("junk");
@@ -186,7 +186,7 @@ describe("renameDir / removeAll: directory lifecycle", () => {
     // WHY: the cleanup use-case calls removeAll even when nothing is there; it
     // must be a no-op (force:true), never throw, so cleanup is idempotent.
     test("removeAll is a no-op for a missing path", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await expect(r.removeAll("nope")).resolves.toBeUndefined();
     });
@@ -196,11 +196,11 @@ describe("atomicWriteFile + PendingWrite: crash-safe flips", () => {
     // and is atomic; if the temp landed in the OS temp dir the rename could cross
     // devices and silently degrade to a non-atomic copy.
     test("writes a sibling temp file, not one in the OS temp dir", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         const pending = await r.atomicWriteFile("docs/a.md", enc.encode("new\n"));
         const tmp = pending.tmpAbsForTest();
-        expect(tmp).toBe(path.join(root, "docs", "a.md.docgov-flip.tmp"));
+        expect(tmp).toBe(path.join(root, "docs", "a.md.docsgov-flip.tmp"));
         // The target itself is not yet written before commit.
         expect(await r.fileExists("docs/a.md")).toBe(false);
         await pending.commit(true);
@@ -208,7 +208,7 @@ describe("atomicWriteFile + PendingWrite: crash-safe flips", () => {
     // WHY: commit(true) is what makes the new content visible; after it the target
     // holds the new bytes and the temp is gone (renamed into place).
     test("commit(true) renames the temp into place", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         const pending = await r.atomicWriteFile("docs/a.md", enc.encode("committed\n"));
         await pending.commit(true);
@@ -218,7 +218,7 @@ describe("atomicWriteFile + PendingWrite: crash-safe flips", () => {
     // WHY: commit(false) is the rollback path; it must remove the temp and leave
     // any original untouched, so an aborted flip changes nothing on disk.
     test("commit(false) removes the temp and leaves the original untouched", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         await r.writeFile("docs/a.md", enc.encode("original\n"));
         const pending = await r.atomicWriteFile("docs/a.md", enc.encode("new\n"));
@@ -230,7 +230,7 @@ describe("atomicWriteFile + PendingWrite: crash-safe flips", () => {
     // must swallow the ENOENT (not re-throw), so a double-rollback never crashes
     // the cleanup path.
     test("commit(false) is a no-op when the temp is already removed", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         const pending = await r.atomicWriteFile("docs/a.md", enc.encode("x\n"));
         await nodefs.rm(pending.tmpAbsForTest()); // remove it out from under commit
@@ -239,7 +239,7 @@ describe("atomicWriteFile + PendingWrite: crash-safe flips", () => {
     // WHY: atomicWriteFile must create the target's parent dirs, mirroring
     // writeFile, so a flip into a not-yet-existing doc dir succeeds.
     test("creates missing parent directories for the temp", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         const pending = await r.atomicWriteFile("docs/new/a.md", enc.encode("y\n"));
         await pending.commit(true);
@@ -248,7 +248,7 @@ describe("atomicWriteFile + PendingWrite: crash-safe flips", () => {
     // WHY: atomicWriteFile is also a guarded write; an escaping path must be
     // refused before any temp is created.
     test("refuses a path that escapes the repo root", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await expect(r.atomicWriteFile("../escape.md", enc.encode("x"))).rejects.toThrow(/escapes repository root/);
     });

package/dist/repo/testutil.js

@@ -13,7 +13,7 @@ afterEach(async () => {
     }
 });
 export async function makeDir(...dirs) {
-    const root = await nodefs.mkdtemp(path.join(os.tmpdir(), "docgov-repo-"));
+    const root = await nodefs.mkdtemp(path.join(os.tmpdir(), "docsgov-repo-"));
     // Resolve symlinks (macOS /var -> /private/var) so toAbs prefix checks and
     // root equality assertions compare canonical paths.
     const realRoot = await nodefs.realpath(root);

package/dist/repo/write.test.js

@@ -22,7 +22,7 @@ describe("write capability", () => {
     // WHY: gen writes to nested paths; without parent creation every subdirectory
     // write fails and gen can never produce a multi-file tree.
     test("writeFile creates all missing parent directories", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         const content = enc.encode("hello\n");
         await r.writeFile(".claude/skills/write-docs/adr/adr.md", content);
@@ -32,7 +32,7 @@ describe("write capability", () => {
     // WHY: a slash path must map onto the OS separator so files land at the right
     // location on every platform.
     test("writeFile maps a slash path to the nested OS path", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await r.writeFile("subdir/file.txt", enc.encode("data\n"));
         const got = await nodefs.readFile(path.join(root, "subdir", "file.txt"));
@@ -41,14 +41,14 @@ describe("write capability", () => {
     // WHY: allowing ".." traversal would let gen overwrite arbitrary files on the
     // user's system — a security and correctness boundary.
     test("writeFile refuses a path that escapes the repo root", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await expect(r.writeFile("../escape.txt", enc.encode("should not be written"))).rejects.toThrow();
     });
     // WHY: write-with-backup renames the existing skill dir to <skill>.bak; if
     // renameDir is broken the backup protocol can't protect the user's tree.
     test("renameDir moves a directory and its contents", async () => {
-        const root = await makeDir(".docgov", ".claude/skills/write-docs");
+        const root = await makeDir(".docsgov", ".claude/skills/write-docs");
         await nodefs.writeFile(path.join(root, ".claude", "skills", "write-docs", "sentinel.txt"), "x");
         const r = await find(root);
         await r.renameDir(".claude/skills/write-docs", ".claude/skills/write-docs.bak");
@@ -58,7 +58,7 @@ describe("write capability", () => {
     // WHY: rollback deletes the partial skill dir before restoring the backup; an
     // incomplete removeAll leaves partial state in the user's repository.
     test("removeAll removes a directory tree", async () => {
-        const root = await makeDir(".docgov", ".claude/skills/partial/nested");
+        const root = await makeDir(".docsgov", ".claude/skills/partial/nested");
         await nodefs.writeFile(path.join(root, ".claude", "skills", "partial", "nested", "f.txt"), "y");
         const r = await find(root);
         await r.removeAll(".claude/skills/partial");
@@ -67,7 +67,7 @@ describe("write capability", () => {
     // WHY: stale-bak cleanup calls removeAll unconditionally on first run when no
     // .bak exists — it must silently succeed.
     test("removeAll on a nonexistent path is a no-op", async () => {
-        const root = await makeDir(".docgov");
+        const root = await makeDir(".docsgov");
         const r = await find(root);
         await expect(r.removeAll(".claude/skills/does-not-exist.bak")).resolves.toBeUndefined();
     });
@@ -75,7 +75,7 @@ describe("write capability", () => {
     // deciding to back up; a wrong answer skips a needed backup or crashes a
     // rename of a nonexistent dir.
     test("dirExists reports true for an existing dir and false otherwise", async () => {
-        const root = await makeDir(".docgov", ".claude/skills/write-docs");
+        const root = await makeDir(".docsgov", ".claude/skills/write-docs");
         const r = await find(root);
         expect(await r.dirExists(".claude/skills/write-docs")).toBe(true);
         expect(await r.dirExists(".claude/skills/no-such-dir")).toBe(false);
@@ -86,17 +86,17 @@ describe("write capability", () => {
 // mutates the original or leaves a stray temp file breaks that invariant.
 describe("atomicWriteFile two-phase commit", () => {
     test("commit(false) rolls back leaving the original untouched and no temp", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         const target = "docs/a.md";
         await r.writeFile(target, enc.encode("ORIGINAL\n"));
         const pw = await r.atomicWriteFile(target, enc.encode("NEW\n"));
         await pw.commit(false);
         expect(dec.decode(await r.readFile(target))).toBe("ORIGINAL\n");
-        expect(await statSafe(path.join(root, "docs", "a.md.docgov-flip.tmp"))).toBe(false);
+        expect(await statSafe(path.join(root, "docs", "a.md.docsgov-flip.tmp"))).toBe(false);
     });
     test("commit(true) atomically renames the temp into place", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         const target = "docs/a.md";
         await r.writeFile(target, enc.encode("ORIGINAL\n"));
@@ -110,7 +110,7 @@ describe("atomicWriteFile two-phase commit", () => {
     // mid-flight. The real temp path comes from PendingWrite, so this genuinely
     // fails if the impl changes to use the OS temp dir.
     test("the temp file is a sibling of the target, not in the OS temp dir", async () => {
-        const root = await makeDir(".docgov", "docs");
+        const root = await makeDir(".docsgov", "docs");
         const r = await find(root);
         const target = "docs/a.md";
         await r.writeFile(target, enc.encode("ORIGINAL\n"));
@@ -119,7 +119,7 @@ describe("atomicWriteFile two-phase commit", () => {
         const targetDir = path.join(root, "docs");
         expect(path.dirname(actualTmpPath)).toBe(targetDir);
         // The temp file must exist on disk before commit is called.
-        expect(await statSafe(path.join(targetDir, "a.md.docgov-flip.tmp"))).toBe(true);
+        expect(await statSafe(path.join(targetDir, "a.md.docsgov-flip.tmp"))).toBe(true);
         await pw.commit(false); // rollback
     });
 });

package/dist/violation/types.js

@@ -1,5 +1,5 @@
 // Package violation defines the Violation Record and the closed Rule enum for
-// the docgov check surface. It is a leaf package: it imports nothing internal.
+// the docsgov check surface. It is a leaf package: it imports nothing internal.
 // Every rule the check surface can emit is listed in the Rule set; the set is
 // closed and must exactly match the rule registry in docs/flows/check.md §5.
 // Rules is the closed set of all rule identifiers the check surface can emit.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docsgov",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Config-driven documentation governance: checks that {{code:…}} and {{api:…}} references in your Markdown docs still resolve, that doc links exist, and (via dedup) flags near-duplicate concepts.",
   "license": "GPL-3.0",
   "type": "module",
@@ -8,7 +8,7 @@
     "node": ">=22"
   },
   "bin": {
-    "docgov": "dist/cmd/main.js"
+    "docsgov": "dist/cmd/main.js"
   },
   "files": [
     "dist"