@shvmgyl15/tsgraph 0.1.0 → 0.2.0

package/src/report/index.ts

@@ -1,128 +0,0 @@
-import type { Graph } from "../graph/types.js";
-import fs from "node:fs";
-import path from "node:path";
-import { analyzeCoupling, findHotspots } from "../analysis/index.js";
-import { checkBoundaries, loadBoundariesConfig } from "../boundaries/index.js";
-import { getStale } from "../changes/index.js";
-
-export interface ReportOptions {
-  rootDir?: string;
-  includeBoundaries?: boolean;
-  includeStale?: boolean;
-  includeHotspots?: boolean;
-}
-
-export function generateReport(graph: Graph, opts: ReportOptions = {}): string {
-  const lines: string[] = [];
-
-  lines.push("# tsgraph Report");
-  lines.push("");
-  lines.push(`Generated at: ${graph.generatedAt}`);
-  lines.push(`Root: \`${graph.root}\``);
-  lines.push("");
-
-  lines.push("## Packages");
-  lines.push("");
-  for (const pkg of graph.packages) {
-    lines.push(`- **${pkg.name}** — ${pkg.files.length} files`);
-  }
-  lines.push("");
-
-  if (graph.dependencies.length > 0) {
-    lines.push("## Dependencies");
-    lines.push("");
-    lines.push("| Module | Version |");
-    lines.push("| --- | --- |");
-    for (const dep of graph.dependencies) {
-      lines.push(`| \`${dep.module}\` | \`${dep.version}\` |`);
-    }
-    lines.push("");
-  }
-
-  lines.push("## Symbols");
-  lines.push("");
-  const kindCounts = new Map<string, number>();
-  for (const sym of graph.symbols) {
-    kindCounts.set(sym.kind, (kindCounts.get(sym.kind) ?? 0) + 1);
-  }
-  for (const [kind, count] of [...kindCounts.entries()].sort()) {
-    lines.push(`- **${kind}**: ${count}`);
-  }
-  lines.push("");
-
-  if (opts.includeHotspots) {
-    lines.push("## Hotspots");
-    lines.push("");
-    const hotspots = findHotspots(graph, 10);
-    if (hotspots.length > 0) {
-      lines.push("| File | Score | Complexity | Lines |");
-      lines.push("| --- | --- | --- | --- |");
-      for (const h of hotspots) {
-        lines.push(`| \`${h.file}\` | ${h.score} | ${h.totalComplexity} | ${h.lines} |`);
-      }
-      lines.push("");
-    }
-  }
-
-  if (opts.includeBoundaries && opts.rootDir) {
-    const config = loadBoundariesConfig(opts.rootDir);
-    if (config) {
-      const result = checkBoundaries(graph, config);
-      lines.push("## Architecture Boundaries");
-      lines.push("");
-      lines.push(`- Layers: ${config.layers.map((l) => l.name).join(", ")}`);
-      lines.push(`- Allowed imports: ${result.allowed}`);
-      lines.push(`- Violations: ${result.violations.length}`);
-      if (result.violations.length > 0) {
-        lines.push("");
-        for (const v of result.violations.slice(0, 20)) {
-          lines.push(`- ❌ \`${v.fromFile}\` → \`${v.toFile}\`: ${v.rule}`);
-        }
-        if (result.violations.length > 20) {
-          lines.push(`- ... and ${result.violations.length - 20} more`);
-        }
-      }
-      lines.push("");
-    }
-  }
-
-  if (opts.includeStale && opts.rootDir) {
-    const stale = getStale(graph, opts.rootDir, 90);
-    if (stale.totalFiles > 0) {
-      lines.push("## Stale Files");
-      lines.push("");
-      lines.push(`Files untouched in 90+ days: ${stale.totalFiles}`);
-      for (const f of stale.files.slice(0, 20)) {
-        lines.push(`- \`${f.path}\` — ${f.symbolCount} symbol(s)`);
-      }
-      if (stale.files.length > 20) {
-        lines.push(`- ... and ${stale.files.length - 20} more`);
-      }
-      lines.push("");
-    }
-  }
-
-  if (graph.packages.length > 1) {
-    lines.push("## Coupling");
-    lines.push("");
-    const coupling = analyzeCoupling(graph).slice(0, 15);
-    if (coupling.length > 0) {
-      lines.push("| Package | Coupled To | Imports | Files |");
-      lines.push("| --- | --- | --- | --- |");
-      for (const c of coupling) {
-        lines.push(`| ${c.packageName} | ${c.coupledTo} | ${c.importCount} | ${c.fileCount} |`);
-      }
-      lines.push("");
-    }
-  }
-
-  lines.push("## Summary");
-  lines.push("");
-  lines.push(`- Files: ${graph.files.length}`);
-  lines.push(`- Symbols: ${graph.symbols.length}`);
-  lines.push(`- Calls: ${graph.calls.length}`);
-  lines.push(`- Imports: ${graph.imports.length}`);
-  lines.push(`- Dependencies: ${graph.dependencies.length}`);
-
-  return lines.join("\n") + "\n";
-}

