| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119 |
- /**
- * `codegraph node` argument handling (#1044).
- *
- * File-read mode (`codegraph node -f <file>`) carries no symbol name, but the
- * command was defined with a REQUIRED `<name>` positional, so commander.js
- * rejected the call with "missing required argument 'name'" before the action
- * ever ran — making file mode unreachable from the CLI. `name` is now optional
- * (`[name]`); the action validates that a symbol OR a file is supplied.
- *
- * Exercised end-to-end against the built binary.
- */
- import { describe, it, expect, beforeEach, afterEach } from 'vitest';
- import { execFileSync } from 'child_process';
- import * as fs from 'fs';
- import * as os from 'os';
- import * as path from 'path';
- import { CodeGraph } from '../src';
- const BIN = path.resolve(__dirname, '../dist/bin/codegraph.js');
- function runNode(cwd: string, extraArgs: string[]): { stdout: string; stderr: string; code: number } {
- try {
- const stdout = execFileSync(process.execPath, [BIN, 'node', ...extraArgs, '-p', cwd], {
- encoding: 'utf-8',
- env: { ...process.env, CODEGRAPH_NO_DAEMON: '1', CODEGRAPH_WASM_RELAUNCHED: '1' },
- stdio: ['ignore', 'pipe', 'pipe'],
- });
- return { stdout, stderr: '', code: 0 };
- } catch (err: any) {
- return { stdout: err.stdout ?? '', stderr: err.stderr ?? '', code: err.status ?? 1 };
- }
- }
- describe('codegraph node — argument handling (#1044)', () => {
- let tempDir: string;
- beforeEach(async () => {
- tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'codegraph-node-cmd-'));
- fs.mkdirSync(path.join(tempDir, 'src'));
- fs.writeFileSync(path.join(tempDir, 'src/util.ts'), 'export function util(x: number){ return x + 1; }\n');
- const cg = CodeGraph.initSync(tempDir);
- await cg.indexAll();
- cg.close();
- });
- afterEach(() => {
- fs.rmSync(tempDir, { recursive: true, force: true });
- });
- it('file mode via -f reads the file (was rejected as "missing required argument")', () => {
- const { stdout, code } = runNode(tempDir, ['-f', 'src/util.ts']);
- expect(code).toBe(0);
- expect(stdout).toContain('src/util.ts');
- expect(stdout).toContain('export function util');
- // The line-numbered Read-parity shape.
- expect(stdout).toMatch(/1\s+export function util/);
- });
- it('a path-like positional still routes to file mode', () => {
- const { stdout, code } = runNode(tempDir, ['src/util.ts']);
- expect(code).toBe(0);
- expect(stdout).toContain('src/util.ts');
- expect(stdout).toContain('export function util');
- });
- it('a bare symbol positional still routes to symbol mode', () => {
- const { stdout, code } = runNode(tempDir, ['util']);
- expect(code).toBe(0);
- expect(stdout).toContain('util');
- expect(stdout).toContain('Location:');
- });
- it('neither symbol nor file gives a usage error, not commander\'s cryptic one', () => {
- const { stderr, code } = runNode(tempDir, []);
- expect(code).not.toBe(0);
- expect(stderr).toMatch(/symbol name|file/i);
- expect(stderr).not.toMatch(/missing required argument/);
- });
- });
- describe('codegraph node — symbol pinned to a file includes the body (#1284)', () => {
- let tempDir: string;
- beforeEach(async () => {
- tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'codegraph-node-pin-'));
- fs.mkdirSync(path.join(tempDir, 'a'));
- fs.mkdirSync(path.join(tempDir, 'b'));
- // Two same-named definitions, so `-f` is genuinely disambiguating.
- fs.writeFileSync(
- path.join(tempDir, 'a', 'state.ts'),
- 'export function setState(x: number): void {\n console.log("A", x);\n}\n'
- );
- fs.writeFileSync(
- path.join(tempDir, 'b', 'state.ts'),
- 'export function setState(y: string): void {\n console.log("B", y);\n}\n'
- );
- const cg = CodeGraph.initSync(tempDir);
- await cg.indexAll();
- cg.close();
- });
- afterEach(() => {
- fs.rmSync(tempDir, { recursive: true, force: true });
- });
- it('`node <symbol> -f <file>` prints the pinned definition WITH its source body', () => {
- // The exact #1284 shape: `-f` narrowed the overload correctly but printed
- // only Location + trail — no code fence — so the user had nothing to read.
- const { stdout, code } = runNode(tempDir, ['setState', '-f', 'a/state.ts']);
- expect(code).toBe(0);
- expect(stdout).toContain('a/state.ts');
- // The body is present (line-numbered fence), and it's the pinned overload.
- expect(stdout).toMatch(/1\s+export function setState\(x: number\)/);
- expect(stdout).toContain('console.log("A", x)');
- // The other file's overload is not what was pinned.
- expect(stdout).not.toContain('console.log("B", y)');
- });
- });
|