@ankhorage/project-detector

Extensible, evidence-based project detection and safe filesystem inspection.

Generated documentation

• Interactive documentation app
• Public API reference
• Component registry
• Architecture overview
• Module relationships
• Export graph
• detectProject sequence
• inspectWithPortAsync sequence
• project-detector sequence

Public API

Utilities

detectProject(input: ProjectDetectionInput, options?: ProjectDetectionOptions) => ProjectDetection

Detect overlapping project languages, frameworks, runtimes and package-manager evidence.

The pure API accepts package metadata plus optional relative POSIX file paths and manifest text. JavaScript, TypeScript, Java, Kotlin, C++, Python and Delphi evidence is additive, never exclusive. Generic Make/CMake/Gradle files identify build tools, not necessarily a source language. Scores are heuristic strengths, not confidence probabilities. No source parser, registry request, dependency update, migration, filesystem operation or inspected project script runs here. Extend detection with explicitly supplied trusted detector callbacks; IDs must be unique. Public types are owned by this package and exported through @ankhorage/project-detector/types.

Module: src/features/detection/application/detectProject.ts Source: src/features/detection/application/detectProject.ts:24:1 Related symbols: ProjectDetection, ProjectDetectionInput, ProjectDetectionOptions

inspectProjectAsync(path: string, options?: ProjectInspectionOptions) => Promise<ProjectInspection>

Inspect a directory using bounded, asynchronous, read-only filesystem access.

Import from @ankhorage/project-detector/node. Defaults: depth 16, 20,000 entries, 256 KiB per manifest and 8 MiB total manifest text. Dependency/build/cache directories, including generated .ankh, are pruned. Symlinks outside exclusions are skipped with diagnostics; their targets are never intentionally scanned. Pass an AbortSignal to cancel. Configure additional manifest basenames and detector callbacks for new ecosystems. Package/workspace membership currently resolves JavaScript package.json workspaces and pnpm YAML; other ecosystem manifests are identified, not fully resolved into dependency graphs. No inspected JavaScript, Gradle, Python, executable config or install script is executed. Inspection is a best-effort snapshot, not a sandbox against concurrent hostile filesystem edits. Returned directories and files are sorted relative POSIX paths from the pruned scan. The directory inventory includes empty directories and omits the inspection root itself. The result reports incompleteness; it never grants permission to run an update. On a complete scan output is sorted; when a budget is exhausted the retained subset depends on filesystem enumeration order. Inspect a stable checkout for reproducible results. Install with npm install @ankhorage/project-detector; the standalone command is npx --package @ankhorage/project-detector project-detector inspect .. With Ankh installed, use ankh project-detector inspect .. CLI exit codes are 0 for a complete scan, 1 for invocation/root errors and 2 for partial scans. Release automation requires the organization release App configuration and npm publishing authorization for this new package; repository files alone do not provision these credentials.

Module: src/features/inspection/composition/inspectProjectAsync.ts Source: src/features/inspection/composition/inspectProjectAsync.ts:30:1 Related symbols: ProjectInspection, ProjectInspectionOptions