skillrepo 2.0.0 → 3.1.0

package/src/test/mergers/gitignore.test.mjs

@@ -1,9 +1,29 @@
+/**
+ * Unit tests for src/lib/mergers/gitignore.mjs (PR4 of #646).
+ *
+ * The v2.0.0 merger added a single `.claude/rules/skillrepo-*.md`
+ * pattern for the now-deleted rules delivery flow. PR4 rewrote it to
+ * add the three init-required paths: .env.local, .claude/skills/,
+ * and .claude/settings.local.json. These tests cover:
+ *
+ *   - fresh .gitignore creation (all three entries in one block)
+ *   - append when .gitignore exists but is missing entries
+ *   - skip when every entry is already present
+ *   - partial skip when some entries are present and some aren't
+ *   - idempotent second run
+ *   - line-ending preservation (CRLF vs LF)
+ *   - line-exact matching (a comment containing ".env.local" does NOT
+ *     satisfy the check)
+ */
+
 import { describe, it, beforeEach, afterEach } from "node:test";
 import assert from "node:assert/strict";
-import { mkdtempSync, mkdirSync, writeFileSync, readFileSync, rmSync } from "node:fs";
+import { mkdtempSync, writeFileSync, readFileSync, rmSync } from "node:fs";
 import { join } from "node:path";
 import { tmpdir } from "node:os";
 
+import { mergeGitignore } from "../../lib/mergers/gitignore.mjs";
+
 let originalCwd;
 let tempDir;
 
@@ -18,46 +38,151 @@ afterEach(() => {
   rmSync(tempDir, { recursive: true, force: true });
 });
 