package/src/scanner/index.ts

@@ -1,97 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import ignore from "ignore";
-
-export type FileKind = "ts" | "tsx" | "js" | "jsx" | "json" | "other";
-
-export interface ScannedFile {
-  path: string;
-  relativePath: string;
-  kind: FileKind;
-  isGenerated: boolean;
-}
-
-export interface ScanResult {
-  files: ScannedFile[];
-  errors: Error[];
-}
-
-const ALWAYS_IGNORE = ["node_modules", ".git", "dist", ".tsgraph", ".gitignore"];
-
-const GENERATED_PATTERNS = [
-  /@generated/,
-  /Code generated by/,
-  /auto-generated/,
-  /This file is generated/,
-];
-
-const FILE_EXT_MAP: Record<string, FileKind> = {
-  ".ts": "ts",
-  ".tsx": "tsx",
-  ".js": "js",
-  ".jsx": "jsx",
-  ".json": "json",
-};
-
-function classifyFile(filePath: string): FileKind {
-  return FILE_EXT_MAP[path.extname(filePath).toLowerCase()] ?? "other";
-}
-
-function checkGenerated(filePath: string): boolean {
-  try {
-    const fd = fs.openSync(filePath, "r");
-    const buffer = Buffer.alloc(256);
-    const bytesRead = fs.readSync(fd, buffer, 0, 256, 0);
-    fs.closeSync(fd);
-    const firstChunk = buffer.toString("utf-8", 0, bytesRead).split("\n")[0];
-    return GENERATED_PATTERNS.some((p) => p.test(firstChunk));
-  } catch {
-    return false;
-  }
-}
-
-export function scanFiles(rootDir: string): ScanResult {
-  const ig = ignore().add(ALWAYS_IGNORE);
-  const gitignorePath = path.join(rootDir, ".gitignore");
-  try {
-    ig.add(fs.readFileSync(gitignorePath, "utf-8"));
-  } catch {
-    // no .gitignore — built-in rules suffice
-  }
-
-  const files: ScannedFile[] = [];
-  const errors: Error[] = [];
-
-  function walk(dir: string) {
-    let entries: fs.Dirent[];
-    try {
-      entries = fs.readdirSync(dir, { withFileTypes: true });
-    } catch (err) {
-      errors.push(err as Error);
-      return;
-    }
-
-    for (const entry of entries) {
-      const fullPath = path.join(dir, entry.name);
-      const relativePath = path.relative(rootDir, fullPath);
-
-      if (entry.isDirectory()) {
-        if (ig.ignores(relativePath + "/")) continue;
-        walk(fullPath);
-      } else if (entry.isFile()) {
-        if (ig.ignores(relativePath)) continue;
-        const kind = classifyFile(fullPath);
-        files.push({
-          path: fullPath,
-          relativePath,
-          kind,
-          isGenerated: checkGenerated(fullPath),
-        });
-      }
-    }
-  }
-
-  walk(rootDir);
-
-  return { files, errors };
-}

package/src/scanner/scanner.test.ts

