skillrepo 4.9.2 → 4.11.0

package/src/test/lib/gitignore-section.test.mjs

@@ -0,0 +1,213 @@
+/**
+ * Unit tests for src/lib/gitignore-section.mjs (#2361).
+ *
+ * The single marked-section writer shared by the init merger and the
+ * sync-time pre-flight. Attribution-sensitive: every CLI-authored line
+ * must land inside the ONE marked section (never a duplicate header),
+ * the retired pre-4.10.0 sync-time section must be healed into it, and
+ * user content must survive byte-exact outside the CLI's own lines.
+ */
+
+import { describe, it, beforeEach, afterEach } from "node:test";
+import assert from "node:assert/strict";
+import { mkdtempSync, writeFileSync, readFileSync, rmSync } from "node:fs";
+import { join } from "node:path";
+import { tmpdir } from "node:os";
+
+import {
+  ensureGitignoreEntries,
+  ensureManagedRootIgnores,
+  MANAGED_ROOT_ENTRIES,
+} from "../../lib/gitignore-section.mjs";
+import {
+  GITIGNORE_SECTION_HEADER,
+  LEGACY_GITIGNORE_SECTION_HEADER,
+} from "../../lib/artifact-registry.mjs";
+
+let originalCwd;
+let tempDir;
+
+beforeEach(() => {
+  originalCwd = process.cwd;
+  tempDir = mkdtempSync(join(tmpdir(), "cli-gi-section-"));
+  process.cwd = () => tempDir;
+});
+
+afterEach(() => {
+  process.cwd = originalCwd;
+  rmSync(tempDir, { recursive: true, force: true });
+});
+
+function gitignore() {
+  return readFileSync(join(tempDir, ".gitignore"), "utf-8");
+}
+
+describe("ensureGitignoreEntries — section management", () => {
+  it("creates a fresh file with one marked section", () => {
+    const result = ensureGitignoreEntries([".claude/skills/"]);
+    assert.equal(result.action, "created");
+    assert.deepEqual(result.added, [".claude/skills/"]);
+    const content = gitignore();
+    assert.equal(
+      content,
+      `${GITIGNORE_SECTION_HEADER}\n.claude/skills/\n`,
+    );
+  });
+
+  it("inserts missing entries INTO an existing marked section — no duplicate header", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      `node_modules/\n\n${GITIGNORE_SECTION_HEADER}\n.env.local\n\nuser-tail/\n`,
+    );
+    const result = ensureGitignoreEntries([".agents/skills/"]);
+    assert.equal(result.action, "updated");
+    const content = gitignore();
+    const headers = content.match(
+      new RegExp(GITIGNORE_SECTION_HEADER.replace(/[.*+?^${}()|[\]\\]/g, "\\$&"), "g"),
+    );
+    assert.equal(headers.length, 1, "must never write a second header");
+    // The new entry sits inside the section: after .env.local, before
+    // the blank line that closes the section.
+    assert.match(content, /\.env\.local\n\.agents\/skills\/\n\nuser-tail\//);
+  });
+
+  it("appends a new section when no header exists, separated by one blank line", () => {
+    writeFileSync(join(tempDir, ".gitignore"), "node_modules/\n");
+    ensureGitignoreEntries([".claude/skills/"]);
+    assert.equal(
+      gitignore(),
+      `node_modules/\n\n${GITIGNORE_SECTION_HEADER}\n.claude/skills/\n`,
+    );
+  });
+
+  it("is idempotent — a second identical call reports skipped and does not rewrite", () => {
+    ensureGitignoreEntries([".claude/skills/"]);
+    const before = gitignore();
+    const result = ensureGitignoreEntries([".claude/skills/"]);
+    assert.equal(result.action, "skipped");
+    assert.equal(gitignore(), before);
+  });
+
+  it("honors an entry the user already has anywhere in the file", () => {
+    writeFileSync(join(tempDir, ".gitignore"), ".claude/skills/\n");
+    const result = ensureGitignoreEntries([".claude/skills/"]);
+    assert.equal(result.action, "skipped");
+    assert.equal(gitignore(), ".claude/skills/\n");
+  });
+
+  it("preserves CRLF line endings", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      "node_modules/\r\n.env\r\n",
+    );
+    ensureGitignoreEntries([".claude/skills/"]);
+    const content = gitignore();
+    assert.ok(content.includes("\r\n"), "CRLF must be preserved");
+    assert.ok(
+      !/[^\r]\n/.test(content.replace(/\r\n/g, "")),
+      "no mixed line endings introduced",
+    );
+    assert.match(content, /\.claude\/skills\//);
+  });
+
+  it("does not treat a comment mentioning an entry as the entry", () => {
+    writeFileSync(join(tempDir, ".gitignore"), "# .claude/skills/ is synced\n");
+    const result = ensureGitignoreEntries([".claude/skills/"]);
+    assert.equal(result.action, "updated");
+    assert.deepEqual(result.added, [".claude/skills/"]);
+  });
+});
+
+describe("ensureGitignoreEntries — legacy sync-time section heal", () => {
+  it("migrates the exact legacy shape into the marked section", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      `node_modules/\n\n${LEGACY_GITIGNORE_SECTION_HEADER}\n.agents/skills/\n`,
+    );
+    const result = ensureGitignoreEntries([".agents/skills/"]);
+    assert.equal(result.action, "updated");
+    const content = gitignore();
+    assert.ok(
+      !content.includes(LEGACY_GITIGNORE_SECTION_HEADER),
+      "legacy header must be healed away",
+    );
+    assert.match(content, /\.agents\/skills\//);
+    assert.ok(content.includes(GITIGNORE_SECTION_HEADER));
+  });
+
+  it("reports updated (and heals) even when no entries are missing", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      `${GITIGNORE_SECTION_HEADER}\n.agents/skills/\n\n${LEGACY_GITIGNORE_SECTION_HEADER}\n.agents/skills/\n`,
+    );
+    const result = ensureGitignoreEntries([".agents/skills/"]);
+    assert.equal(result.action, "updated");
+    assert.deepEqual(result.added, []);
+    const content = gitignore();
+    assert.ok(!content.includes(LEGACY_GITIGNORE_SECTION_HEADER));
+    // Exactly one .agents/skills/ line remains (the marked-section one).
+    const matches = content.match(/\.agents\/skills\//g);
+    assert.equal(matches.length, 1);
+  });
+
+  it("never removes user content sitting under the legacy header", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      `${LEGACY_GITIGNORE_SECTION_HEADER}\nmy-own-line/\n.agents/skills/\n`,
+    );
+    ensureGitignoreEntries([".agents/skills/"]);
+    const content = gitignore();
+    // Only the header vanished — the user line survives, and the
+    // `.agents/skills/` line NOT directly under the header survives
+    // too (it satisfies the ensure, so no insertion happened).
+    assert.match(content, /my-own-line\//);
+    assert.match(content, /\.agents\/skills\//);
+    assert.ok(!content.includes(LEGACY_GITIGNORE_SECTION_HEADER));
+  });
+});
+
+describe("ensureManagedRootIgnores — target mapping", () => {
+  it("writes both project-root entries for claudeProject + agentsProject", () => {
+    const result = ensureManagedRootIgnores(["claudeProject", "agentsProject"]);
+    assert.equal(result.action, "created");
+    assert.deepEqual(
+      [...result.added].sort(),
+      [".agents/skills/", ".claude/skills/"],
+    );
+  });
+
+  it("is a no-op for global-only targets", () => {
+    const result = ensureManagedRootIgnores(["claudeGlobal", "agentsGlobal", "windsurfGlobal"]);
+    assert.equal(result.action, "skipped");
+    assert.deepEqual(result.added, []);
+    assert.throws(() => readFileSync(join(tempDir, ".gitignore")));
+  });
+
+  it("is a no-op for an empty or missing target list", () => {
+    assert.equal(ensureManagedRootIgnores([]).action, "skipped");
+    assert.equal(ensureManagedRootIgnores(undefined).action, "skipped");
+  });
+
+  it("every managed-root entry is in the artifact registry's expected set", async () => {
+    // Cross-consistency: the uninstall remover strips the whole marked
+    // section, but GITIGNORE_REQUIRED_ENTRIES is the documented
+    // expected-set contract — a managed-root entry the registry does
+    // not know about is drift (#885 / #2361).
+    const { GITIGNORE_REQUIRED_ENTRIES } = await import(
+      "../../lib/artifact-registry.mjs"
+    );
+    for (const entry of Object.values(MANAGED_ROOT_ENTRIES)) {
+      assert.ok(
+        GITIGNORE_REQUIRED_ENTRIES.includes(entry),
+        `${entry} missing from GITIGNORE_REQUIRED_ENTRIES`,
+      );
+    }
+  });
+
+  it("covers every project-scope managed root exactly once in MANAGED_ROOT_ENTRIES", () => {
+    assert.deepEqual(Object.keys(MANAGED_ROOT_ENTRIES).sort(), [
+      "agentsProject",
+      "claudeProject",
+    ]);
+  });
+});