mirror of
https://github.com/abhigyanpatwari/GitNexus.git
synced 2026-08-28 05:25:25 +00:00
* feat(cli): add --skip-skills and --index-only flags to analyze command The `installSkills()` call in `generateAIContextFiles()` runs unconditionally, injecting 6 skill files into `.claude/skills/gitnexus/` even when `--skip-agents-md` is passed. This is problematic for bulk indexing operations on read-only mirrors or third-party repos. Add two new flags: - `--skip-skills`: suppress standard GitNexus skill file injection - `--index-only`: pure index mode that suppresses all file injection (AGENTS.md, CLAUDE.md, and skills), writing only to `.gitnexus/` This gives users three levels of control: - `--skip-agents-md` — suppress only root context files - `--skip-skills` — suppress only skill injection - `--index-only` — suppress everything (pure indexing) Discovery context: while bulk-indexing 176 repos with `--skip-agents-md`, all 144 indexed repos were contaminated with `.claude/skills/gitnexus/` files requiring manual cleanup. * fix(cli): address PR #742 review — gate community skills, drop dangling refs, add tests Bot review (#742) flagged three issues with the original commit: 1. `--index-only --skills` still wrote community-derived skill files to `.claude/skills/generated/`. The `--skills` branch in analyze.ts was not gated by `skipAll`, so the "skip all file injection" contract was violated. Gate `generateSkillFiles()` with `!skipAll` so `--index-only` truly wins over `--skills`. 2. `--skip-skills` without `--skip-agents-md` produced AGENTS.md / CLAUDE.md that still referenced `.claude/skills/gitnexus/*/SKILL.md` files that were never installed — every agent load incurred 6 failed reads. Pass `skipSkills` through to `generateGitNexusContent()` and omit the standard-skill rows (and the entire `## CLI` heading when the table is empty). Community skills, when present via `--skills`, are unaffected. 3. No filesystem tests for `skipSkills` / `indexOnly`. Add three regression guards to `test/unit/ai-context.test.ts`: - `.claude/skills/gitnexus/` is NOT created when skipSkills=true - Nothing is written when both skipAgentsMd and skipSkills are true (the resolved-flag state from --index-only) - AGENTS.md/CLAUDE.md routing table omits standard skill references when skipSkills=true, but preserves the load-bearing imperative sections (Always Do / Never Do / Resources) * test(cli): PR 1485 review follow-ups (help text, gate test, --skip-skills docs) - Assert --skip-skills and --index-only in analyze --help (skip-git-cli.test.ts). - Export shouldGenerateCommunitySkillFiles; unit-test index-only+skills gate. - Clarify --skip-skills does not suppress --skills community files; --index-only for full skip. Co-authored-by: Cursor <cursoragent@cursor.com> * fix(cli): warn when --index-only silently overrides --skills Address review findings on PR 1485 follow-ups: - analyze.ts emits a one-line note when both --index-only and --skills are set, so users see why a pipeline re-index ran with no skill files written. - index.ts --skills help text now flags the --index-only override. - shouldGenerateCommunitySkillFiles JSDoc documents the dual role of the gate (community skills + AGENTS.md/CLAUDE.md re-generation). - skip-git-cli.test.ts pins the override-warning surface end-to-end. --------- Co-authored-by: Gergő Magyar <gergomagyar@icloud.com> Co-authored-by: Cursor <cursoragent@cursor.com>
295 lines
9.9 KiB
TypeScript
295 lines
9.9 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import { execSync } from 'child_process';
|
|
import path from 'path';
|
|
import os from 'os';
|
|
import fs from 'fs';
|
|
|
|
describe('--skip-git CLI flag', () => {
|
|
const cliPath = path.resolve(__dirname, '../../dist/cli/index.js');
|
|
|
|
it('Commander maps --skip-git to options.skipGit (not --no-git inversion)', () => {
|
|
// Verify the CLI defines --skip-git and --skip-agents-md in analyze help.
|
|
const helpOutput = execSync(`node "${cliPath}" analyze --help`, {
|
|
cwd: path.resolve(__dirname, '../..'),
|
|
encoding: 'utf8',
|
|
timeout: 10000,
|
|
});
|
|
|
|
expect(helpOutput).toContain('--skip-git');
|
|
expect(helpOutput).toContain('--skip-agents-md');
|
|
expect(helpOutput).toContain('--skip-skills');
|
|
expect(helpOutput).toContain('--index-only');
|
|
expect(helpOutput).not.toContain('--no-git');
|
|
});
|
|
|
|
it('warns when --index-only overrides --skills (PR 1485)', () => {
|
|
// `--index-only` suppresses the post-index skill step that `--skills`
|
|
// would otherwise trigger. Without an explicit warning, the user sees a
|
|
// pipeline re-index complete and silently no skill files written — the
|
|
// silent-contradiction case flagged in PR 1485 review.
|
|
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-index-only-skills-'));
|
|
const gitnexusHome = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-index-only-skills-home-'));
|
|
// Make tmpDir a git repo so analyze accepts it without --skip-git.
|
|
execSync('git init', { cwd: tmpDir, stdio: 'ignore' });
|
|
fs.writeFileSync(path.join(tmpDir, 'a.ts'), 'export const a = 1;\n');
|
|
|
|
const env = {
|
|
...process.env,
|
|
HOME: gitnexusHome,
|
|
GITNEXUS_HOME: gitnexusHome,
|
|
GITNEXUS_LBUG_EXTENSION_INSTALL: 'never',
|
|
};
|
|
|
|
try {
|
|
const output = execSync(
|
|
`node "${cliPath}" analyze "${tmpDir}" --index-only --skills --skip-agents-md`,
|
|
{ encoding: 'utf8', timeout: 60000, env },
|
|
);
|
|
expect(output).toContain('--index-only overrides --skills');
|
|
} finally {
|
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
fs.rmSync(gitnexusHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('rejects non-git folder without --skip-git', () => {
|
|
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-no-git-'));
|
|
fs.writeFileSync(path.join(tmpDir, 'test.ts'), 'export const x = 1;');
|
|
|
|
try {
|
|
execSync(`node dist/cli/index.js analyze "${tmpDir}"`, {
|
|
cwd: path.resolve(__dirname, '../..'),
|
|
encoding: 'utf8',
|
|
timeout: 10000,
|
|
});
|
|
// Should not reach here
|
|
expect.unreachable('Should have exited with non-zero');
|
|
} catch (err: any) {
|
|
expect(err.stdout || err.stderr || '').toContain('--skip-git');
|
|
} finally {
|
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
it('still respects .gitnexusignore when run with --skip-git', () => {
|
|
const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-skip-git-ignore-'));
|
|
const gitnexusHome = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-skip-git-ignore-home-'));
|
|
fs.mkdirSync(path.join(tmpDir, 'src'), { recursive: true });
|
|
fs.mkdirSync(path.join(tmpDir, 'customskip'), { recursive: true });
|
|
fs.writeFileSync(path.join(tmpDir, '.gitnexusignore'), 'customskip/\n');
|
|
fs.writeFileSync(path.join(tmpDir, 'src', 'keep.ts'), 'export function keep() { return 1; }\n');
|
|
fs.writeFileSync(
|
|
path.join(tmpDir, 'customskip', 'leaked.ts'),
|
|
'export function leaked() { return 42; }\n',
|
|
);
|
|
|
|
const env = {
|
|
...process.env,
|
|
HOME: gitnexusHome,
|
|
GITNEXUS_HOME: gitnexusHome,
|
|
GITNEXUS_LBUG_EXTENSION_INSTALL: 'never',
|
|
};
|
|
|
|
try {
|
|
execSync(`node "${cliPath}" analyze "${tmpDir}" --skip-git --skip-agents-md`, {
|
|
encoding: 'utf8',
|
|
timeout: 60000,
|
|
env,
|
|
});
|
|
|
|
const keepContext = execSync(
|
|
`node "${cliPath}" context keep --repo "${path.basename(tmpDir)}"`,
|
|
{
|
|
encoding: 'utf8',
|
|
timeout: 60000,
|
|
env,
|
|
},
|
|
);
|
|
expect(keepContext).toContain('"status": "found"');
|
|
expect(keepContext).toContain('"filePath": "src/keep.ts"');
|
|
|
|
const leakedContext = execSync(
|
|
`node "${cliPath}" context leaked --repo "${path.basename(tmpDir)}"`,
|
|
{
|
|
encoding: 'utf8',
|
|
timeout: 60000,
|
|
env,
|
|
},
|
|
);
|
|
expect(leakedContext).toContain(`"error": "Symbol 'leaked' not found"`);
|
|
} finally {
|
|
fs.rmSync(tmpDir, { recursive: true, force: true });
|
|
fs.rmSync(gitnexusHome, { recursive: true, force: true });
|
|
}
|
|
});
|
|
|
|
describe('--skip-git does not walk up to parent git repo (#1232)', () => {
|
|
let parentDir: string;
|
|
let gitnexusHome: string;
|
|
|
|
function testEnv() {
|
|
return {
|
|
...process.env,
|
|
HOME: parentDir,
|
|
GITNEXUS_HOME: gitnexusHome,
|
|
GITNEXUS_LBUG_EXTENSION_INSTALL: 'never',
|
|
};
|
|
}
|
|
|
|
function readRegistry(): Array<{ name: string; path: string }> {
|
|
const registryPath = path.join(gitnexusHome, 'registry.json');
|
|
expect(fs.existsSync(registryPath)).toBe(true);
|
|
return JSON.parse(fs.readFileSync(registryPath, 'utf8'));
|
|
}
|
|
|
|
function canonicalPath(filePath: string): string {
|
|
return fs.realpathSync(filePath);
|
|
}
|
|
|
|
function expectCoolioRegistryEntry() {
|
|
const registry = readRegistry();
|
|
const entry = registry.find((e) => e.name === 'COOLIO');
|
|
expect(entry).toBeTruthy();
|
|
if (!entry) throw new Error('Expected COOLIO registry entry');
|
|
expect(canonicalPath(entry.path)).toBe(canonicalPath(path.join(parentDir, 'COOLIO')));
|
|
expect(
|
|
registry.find((e) => canonicalPath(e.path) === canonicalPath(parentDir)),
|
|
).toBeUndefined();
|
|
expect(
|
|
registry.find(
|
|
(e) => canonicalPath(e.path) === canonicalPath(path.join(parentDir, 'SubWooder')),
|
|
),
|
|
).toBeUndefined();
|
|
return entry;
|
|
}
|
|
|
|
function initParentGitRepo() {
|
|
execSync('git init', { cwd: parentDir, stdio: 'ignore' });
|
|
execSync(
|
|
'git -c user.name=test -c user.email=test@example.com commit --allow-empty -m init',
|
|
{
|
|
cwd: parentDir,
|
|
stdio: 'ignore',
|
|
},
|
|
);
|
|
}
|
|
|
|
function createTestStructure() {
|
|
// Create structure:
|
|
// parentDir/
|
|
// .git/ (parent is a git repo)
|
|
// COOLIO/
|
|
// package.json
|
|
// src/index.ts
|
|
// SubWooder/
|
|
// package.json
|
|
// src/index.ts
|
|
parentDir = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-skip-git-'));
|
|
gitnexusHome = fs.mkdtempSync(path.join(os.tmpdir(), 'gn-skip-git-home-'));
|
|
initParentGitRepo();
|
|
fs.mkdirSync(path.join(parentDir, 'COOLIO', 'src'), { recursive: true });
|
|
fs.writeFileSync(
|
|
path.join(parentDir, 'COOLIO', 'package.json'),
|
|
JSON.stringify({ name: 'coolio' }),
|
|
);
|
|
fs.writeFileSync(
|
|
path.join(parentDir, 'COOLIO', 'src', 'index.ts'),
|
|
'export const hello = "world";',
|
|
);
|
|
fs.mkdirSync(path.join(parentDir, 'SubWooder', 'src'), { recursive: true });
|
|
fs.writeFileSync(
|
|
path.join(parentDir, 'SubWooder', 'package.json'),
|
|
JSON.stringify({ name: 'subwooder' }),
|
|
);
|
|
fs.writeFileSync(
|
|
path.join(parentDir, 'SubWooder', 'src', 'index.ts'),
|
|
'export const bass = 42;',
|
|
);
|
|
return parentDir;
|
|
}
|
|
|
|
function cleanup() {
|
|
if (parentDir) {
|
|
fs.rmSync(parentDir, { recursive: true, force: true });
|
|
}
|
|
if (gitnexusHome) {
|
|
fs.rmSync(gitnexusHome, { recursive: true, force: true });
|
|
}
|
|
}
|
|
|
|
it('from subdir inside parent git repo, indexes subdir not parent', () => {
|
|
createTestStructure();
|
|
try {
|
|
// Run analyze from COOLIO with --skip-git
|
|
const output = execSync(`node "${cliPath}" analyze --skip-git --skip-agents-md`, {
|
|
cwd: path.join(parentDir, 'COOLIO'),
|
|
encoding: 'utf8',
|
|
timeout: 60000,
|
|
env: testEnv(),
|
|
});
|
|
// Should mention COOLIO not the parent dir name
|
|
expect(output).toContain('COOLIO');
|
|
|
|
expectCoolioRegistryEntry();
|
|
|
|
const siblingQuery = execSync(`node "${cliPath}" query bass --repo COOLIO`, {
|
|
cwd: path.join(parentDir, 'COOLIO'),
|
|
encoding: 'utf8',
|
|
timeout: 60000,
|
|
env: testEnv(),
|
|
});
|
|
expect(siblingQuery).not.toContain('SubWooder');
|
|
expect(siblingQuery).not.toContain('bass');
|
|
} finally {
|
|
cleanup();
|
|
}
|
|
});
|
|
|
|
it('keeps parent git status clean for --skip-git subdir analyze (#1233)', () => {
|
|
createTestStructure();
|
|
try {
|
|
fs.writeFileSync(path.join(parentDir, '.gitignore'), '.claude/\n');
|
|
execSync('git add .gitignore COOLIO SubWooder', { cwd: parentDir, stdio: 'ignore' });
|
|
execSync('git -c user.name=test -c user.email=test@example.com commit -m fixtures', {
|
|
cwd: parentDir,
|
|
stdio: 'ignore',
|
|
});
|
|
|
|
execSync(`node "${cliPath}" analyze --skip-git --skip-agents-md`, {
|
|
cwd: path.join(parentDir, 'COOLIO'),
|
|
encoding: 'utf8',
|
|
timeout: 60000,
|
|
env: testEnv(),
|
|
});
|
|
|
|
expect(
|
|
fs.readFileSync(path.join(parentDir, 'COOLIO', '.gitnexus', '.gitignore'), 'utf8'),
|
|
).toBe('*\n');
|
|
const status = execSync('git status --short', {
|
|
cwd: parentDir,
|
|
encoding: 'utf8',
|
|
});
|
|
expect(status).toBe('');
|
|
} finally {
|
|
cleanup();
|
|
}
|
|
});
|
|
|
|
it('explicit input path with --skip-git indexes subdir', () => {
|
|
createTestStructure();
|
|
try {
|
|
const output = execSync(`node "${cliPath}" analyze ./COOLIO --skip-git --skip-agents-md`, {
|
|
cwd: parentDir,
|
|
encoding: 'utf8',
|
|
timeout: 60000,
|
|
env: testEnv(),
|
|
});
|
|
expect(output).toContain('COOLIO');
|
|
|
|
expectCoolioRegistryEntry();
|
|
} finally {
|
|
cleanup();
|
|
}
|
|
});
|
|
});
|
|
});
|