@@ -1,135 +0,0 @@
-import { describe, it, expect } from "vitest";
-import path from "node:path";
-import fs from "node:fs";
-import os from "node:os";
-import { scanFiles } from "./index.js";
-
-function createTempDir(): string {
-  return fs.mkdtempSync(path.join(os.tmpdir(), "tsgraph-test-"));
-}
-
-function writeFile(dir: string, relativePath: string, content: string) {
-  const fullPath = path.join(dir, relativePath);
-  fs.mkdirSync(path.dirname(fullPath), { recursive: true });
-  fs.writeFileSync(fullPath, content, "utf-8");
-}
-
-describe("scanFiles", () => {
-  it("finds .ts files in a flat directory", () => {
-    const dir = createTempDir();
-    writeFile(dir, "index.ts", "");
-    writeFile(dir, "util.ts", "");
-
-    const result = scanFiles(dir);
-    const paths = result.files.map((f) => f.relativePath).sort();
-    expect(paths).toEqual(["index.ts", "util.ts"]);
-    expect(result.errors).toEqual([]);
-
-    fs.rmSync(dir, { recursive: true });
-  });
-
-  it("ignores node_modules by default", () => {
-    const dir = createTempDir();
-    writeFile(dir, "index.ts", "");
-    writeFile(dir, "node_modules/foo/index.ts", "");
-    writeFile(dir, "node_modules/bar/index.js", "");
-
-    const result = scanFiles(dir);
-    const paths = result.files.map((f) => f.relativePath);
-    expect(paths).toEqual(["index.ts"]);
-    fs.rmSync(dir, { recursive: true });
-  });
-
-  it("ignores .git, dist, .tsgraph by default", () => {
-    const dir = createTempDir();
-    writeFile(dir, "src/index.ts", "");
-    writeFile(dir, ".git/HEAD", "");
-    writeFile(dir, "dist/bundle.js", "");
-    writeFile(dir, ".tsgraph/graph.json", "");
-
-    const result = scanFiles(dir);
-    const paths = result.files.map((f) => f.relativePath).sort();
-    expect(paths).toEqual(["src/index.ts"]);
-    fs.rmSync(dir, { recursive: true });
-  });
-
-  it("respects .gitignore patterns", () => {
-    const dir = createTempDir();
-    writeFile(dir, ".gitignore", "*.log\n/build");
-    writeFile(dir, "src/index.ts", "");
-    writeFile(dir, "server.log", "");
-    writeFile(dir, "build/output.js", "");
-
-    const result = scanFiles(dir);
-    const paths = result.files.map((f) => f.relativePath);
-    expect(paths).toEqual(["src/index.ts"]);
-    fs.rmSync(dir, { recursive: true });
-  });
-
-  it("classifies file kinds correctly", () => {
-    const dir = createTempDir();
-    writeFile(dir, "a.ts", "");
-    writeFile(dir, "b.tsx", "");
-    writeFile(dir, "c.js", "");
-    writeFile(dir, "d.jsx", "");
-    writeFile(dir, "e.json", "");
-    writeFile(dir, "f.css", "");
-
-    const result = scanFiles(dir);
-    const kinds = Object.fromEntries(
-      result.files.map((f) => [f.relativePath, f.kind]),
-    );
-    expect(kinds["a.ts"]).toBe("ts");
-    expect(kinds["b.tsx"]).toBe("tsx");
-    expect(kinds["c.js"]).toBe("js");
-    expect(kinds["d.jsx"]).toBe("jsx");
-    expect(kinds["e.json"]).toBe("json");
-    expect(kinds["f.css"]).toBe("other");
-    fs.rmSync(dir, { recursive: true });
-  });
-
-  it("detects generated files by first-line comment", () => {
-    const dir = createTempDir();
-    writeFile(dir, "generated.ts", "// @generated\nconst x = 1;\n");
-    writeFile(dir, "normal.ts", "const x = 1;\n");
-    writeFile(dir, "auto.ts", "// auto-generated\nconst y = 2;\n");
-    writeFile(dir, "codegen.ts", "// Code generated by protoc\nconst z = 3;\n");
-
-    const result = scanFiles(dir);
-    const genMap = Object.fromEntries(
-      result.files.map((f) => [f.relativePath, f.isGenerated]),
-    );
-    expect(genMap["generated.ts"]).toBe(true);
-    expect(genMap["normal.ts"]).toBe(false);
-    expect(genMap["auto.ts"]).toBe(true);
-    expect(genMap["codegen.ts"]).toBe(true);
-    fs.rmSync(dir, { recursive: true });
-  });
-
-  it("handles missing .gitignore gracefully", () => {
-    const dir = createTempDir();
-    writeFile(dir, "index.ts", "");
-    // Intentionally no .gitignore
-
-    const result = scanFiles(dir);
-    expect(result.files.length).toBe(1);
-    expect(result.errors).toEqual([]);
-    fs.rmSync(dir, { recursive: true });
-  });
-
-  it("walks nested directories", () => {
-    const dir = createTempDir();
-    writeFile(dir, "src/index.ts", "");
-    writeFile(dir, "src/components/button.tsx", "");
-    writeFile(dir, "src/utils/helpers.ts", "");
-
-    const result = scanFiles(dir);
-    const paths = result.files.map((f) => f.relativePath).sort();
-    expect(paths).toEqual([
-      "src/components/button.tsx",
-      "src/index.ts",
-      "src/utils/helpers.ts",
-    ]);
-    fs.rmSync(dir, { recursive: true });
-  });
-});

package/src/search/index.ts

