* feat(rules-injector): add GitHub Copilot instructions format support - Add .github/instructions/ directory to rule discovery paths - Add applyTo as alias for globs field in frontmatter parser - Support .github/copilot-instructions.md single-file format (always-apply) - Filter .github/instructions/ to only accept *.instructions.md files - Add comprehensive tests for parser and finder Closes #397 * fix(rules-injector): use cross-platform path separator in calculateDistance path.relative() returns OS-native separators (backslashes on Windows), but the code was splitting by forward slash only, causing incorrect distance calculations on Windows. Use regex /[/\]/ to handle both separator types. --------- Co-authored-by: sisyphus-dev-ai <sisyphus-dev-ai@users.noreply.github.com>
382 lines
13 KiB
TypeScript
382 lines
13 KiB
TypeScript
import { afterEach, beforeEach, describe, expect, it } from "bun:test";
|
|
import { existsSync, mkdirSync, rmSync, writeFileSync } from "node:fs";
|
|
import { tmpdir } from "node:os";
|
|
import { join } from "node:path";
|
|
import { findProjectRoot, findRuleFiles } from "./finder";
|
|
|
|
describe("findRuleFiles", () => {
|
|
const TEST_DIR = join(tmpdir(), `rules-injector-test-${Date.now()}`);
|
|
const homeDir = join(TEST_DIR, "home");
|
|
|
|
beforeEach(() => {
|
|
mkdirSync(TEST_DIR, { recursive: true });
|
|
mkdirSync(homeDir, { recursive: true });
|
|
mkdirSync(join(TEST_DIR, ".git"), { recursive: true });
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (existsSync(TEST_DIR)) {
|
|
rmSync(TEST_DIR, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
describe(".github/instructions/ discovery", () => {
|
|
it("should discover .github/instructions/*.instructions.md files", () => {
|
|
// #given .github/instructions/ with valid files
|
|
const instructionsDir = join(TEST_DIR, ".github", "instructions");
|
|
mkdirSync(instructionsDir, { recursive: true });
|
|
writeFileSync(
|
|
join(instructionsDir, "typescript.instructions.md"),
|
|
"TS rules"
|
|
);
|
|
writeFileSync(
|
|
join(instructionsDir, "python.instructions.md"),
|
|
"PY rules"
|
|
);
|
|
|
|
const srcDir = join(TEST_DIR, "src");
|
|
mkdirSync(srcDir, { recursive: true });
|
|
const currentFile = join(srcDir, "index.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules for a file
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find both instruction files
|
|
const paths = candidates.map((c) => c.path);
|
|
expect(
|
|
paths.some((p) => p.includes("typescript.instructions.md"))
|
|
).toBe(true);
|
|
expect(paths.some((p) => p.includes("python.instructions.md"))).toBe(
|
|
true
|
|
);
|
|
});
|
|
|
|
it("should ignore non-.instructions.md files in .github/instructions/", () => {
|
|
// #given .github/instructions/ with invalid files
|
|
const instructionsDir = join(TEST_DIR, ".github", "instructions");
|
|
mkdirSync(instructionsDir, { recursive: true });
|
|
writeFileSync(
|
|
join(instructionsDir, "valid.instructions.md"),
|
|
"valid"
|
|
);
|
|
writeFileSync(join(instructionsDir, "invalid.md"), "invalid");
|
|
writeFileSync(join(instructionsDir, "readme.txt"), "readme");
|
|
|
|
const currentFile = join(TEST_DIR, "index.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should only find .instructions.md file
|
|
const paths = candidates.map((c) => c.path);
|
|
expect(paths.some((p) => p.includes("valid.instructions.md"))).toBe(
|
|
true
|
|
);
|
|
expect(paths.some((p) => p.endsWith("invalid.md"))).toBe(false);
|
|
expect(paths.some((p) => p.includes("readme.txt"))).toBe(false);
|
|
});
|
|
|
|
it("should discover nested .instructions.md files in subdirectories", () => {
|
|
// #given nested .github/instructions/ structure
|
|
const instructionsDir = join(TEST_DIR, ".github", "instructions");
|
|
const frontendDir = join(instructionsDir, "frontend");
|
|
mkdirSync(frontendDir, { recursive: true });
|
|
writeFileSync(
|
|
join(frontendDir, "react.instructions.md"),
|
|
"React rules"
|
|
);
|
|
|
|
const currentFile = join(TEST_DIR, "app.tsx");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find nested instruction file
|
|
const paths = candidates.map((c) => c.path);
|
|
expect(paths.some((p) => p.includes("react.instructions.md"))).toBe(
|
|
true
|
|
);
|
|
});
|
|
});
|
|
|
|
describe(".github/copilot-instructions.md (single file)", () => {
|
|
it("should discover copilot-instructions.md at project root", () => {
|
|
// #given .github/copilot-instructions.md at root
|
|
const githubDir = join(TEST_DIR, ".github");
|
|
mkdirSync(githubDir, { recursive: true });
|
|
writeFileSync(
|
|
join(githubDir, "copilot-instructions.md"),
|
|
"Global instructions"
|
|
);
|
|
|
|
const currentFile = join(TEST_DIR, "index.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find the single file rule
|
|
const singleFile = candidates.find((c) =>
|
|
c.path.includes("copilot-instructions.md")
|
|
);
|
|
expect(singleFile).toBeDefined();
|
|
expect(singleFile?.isSingleFile).toBe(true);
|
|
});
|
|
|
|
it("should mark single file rules with isSingleFile: true", () => {
|
|
// #given copilot-instructions.md
|
|
const githubDir = join(TEST_DIR, ".github");
|
|
mkdirSync(githubDir, { recursive: true });
|
|
writeFileSync(
|
|
join(githubDir, "copilot-instructions.md"),
|
|
"Instructions"
|
|
);
|
|
|
|
const currentFile = join(TEST_DIR, "file.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then isSingleFile should be true
|
|
const copilotFile = candidates.find((c) => c.isSingleFile);
|
|
expect(copilotFile).toBeDefined();
|
|
expect(copilotFile?.path).toContain("copilot-instructions.md");
|
|
});
|
|
|
|
it("should set distance to 0 for single file rules", () => {
|
|
// #given copilot-instructions.md at project root
|
|
const githubDir = join(TEST_DIR, ".github");
|
|
mkdirSync(githubDir, { recursive: true });
|
|
writeFileSync(
|
|
join(githubDir, "copilot-instructions.md"),
|
|
"Instructions"
|
|
);
|
|
|
|
const srcDir = join(TEST_DIR, "src", "deep", "nested");
|
|
mkdirSync(srcDir, { recursive: true });
|
|
const currentFile = join(srcDir, "file.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules from deeply nested file
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then single file should have distance 0
|
|
const copilotFile = candidates.find((c) => c.isSingleFile);
|
|
expect(copilotFile?.distance).toBe(0);
|
|
});
|
|
});
|
|
|
|
describe("backward compatibility", () => {
|
|
it("should still discover .claude/rules/ files", () => {
|
|
// #given .claude/rules/ directory
|
|
const rulesDir = join(TEST_DIR, ".claude", "rules");
|
|
mkdirSync(rulesDir, { recursive: true });
|
|
writeFileSync(join(rulesDir, "typescript.md"), "TS rules");
|
|
|
|
const currentFile = join(TEST_DIR, "index.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find claude rules
|
|
const paths = candidates.map((c) => c.path);
|
|
expect(paths.some((p) => p.includes(".claude/rules/"))).toBe(true);
|
|
});
|
|
|
|
it("should still discover .cursor/rules/ files", () => {
|
|
// #given .cursor/rules/ directory
|
|
const rulesDir = join(TEST_DIR, ".cursor", "rules");
|
|
mkdirSync(rulesDir, { recursive: true });
|
|
writeFileSync(join(rulesDir, "python.md"), "PY rules");
|
|
|
|
const currentFile = join(TEST_DIR, "main.py");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find cursor rules
|
|
const paths = candidates.map((c) => c.path);
|
|
expect(paths.some((p) => p.includes(".cursor/rules/"))).toBe(true);
|
|
});
|
|
|
|
it("should discover .mdc files in rule directories", () => {
|
|
// #given .mdc file in .claude/rules/
|
|
const rulesDir = join(TEST_DIR, ".claude", "rules");
|
|
mkdirSync(rulesDir, { recursive: true });
|
|
writeFileSync(join(rulesDir, "advanced.mdc"), "MDC rules");
|
|
|
|
const currentFile = join(TEST_DIR, "app.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find .mdc file
|
|
const paths = candidates.map((c) => c.path);
|
|
expect(paths.some((p) => p.endsWith("advanced.mdc"))).toBe(true);
|
|
});
|
|
});
|
|
|
|
describe("mixed sources", () => {
|
|
it("should discover rules from all sources", () => {
|
|
// #given rules in multiple directories
|
|
const claudeRules = join(TEST_DIR, ".claude", "rules");
|
|
const cursorRules = join(TEST_DIR, ".cursor", "rules");
|
|
const githubInstructions = join(TEST_DIR, ".github", "instructions");
|
|
const githubDir = join(TEST_DIR, ".github");
|
|
|
|
mkdirSync(claudeRules, { recursive: true });
|
|
mkdirSync(cursorRules, { recursive: true });
|
|
mkdirSync(githubInstructions, { recursive: true });
|
|
|
|
writeFileSync(join(claudeRules, "claude.md"), "claude");
|
|
writeFileSync(join(cursorRules, "cursor.md"), "cursor");
|
|
writeFileSync(
|
|
join(githubInstructions, "copilot.instructions.md"),
|
|
"copilot"
|
|
);
|
|
writeFileSync(join(githubDir, "copilot-instructions.md"), "global");
|
|
|
|
const currentFile = join(TEST_DIR, "index.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find all rules
|
|
expect(candidates.length).toBeGreaterThanOrEqual(4);
|
|
const paths = candidates.map((c) => c.path);
|
|
expect(paths.some((p) => p.includes(".claude/rules/"))).toBe(true);
|
|
expect(paths.some((p) => p.includes(".cursor/rules/"))).toBe(true);
|
|
expect(paths.some((p) => p.includes(".github/instructions/"))).toBe(
|
|
true
|
|
);
|
|
expect(paths.some((p) => p.includes("copilot-instructions.md"))).toBe(
|
|
true
|
|
);
|
|
});
|
|
|
|
it("should not duplicate single file rules", () => {
|
|
// #given copilot-instructions.md
|
|
const githubDir = join(TEST_DIR, ".github");
|
|
mkdirSync(githubDir, { recursive: true });
|
|
writeFileSync(
|
|
join(githubDir, "copilot-instructions.md"),
|
|
"Instructions"
|
|
);
|
|
|
|
const currentFile = join(TEST_DIR, "file.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should only have one copilot-instructions.md entry
|
|
const copilotFiles = candidates.filter((c) =>
|
|
c.path.includes("copilot-instructions.md")
|
|
);
|
|
expect(copilotFiles.length).toBe(1);
|
|
});
|
|
});
|
|
|
|
describe("user-level rules", () => {
|
|
it("should discover user-level .claude/rules/ files", () => {
|
|
// #given user-level rules
|
|
const userRulesDir = join(homeDir, ".claude", "rules");
|
|
mkdirSync(userRulesDir, { recursive: true });
|
|
writeFileSync(join(userRulesDir, "global.md"), "Global user rules");
|
|
|
|
const currentFile = join(TEST_DIR, "app.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then should find user-level rules
|
|
const userRule = candidates.find((c) => c.isGlobal);
|
|
expect(userRule).toBeDefined();
|
|
expect(userRule?.path).toContain("global.md");
|
|
});
|
|
|
|
it("should mark user-level rules as isGlobal: true", () => {
|
|
// #given user-level rules
|
|
const userRulesDir = join(homeDir, ".claude", "rules");
|
|
mkdirSync(userRulesDir, { recursive: true });
|
|
writeFileSync(join(userRulesDir, "user.md"), "User rules");
|
|
|
|
const currentFile = join(TEST_DIR, "app.ts");
|
|
writeFileSync(currentFile, "code");
|
|
|
|
// #when finding rules
|
|
const candidates = findRuleFiles(TEST_DIR, homeDir, currentFile);
|
|
|
|
// #then isGlobal should be true
|
|
const userRule = candidates.find((c) => c.path.includes("user.md"));
|
|
expect(userRule?.isGlobal).toBe(true);
|
|
expect(userRule?.distance).toBe(9999);
|
|
});
|
|
});
|
|
});
|
|
|
|
describe("findProjectRoot", () => {
|
|
const TEST_DIR = join(tmpdir(), `project-root-test-${Date.now()}`);
|
|
|
|
beforeEach(() => {
|
|
mkdirSync(TEST_DIR, { recursive: true });
|
|
});
|
|
|
|
afterEach(() => {
|
|
if (existsSync(TEST_DIR)) {
|
|
rmSync(TEST_DIR, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it("should find project root with .git directory", () => {
|
|
// #given directory with .git
|
|
mkdirSync(join(TEST_DIR, ".git"), { recursive: true });
|
|
const nestedFile = join(TEST_DIR, "src", "components", "Button.tsx");
|
|
mkdirSync(join(TEST_DIR, "src", "components"), { recursive: true });
|
|
writeFileSync(nestedFile, "code");
|
|
|
|
// #when finding project root from nested file
|
|
const root = findProjectRoot(nestedFile);
|
|
|
|
// #then should return the directory with .git
|
|
expect(root).toBe(TEST_DIR);
|
|
});
|
|
|
|
it("should find project root with package.json", () => {
|
|
// #given directory with package.json
|
|
writeFileSync(join(TEST_DIR, "package.json"), "{}");
|
|
const nestedFile = join(TEST_DIR, "lib", "index.js");
|
|
mkdirSync(join(TEST_DIR, "lib"), { recursive: true });
|
|
writeFileSync(nestedFile, "code");
|
|
|
|
// #when finding project root
|
|
const root = findProjectRoot(nestedFile);
|
|
|
|
// #then should find the package.json directory
|
|
expect(root).toBe(TEST_DIR);
|
|
});
|
|
|
|
it("should return null when no project markers found", () => {
|
|
// #given directory without any project markers
|
|
const isolatedDir = join(TEST_DIR, "isolated");
|
|
mkdirSync(isolatedDir, { recursive: true });
|
|
const file = join(isolatedDir, "file.txt");
|
|
writeFileSync(file, "content");
|
|
|
|
// #when finding project root
|
|
const root = findProjectRoot(file);
|
|
|
|
// #then should return null
|
|
expect(root).toBeNull();
|
|
});
|
|
});
|