@vyuhlabs/dxkit 1.5.1 → 1.6.0

package/dist/analyzers/tools/tool-registry.d.ts

@@ -0,0 +1,86 @@
+import { DetectedStack, ToolRequirement } from '../../types';
+export interface ToolDefinition extends ToolRequirement {
+    /** Binary name(s) to look for in PATH. First match wins. */
+    binaries: string[];
+    /** Extra absolute paths to probe (e.g. venv, system locations). */
+    probePaths?: string[];
+    /**
+     * For tools that are node packages without a CLI binary (e.g. vitest
+     * plugins). When set, detection checks for `node_modules/<pkg>/package.json`
+     * instead of scanning PATH / .bin. Takes precedence over binary search.
+     */
+    nodePackage?: string;
+    /** Platform-specific install commands. */
+    installCommands: {
+        macos?: string;
+        linux?: string;
+        windows?: string;
+    };
+    /** Command that prints version info (used to verify tool works). */
+    versionCheck?: string;
+}
+export interface ToolStatus {
+    name: string;
+    available: boolean;
+    path: string | null;
+    version: string | null;
+    source: 'path' | 'brew' | 'npm-g' | 'pipx' | 'cargo' | 'go' | 'probe' | 'missing';
+    requirement: ToolDefinition;
+}
+/**
+ * Find a tool across multiple installation methods.
+ * Returns the first matching absolute path, or null.
+ */
+export declare function findTool(def: ToolDefinition, cwd?: string): ToolStatus;
+/** Get the install command for the current platform. */
+export declare function getInstallCommand(def: ToolDefinition): string;
+export declare const TOOL_DEFS: Record<string, ToolDefinition>;
+/**
+ * Build the list of tools required for a given detected stack.
+ * This is the single source of truth for detect.ts's `requiredTools` field.
+ */
+export declare function buildRequiredTools(languages: DetectedStack['languages']): ToolRequirement[];
+/** Get full ToolDefinition by name. */
+export declare function getToolDef(name: string): ToolDefinition | undefined;
+/**
+ * Map detected languages to the corresponding semgrep ruleset IDs.
+ *
+ * Semgrep ruleset naming follows `p/<language-or-pack>`. Not every language
+ * has a ruleset (e.g., `p/go` does NOT exist; the gosec rules live under
+ * `p/gosec`). This function encodes those mappings so callers never hardcode.
+ *
+ * Adding a new language:
+ * 1. Add it to detect.ts `DetectedStack.languages`
+ * 2. Add a case here if semgrep has a ruleset for it
+ *
+ * @see https://semgrep.dev/explore for the full ruleset registry
+ */
+export declare function getSemgrepRulesets(languages: DetectedStack['languages']): string[];
+/**
+ * Run a registered tool and return its stdout.
+ *
+ * ENFORCEMENT: This is the ONLY sanctioned way to execute an external tool
+ * in analyzer code. It verifies the tool exists in TOOL_DEFS before running.
+ * If you need to run a tool that's not registered, add it to TOOL_DEFS first.
+ *
+ * Builtins (grep, find, wc, git, node) don't go through this — they're
+ * always available and don't need detection/install. Only tools that:
+ * - Need to be discovered (multi-path detection)
+ * - Need to be installed by `vyuh-dxkit tools install`
+ * - Appear in `vyuh-dxkit tools list`
+ * must be registered and invoked via this function or findTool().
+ *
+ * @param toolName — must match a key in TOOL_DEFS
+ * @param buildCmd — function that receives the resolved binary path and returns the shell command
+ * @param cwd — working directory
+ * @param timeoutMs — command timeout
+ * @returns stdout string, or null if tool unavailable
+ */
+export declare function runRegisteredTool(toolName: string, buildCmd: (binPath: string) => string, cwd: string, timeoutMs?: number): {
+    output: string | null;
+    available: boolean;
+    path: string | null;
+};
+/** Check status of all required tools for a stack. */
+export declare function checkAllTools(languages: DetectedStack['languages'], cwd?: string): ToolStatus[];
+//# sourceMappingURL=tool-registry.d.ts.map

package/dist/analyzers/tools/tool-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-registry.d.ts","sourceRoot":"","sources":["../../../src/analyzers/tools/tool-registry.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE7D,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,4DAA4D;IAC5D,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,mEAAmE;IACnE,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,0CAA0C;IAC1C,eAAe,EAAE;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,oEAAoE;IACpE,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,OAAO,CAAC;IACnB,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,GAAG,OAAO,GAAG,SAAS,CAAC;IAClF,WAAW,EAAE,cAAc,CAAC;CAC7B;AAoHD;;;GAGG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,cAAc,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,CAgFtE;AAkBD,wDAAwD;AACxD,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,cAAc,GAAG,MAAM,CAO7D;AAMD,eAAO,MAAM,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,cAAc,CA2RpD,CAAC;AAMF;;;GAGG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,eAAe,EAAE,CA0C3F;AAED,uCAAuC;AACvC,wBAAgB,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAEnE;AAED;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,GAAG,MAAM,EAAE,CAyBlF;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,iBAAiB,CAC/B,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,MAAM,EACrC,GAAG,EAAE,MAAM,EACX,SAAS,SAAQ,GAChB;IAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,SAAS,EAAE,OAAO,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAsBpE;AAED,sDAAsD;AACtD,wBAAgB,aAAa,CAAC,SAAS,EAAE,aAAa,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,UAAU,EAAE,CAgB/F"}