-describe("mergeGitignore", () => {
-  it("creates .gitignore when it does not exist", async () => {
-    const { mergeGitignore } = await import("../../lib/mergers/gitignore.mjs");
+describe("mergeGitignore — creation", () => {
+  it("creates .gitignore with all three entries when file does not exist", () => {
     const result = mergeGitignore();
 
     assert.equal(result.action, "created");
+    assert.deepEqual(result.added.sort(), [
+      ".claude/settings.local.json",
+      ".claude/skills/",
+      ".env.local",
+    ]);
+
     const content = readFileSync(join(tempDir, ".gitignore"), "utf-8");
-    assert.ok(content.includes(".claude/rules/skillrepo-*.md"));
-    assert.ok(content.includes("# SkillRepo"));
+    assert.match(content, /^# SkillRepo CLI/m);
+    assert.match(content, /^\.env\.local$/m);
+    assert.match(content, /^\.claude\/skills\/$/m);
+    assert.match(content, /^\.claude\/settings\.local\.json$/m);
   });
+});
 
-  it("appends to existing .gitignore", async () => {
-    const { mergeGitignore } = await import("../../lib/mergers/gitignore.mjs");
-
+describe("mergeGitignore — append to existing file", () => {
+  it("appends all three entries when none are present", () => {
     writeFileSync(join(tempDir, ".gitignore"), "node_modules/\n.env\n");
     const result = mergeGitignore();
 
     assert.equal(result.action, "updated");
+    assert.equal(result.added.length, 3);
+
     const content = readFileSync(join(tempDir, ".gitignore"), "utf-8");
+    // Original content preserved at the start
     assert.ok(content.startsWith("node_modules/\n.env\n"));
-    assert.ok(content.includes(".claude/rules/skillrepo-*.md"));
+    // All three entries present
+    assert.match(content, /^\.env\.local$/m);
+    assert.match(content, /^\.claude\/skills\/$/m);
+    assert.match(content, /^\.claude\/settings\.local\.json$/m);
   });
 
-  it("skips when entry already exists", async () => {
-    const { mergeGitignore } = await import("../../lib/mergers/gitignore.mjs");
-
-    writeFileSync(join(tempDir, ".gitignore"), "node_modules/\n.claude/rules/skillrepo-*.md\n");
+  it("appends only missing entries when some are already present", () => {
+    // .env.local already exists — only the other two should be added
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      "node_modules/\n.env.local\n",
+    );
     const result = mergeGitignore();
 
-    assert.equal(result.action, "skipped");
-  });
+    assert.equal(result.action, "updated");
+    assert.deepEqual(result.added.sort(), [
+      ".claude/settings.local.json",
+      ".claude/skills/",
+    ]);
 
-  it("appends newline before section when existing file lacks trailing newline", async () => {
-    const { mergeGitignore } = await import("../../lib/mergers/gitignore.mjs");
+    const content = readFileSync(join(tempDir, ".gitignore"), "utf-8");
+    // .env.local should NOT appear twice
+    const envLocalMatches = content.match(/^\.env\.local$/gm) ?? [];
+    assert.equal(envLocalMatches.length, 1, ".env.local must not be duplicated");
+  });
 
+  it("appends a newline before the section if the existing file lacks trailing newline", () => {
     writeFileSync(join(tempDir, ".gitignore"), "node_modules/");
     mergeGitignore();
 
     const content = readFileSync(join(tempDir, ".gitignore"), "utf-8");
-    // Should have a newline before the SkillRepo section
-    assert.ok(content.includes("node_modules/\n\n# SkillRepo"));
+    // Separator newline between existing content and the SkillRepo section
+    assert.match(content, /node_modules\/\n\n# SkillRepo/);
+  });
+
+  it("preserves CRLF line endings on existing files", () => {
+    writeFileSync(join(tempDir, ".gitignore"), "node_modules/\r\n.env\r\n");
+    mergeGitignore();
+
+    const content = readFileSync(join(tempDir, ".gitignore"), "utf-8");
+    // The SkillRepo section should use CRLF to match
+    assert.match(content, /# SkillRepo CLI.*\r\n\.env\.local\r\n/);
+  });
+});
+
+describe("mergeGitignore — idempotency", () => {
+  it("returns skipped when every entry is already present", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      [
+        "node_modules/",
+        ".env.local",
+        ".claude/skills/",
+        ".claude/settings.local.json",
+      ].join("\n") + "\n",
+    );
+    const result = mergeGitignore();
+
+    assert.equal(result.action, "skipped");
+    assert.equal(result.added.length, 0);
+  });
+
+  it("second run after creation is a no-op skip", () => {
+    const first = mergeGitignore();
+    assert.equal(first.action, "created");
+
+    const second = mergeGitignore();
+    assert.equal(second.action, "skipped");
+    assert.equal(second.added.length, 0);
+  });
+
+  it("third run after an append is also a no-op skip", () => {
+    writeFileSync(join(tempDir, ".gitignore"), "node_modules/\n");
+    const first = mergeGitignore();
+    assert.equal(first.action, "updated");
+
+    const second = mergeGitignore();
+    assert.equal(second.action, "skipped");
+  });
+});
+
+describe("mergeGitignore — line-exact matching", () => {
+  it("does NOT count a comment containing .env.local as satisfied", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      "# mention of .env.local in a comment\n",
+    );
+    const result = mergeGitignore();
+
+    // The comment line is not a literal .env.local line, so the
+    // merger should still add it.
+    assert.equal(result.action, "updated");
+    assert.ok(result.added.includes(".env.local"));
+  });
+
+  it("does NOT count .env.local.backup as satisfying .env.local", () => {
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      ".env.local.backup\n",
+    );
+    const result = mergeGitignore();
+
+    assert.equal(result.action, "updated");
+    assert.ok(result.added.includes(".env.local"));
+  });
+
+  it("tolerates leading/trailing whitespace on existing lines", () => {
+    // Some editors add trailing whitespace. The merger trims on
+    // compare so these lines should still count as matches.
+    writeFileSync(
+      join(tempDir, ".gitignore"),
+      "  .env.local  \n  .claude/skills/\n.claude/settings.local.json\n",
+    );
+    const result = mergeGitignore();
+
+    assert.equal(result.action, "skipped");
   });
 });