scip-query 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,254 @@
+import { V as ScipSymbol, X as ScipLocalSymbol, Y as SupportedLanguage, Z as IndexerConfig, _ as ProjectConfig, $ as WatcherStatus } from './db-BxaevAyc.js';
+export { A as AffectedResult, B as BottleneckResult, a as ByKindResult, C as CallGraphResult, a0 as ChangeSurfaceEntry, b as ChangeSurfaceResult, c as CodeResult, d as ComplexityHotspot, e as ComplexityResult, f as ConvergenceResult, g as CouplingResult, h as CycleResult, D as DataflowResult, i as DeadOptions, j as DeadSummary, a1 as DeadSymbolResult, k as DeepChainResult, l as DepResult, a2 as DescriptorSuffix, m as DiffImpactResult, n as DocCoverageResult, a3 as DriftResult, o as DriftSummary, E as ExtractCandidate, F as FanResult, p as FileResult, a4 as HealthAction, H as HealthReport, q as HierarchyNode, r as HotspotResult, I as ImportResult, a5 as IndexerOverrides, a6 as InstallMethod, s as IsolatedResult, M as MemberResult, t as MethodResult, O as OutlineNode, P as PassthroughCandidate, N as RedundantReexport, R as RefResult, S as ScipDatabase, a7 as ScipDescriptor, a8 as ScipQueryConfig, J as SimilarChainResult, G as SimilarFileResult, Q as SimilarSignatureGroup, z as SimilarSymbolResult, L as SliceResult, K as StaleAbstraction, u as StatsResult, x as SurfaceResult, v as SymbolResult, w as SystemResult, y as TestCoverageResult, T as TraceResult, U as UnusedImportResult, a9 as WatchConfig, W as WrapperCandidate, aa as createGitignoreFilter } from './db-BxaevAyc.js';
+export { stats } from './queries/stats.js';
+export { files } from './queries/files.js';
+export { symbols } from './queries/symbols.js';
+export { methods } from './queries/methods.js';
+export { refs } from './queries/refs.js';
+export { trace } from './queries/trace.js';
+export { deps, rdeps } from './queries/deps.js';
+export { system } from './queries/system.js';
+export { surface } from './queries/surface.js';
+export { dead } from './queries/dead.js';
+export { hotspots } from './queries/hotspots.js';
+export { importedBy, imports, unusedImports } from './queries/imports.js';
+export { outline } from './queries/outline.js';
+export { members } from './queries/members.js';
+export { fanIn, fanOut, topFanIn, topFanOut } from './queries/fan.js';
+export { coupling, topCoupling } from './queries/coupling.js';
+export { cycles } from './queries/cycles.js';
+export { bottlenecks } from './queries/bottlenecks.js';
+export { isolated } from './queries/isolated.js';
+export { byKind, kindCounts } from './queries/by-kind.js';
+export { testCoverage, testCoverageSummary } from './queries/test-coverage.js';
+export { docCoverage } from './queries/doc-coverage.js';
+export { deepChains } from './queries/deep-chains.js';
+export { hierarchy } from './queries/hierarchy.js';
+export { callGraph } from './queries/call-graph.js';
+export { similar, similarAll } from './queries/similar.js';
+export { similarFiles } from './queries/similar-files.js';
+export { similarChains } from './queries/similar-chains.js';
+export { extractCandidates } from './queries/extract-candidates.js';
+export { affected } from './queries/affected.js';
+export { changeSurface } from './queries/change-surface.js';
+export { diffImpact } from './queries/diff-impact.js';
+export { drift } from './queries/drift.js';
+export { wrapperCandidates } from './queries/wrapper-candidates.js';
+export { passthroughCandidates } from './queries/passthrough-candidates.js';
+export { staleAbstractions } from './queries/stale-abstractions.js';
+export { complexityHotspots } from './queries/complexity-hotspots.js';
+export { health } from './queries/health.js';
+export { convergence } from './queries/convergence.js';
+export { code } from './queries/code.js';
+export { complexity } from './queries/complexity.js';
+export { dataflow } from './queries/dataflow.js';
+export { slice } from './queries/slice.js';
+export { redundantReexports } from './queries/redundant-reexports.js';
+export { similarSignatures } from './queries/similar-signatures.js';
+import 'better-sqlite3';
+
+/**
+ * Parse a SCIP symbol string into its structured components.
+ * Works for any SCIP-indexed language (TypeScript, Java, Rust, Python, etc.)
+ */
+declare function parseSymbol(raw: string): ScipSymbol | ScipLocalSymbol;
+/**
+ * Convert a parsed SCIP symbol to a short, human-readable name.
+ * Language-agnostic: works for any SCIP-indexed language.
+ *
+ * Examples:
+ *   "scip-typescript npm @vega/api 0.1.3 src/modules/auth/auth.service.ts/AuthService#login()."
+ *   → "auth.service:AuthService:login()"
+ *
+ *   "scip-java maven com.example/mylib 1.0.0 com/example/MyClass#doStuff()."
+ *   → "MyClass:doStuff()"
+ *
+ *   "rust-analyzer cargo my-crate 0.1.0 src/lib.rs/MyStruct#new()."
+ *   → "lib:MyStruct:new()"
+ */
+declare function shortenSymbol(raw: string): string;
+/**
+ * Extract just the leaf name from a SCIP symbol.
+ * Useful when you only need the function/class/variable name without path context.
+ */
+declare function leafName(raw: string): string;
+
+/**
+ * Detect which languages are present in a project directory
+ * by checking for marker files.
+ */
+declare function detectLanguages(projectRoot: string): SupportedLanguage[];
+
+/**
+ * Indexer configurations for each supported language.
+ * Each entry describes how to produce a SCIP index for that language.
+ *
+ * The `scip` CLI binary is required for all languages (to convert protobuf -> SQLite).
+ * Each language also needs its own SCIP indexer installed.
+ */
+declare const INDEXER_CONFIGS: Record<SupportedLanguage, IndexerConfig>;
+/** Get the indexer config for a language */
+declare function getIndexerConfig(language: SupportedLanguage): IndexerConfig;
+
+/**
+ * Check if a binary is available on PATH.
+ */
+declare function isBinaryAvailable(name: string): boolean;
+/**
+ * Check if an indexer's binary is available on PATH.
+ */
+declare function isIndexerInstalled(config: IndexerConfig): boolean;
+/**
+ * Attempt to auto-install an indexer using its configured install methods.
+ * Tries each method in order, checking prerequisites first.
+ * Returns true if installation succeeded.
+ */
+declare function tryInstallIndexer(config: IndexerConfig, onStatus: (msg: string) => void): boolean;
+/**
+ * Attempt to auto-install the `scip` CLI binary.
+ * Tries brew (macOS), then go install, then prints manual instructions.
+ * Returns true if installation succeeded.
+ */
+declare function tryInstallScipCli(onStatus: (msg: string) => void): boolean;
+
+interface ReindexOptions {
+    projectRoot: string;
+    /** Override language detection — index only these languages */
+    languages?: SupportedLanguage[];
+    /** Path for the SCIP protobuf output (default: <projectRoot>/index.scip) */
+    outputScip?: string;
+    /** Path for the SQLite output (default: <projectRoot>/index.db) */
+    outputDb?: string;
+    /** Max Node.js heap size in MB (default: 8192) */
+    maxHeapMb?: number;
+    /** Callback for status updates */
+    onStatus?: (message: string) => void;
+    /** Extra flags for pnpm-workspace-aware TS indexing */
+    pnpmWorkspaces?: boolean;
+    /** Skip auto-install prompts */
+    skipAutoInstall?: boolean;
+}
+interface ReindexResult {
+    languages: SupportedLanguage[];
+    indexPath: string;
+    dbPath: string;
+    durationMs: number;
+}
+/**
+ * Reindex a project: detect languages, run the appropriate SCIP indexer(s),
+ * and convert the output to SQLite.
+ */
+declare function reindex(opts: ReindexOptions): Promise<ReindexResult>;
+
+/**
+ * Load project config from .scipquery.json in the project root.
+ * Returns defaults for anything not specified.
+ */
+declare function loadProjectConfig(projectRoot: string): ProjectConfig;
+/**
+ * Resolve the cache directory for a project's SCIP index.
+ *
+ * Default: ~/.cache/scip-query/projects/<hash>/
+ * Override: project config dbPath, or SCIP_QUERY_DB_PATH env var
+ *
+ * The hash is derived from the absolute project path so each
+ * project gets its own isolated index storage.
+ */
+declare function resolveCacheDir(projectRoot: string, config?: ProjectConfig): string;
+/**
+ * Resolve all paths for a project's index files.
+ */
+declare function resolveIndexPaths(projectRoot: string, config?: ProjectConfig): {
+    cacheDir: string;
+    dbPath: string;
+    indexPath: string;
+    metaPath: string;
+};
+/**
+ * Scaffold a default .scipquery.json in the project root.
+ * Does not overwrite an existing config.
+ */
+declare function initProjectConfig(projectRoot: string, languages: string[]): string;
+
+interface WatcherOptions {
+    projectRoot: string;
+    config: ProjectConfig;
+    languages?: SupportedLanguage[];
+    onStatus?: (status: WatcherStatus) => void;
+    onReindexComplete?: (durationMs: number) => void;
+    onError?: (error: Error) => void;
+}
+/**
+ * File watcher that triggers single-flight background reindexing.
+ *
+ * Design:
+ *  - Debounce: waits 30s (configurable) after the last file change
+ *  - Single-flight: only one reindex runs at a time, never queued
+ *  - Dirty flag: changes during reindex schedule ONE follow-up
+ *  - Cooldown: minimum interval between reindex completions
+ *  - Atomic swap: writes to index.db.tmp, renames on success
+ */
+declare class Watcher {
+    private projectRoot;
+    private watchConfig;
+    private indexPaths;
+    private languages?;
+    private pnpmWorkspaces;
+    private onStatus;
+    private onReindexComplete;
+    private onError;
+    private status;
+    private debounceTimer;
+    private cooldownTimer;
+    private dirty;
+    private changedFiles;
+    private reindexInFlight;
+    private lastReindexEnd;
+    private fsWatchers;
+    private gitignoreFilter;
+    private extraIgnore;
+    private stopped;
+    constructor(opts: WatcherOptions);
+    /** Start watching for file changes */
+    start(): void;
+    /** Stop watching and clean up */
+    stop(): void;
+    /** Get current watcher status */
+    getStatus(): WatcherStatus;
+    private handleFileChange;
+    private triggerReindex;
+    /**
+     * Run the reindex in a forked child process.
+     * Writes to index.db.tmp, then atomically renames to index.db.
+     */
+    private runReindex;
+    private setStatus;
+}
+
+interface InstallSkillsResult {
+    installed: string[];
+    skipped: string[];
+    alreadyLinked: string[];
+}
+/**
+ * Install scip-query skills into both Claude Code (~/.claude/skills/)
+ * and Codex (~/.codex/skills/). Uses symlinks (junctions on Windows)
+ * so skills auto-update when the package updates.
+ */
+declare function installSkills(opts?: {
+    quiet?: boolean;
+}): InstallSkillsResult;
+/**
+ * Check if the `scip` CLI binary is available on PATH.
+ */
+declare function isScipInstalled(): boolean;
+/**
+ * Get the scip CLI version if installed.
+ */
+declare function getScipVersion(): string | null;
+/**
+ * Print instructions for installing the scip CLI binary.
+ */
+declare function printScipInstallInstructions(): void;
+
+export { INDEXER_CONFIGS, IndexerConfig, ProjectConfig, ScipLocalSymbol, ScipSymbol, SupportedLanguage, Watcher, WatcherStatus, detectLanguages, getIndexerConfig, getScipVersion, initProjectConfig, installSkills, isBinaryAvailable, isIndexerInstalled, isScipInstalled, leafName, loadProjectConfig, parseSymbol, printScipInstallInstructions, reindex, resolveCacheDir, resolveIndexPaths, shortenSymbol, tryInstallIndexer, tryInstallScipCli };