@@ -1,163 +0,0 @@
-import fs from "node:fs";
-import path from "node:path";
-import type {
-  Graph,
-  SymbolNode,
-  CallEdge,
-  ImportEdge,
-  FileNode,
-  PackageNode,
-} from "../graph/types.js";
-import { deserialize } from "../graph/types.js";
-
-export interface CallerResult {
-  callerSymbol: SymbolNode;
-  edges: CallEdge[];
-}
-
-export interface CalleeResult {
-  calleeRaw: string;
-  edges: CallEdge[];
-}
-
-export interface FocusResult {
-  pkg: PackageNode;
-  files: FileNode[];
-  symbols: SymbolNode[];
-  imports: ImportEdge[];
-}
-
-export interface ContextResult {
-  node?: SymbolNode;
-  source?: string;
-  callers: CallerResult[];
-  callees: CalleeResult[];
-}
-
-export function loadGraph(graphPath: string): Graph {
-  const raw = fs.readFileSync(graphPath, "utf-8");
-  return deserialize(raw);
-}
-
-export function findCallers(graph: Graph, name: string): CallerResult[] {
-  const matchingEdges = graph.calls.filter(
-    (c) => c.calleeRaw === name,
-  );
-  const callerMap = new Map<string, CallerResult>();
-  for (const edge of matchingEdges) {
-    const caller = graph.symbols.find((s) => s.id === edge.callerSymbolId);
-    if (!caller) continue;
-    const key = caller.id;
-    let result = callerMap.get(key);
-    if (!result) {
-      result = { callerSymbol: caller, edges: [] };
-      callerMap.set(key, result);
-    }
-    result.edges.push(edge);
-  }
-  return [...callerMap.values()];
-}
-
-export function findCallees(graph: Graph, name: string): CalleeResult[] {
-  const sym = graph.symbols.find((s) => s.name === name);
-  if (!sym) return [];
-  const edges = graph.calls.filter((c) => c.callerSymbolId === sym.id);
-  const calleeMap = new Map<string, CalleeResult>();
-  for (const edge of edges) {
-    let result = calleeMap.get(edge.calleeRaw);
-    if (!result) {
-      result = { calleeRaw: edge.calleeRaw, edges: [] };
-      calleeMap.set(edge.calleeRaw, result);
-    }
-    result.edges.push(edge);
-  }
-  return [...calleeMap.values()];
-}
-
-export function findNode(graph: Graph, name: string): SymbolNode | undefined {
-  return graph.symbols.find((s) => s.name === name);
-}
-
-export function readSource(graph: Graph, symbol: SymbolNode): string {
-  const filePath = path.join(graph.root, symbol.file);
-  const content = fs.readFileSync(filePath, "utf-8");
-  const lines = content.split("\n");
-  const start = Math.max(0, symbol.line - 1);
-  const end = Math.min(lines.length, symbol.endLine);
-  const snippet = lines.slice(start, end);
-  const padLen = String(end).length;
-  return snippet
-    .map((line, i) => {
-      const lineNum = symbol.line + i;
-      return `${String(lineNum).padStart(padLen)}  ${line}`;
-    })
-    .join("\n");
-}
-
-export function querySymbols(
-  graph: Graph,
-  pattern: string,
-): SymbolNode[] {
-  const lower = pattern.toLowerCase();
-  return graph.symbols.filter(
-    (s) =>
-      s.name.toLowerCase().includes(lower) ||
-      s.file.toLowerCase().includes(lower) ||
-      s.packageName.toLowerCase().includes(lower),
-  );
-}
-
-export function findImports(
-  graph: Graph,
-  importPath: string,
-): ImportEdge[] {
-  const lower = importPath.toLowerCase();
-  return graph.imports.filter((i) =>
-    i.importPath.toLowerCase().includes(lower),
-  );
-}
-
-export function findPublic(
-  graph: Graph,
-  packageName?: string,
-): SymbolNode[] {
-  return graph.symbols.filter(
-    (s) =>
-      s.isExported &&
-      (packageName === undefined || s.packageName === packageName),
-  );
-}
-
-export function focusPackage(
-  graph: Graph,
-  packageName: string,
-): FocusResult | undefined {
-  const pkg = graph.packages.find((p) => p.name === packageName);
-  if (!pkg) return undefined;
-  const files = graph.files.filter((f) => f.packageName === packageName);
-  const symbols = graph.symbols.filter(
-    (s) => s.packageName === packageName,
-  );
-  const imports = graph.imports.filter(
-    (i) => i.fromPackage === packageName,
-  );
-  return { pkg, files, symbols, imports };
-}
-
-export function context(
-  graph: Graph,
-  symbolName: string,
-): ContextResult {
-  const node = findNode(graph, symbolName);
-  let source: string | undefined;
-  if (node) {
-    try {
-      source = readSource(graph, node);
-    } catch {
-      // source file not available
-    }
-  }
-  const callers = findCallers(graph, symbolName);
-  const callees = findCallees(graph, symbolName);
-  return { node, source, callers, callees };
-}