@vibecheckai/cli 3.8.0 → 3.9.0

package/bin/runners/lib/engine/types.js

@@ -1,124 +1,124 @@
-// bin/runners/lib/engine/types.js
-// JSDoc type definitions for the engine
-
-/**
- * @typedef {Object} FileRecord
- * @property {string} abs - Absolute path
- * @property {string} rel - Relative path from repo root (forward slashes)
- * @property {number} size - File size in bytes
- * @property {number} mtime - Last modified time (ms since epoch)
- * @property {string} hash - Content hash (sha256)
- * @property {string} [ext] - File extension (e.g., ".ts", ".js")
- */
-
-/**
- * @typedef {Object} RepoSignals
- * @property {boolean} hasPackageJson
- * @property {boolean} hasRequirementsTxt
- * @property {boolean} hasPyprojectToml
- * @property {boolean} hasGoMod
- * @property {boolean} hasGemfile
- * @property {boolean} hasNextApp - has app/ directory
- * @property {boolean} hasNextPages - has pages/ directory
- * @property {boolean} hasOpenAPI
- * @property {boolean} hasGraphQL
- * @property {Set<string>} detectedFrameworks
- */
-
-/**
- * @typedef {Object} RepoIndexResult
- * @property {FileRecord[]} files - All indexed files
- * @property {RepoSignals} signals - Detected signals
- * @property {Map<string, string>} contentCache - abs -> content
- * @property {Map<string, Set<string>>} tokenIndex - token -> Set<abs>
- * @property {Object} stats
- * @property {number} stats.totalFiles
- * @property {number} stats.totalSize
- * @property {number} stats.indexTimeMs
- */
-
-/**
- * @typedef {Object} Evidence
- * @property {string} id - Unique evidence ID (ev_xxxx)
- * @property {string} file - Relative file path
- * @property {string} lines - Line range (e.g., "10-15")
- * @property {string} snippetHash - SHA256 of snippet
- * @property {string} reason - Why this is evidence
- */
-
-/**
- * @typedef {Object} RouteFact
- * @property {string} method - HTTP method (GET, POST, *, etc.)
- * @property {string} path - Canonicalized route path
- * @property {string} handler - Relative file path
- * @property {string} framework - Source framework
- * @property {"high"|"med"|"low"} confidence
- * @property {Evidence[]} evidence
- * @property {string[]} [hooks] - Fastify hooks if present
- */
-
-/**
- * @typedef {Object} ClientRefFact
- * @property {string} method - HTTP method or "*"
- * @property {string} path - Canonicalized path
- * @property {string} source - Relative file path
- * @property {"high"|"med"|"low"} confidence
- * @property {string} kind - fetch, axios_member, axios_config, useSWR, useQuery
- * @property {Evidence[]} evidence
- */
-
-/**
- * @typedef {Object} EnvFact
- * @property {string} name - Environment variable name
- * @property {string[]} files - Files where it's referenced
- * @property {boolean} hasDefault - Whether a default value exists
- * @property {string} [defaultValue] - Default value if any
- */
-
-/**
- * @typedef {Object} Gap
- * @property {string} kind - Gap type (e.g., "fastify_plugin_unresolved")
- * @property {string} [file] - Related file
- * @property {string} [spec] - Module specifier
- * @property {string} [name] - Identifier name
- * @property {string} [note] - Additional notes
- * @property {string} [error] - Error message if from catch
- */
-
-/**
- * @typedef {Object} AdapterResult
- * @property {RouteFact[]} routes
- * @property {ClientRefFact[]} clientRefs
- * @property {Gap[]} gaps
- * @property {Object} stats
- * @property {number} stats.filesScanned
- * @property {number} stats.parseErrors
- * @property {number} [quality] - 0-1 extraction quality score
- */
-
-/**
- * @typedef {Object} Finding
- * @property {string} id - Stable finding ID
- * @property {string} title
- * @property {string} description
- * @property {"info"|"warn"|"block"} severity
- * @property {"high"|"med"|"low"} confidence
- * @property {Evidence[]} evidence
- * @property {Gap[]} [gaps]
- * @property {string} [suggestedFix]
- * @property {string} [category]
- */
-
-/**
- * @typedef {Object} ScanResult
- * @property {Finding[]} findings
- * @property {Object} truthpack
- * @property {Object} stats
- * @property {number} stats.scanTimeMs
- * @property {number} stats.filesIndexed
- * @property {number} stats.routesFound
- * @property {number} stats.clientRefsFound
- * @property {number} stats.gapsFound
- */
-
-module.exports = {};
+// bin/runners/lib/engine/types.js
+// JSDoc type definitions for the engine
+
+/**
+ * @typedef {Object} FileRecord
+ * @property {string} abs - Absolute path
+ * @property {string} rel - Relative path from repo root (forward slashes)
+ * @property {number} size - File size in bytes
+ * @property {number} mtime - Last modified time (ms since epoch)
+ * @property {string} hash - Content hash (sha256)
+ * @property {string} [ext] - File extension (e.g., ".ts", ".js")
+ */
+
+/**
+ * @typedef {Object} RepoSignals
+ * @property {boolean} hasPackageJson
+ * @property {boolean} hasRequirementsTxt
+ * @property {boolean} hasPyprojectToml
+ * @property {boolean} hasGoMod
+ * @property {boolean} hasGemfile
+ * @property {boolean} hasNextApp - has app/ directory
+ * @property {boolean} hasNextPages - has pages/ directory
+ * @property {boolean} hasOpenAPI
+ * @property {boolean} hasGraphQL
+ * @property {Set<string>} detectedFrameworks
+ */
+
+/**
+ * @typedef {Object} RepoIndexResult
+ * @property {FileRecord[]} files - All indexed files
+ * @property {RepoSignals} signals - Detected signals
+ * @property {Map<string, string>} contentCache - abs -> content
+ * @property {Map<string, Set<string>>} tokenIndex - token -> Set<abs>
+ * @property {Object} stats
+ * @property {number} stats.totalFiles
+ * @property {number} stats.totalSize
+ * @property {number} stats.indexTimeMs
+ */
+
+/**
+ * @typedef {Object} Evidence
+ * @property {string} id - Unique evidence ID (ev_xxxx)
+ * @property {string} file - Relative file path
+ * @property {string} lines - Line range (e.g., "10-15")
+ * @property {string} snippetHash - SHA256 of snippet
+ * @property {string} reason - Why this is evidence
+ */
+
+/**
+ * @typedef {Object} RouteFact
+ * @property {string} method - HTTP method (GET, POST, *, etc.)
+ * @property {string} path - Canonicalized route path
+ * @property {string} handler - Relative file path
+ * @property {string} framework - Source framework
+ * @property {"high"|"med"|"low"} confidence
+ * @property {Evidence[]} evidence
+ * @property {string[]} [hooks] - Fastify hooks if present
+ */
+
+/**
+ * @typedef {Object} ClientRefFact
+ * @property {string} method - HTTP method or "*"
+ * @property {string} path - Canonicalized path
+ * @property {string} source - Relative file path
+ * @property {"high"|"med"|"low"} confidence
+ * @property {string} kind - fetch, axios_member, axios_config, useSWR, useQuery
+ * @property {Evidence[]} evidence
+ */
+
+/**
+ * @typedef {Object} EnvFact
+ * @property {string} name - Environment variable name
+ * @property {string[]} files - Files where it's referenced
+ * @property {boolean} hasDefault - Whether a default value exists
+ * @property {string} [defaultValue] - Default value if any
+ */
+
+/**
+ * @typedef {Object} Gap
+ * @property {string} kind - Gap type (e.g., "fastify_plugin_unresolved")
+ * @property {string} [file] - Related file
+ * @property {string} [spec] - Module specifier
+ * @property {string} [name] - Identifier name
+ * @property {string} [note] - Additional notes
+ * @property {string} [error] - Error message if from catch
+ */
+
+/**
+ * @typedef {Object} AdapterResult
+ * @property {RouteFact[]} routes
+ * @property {ClientRefFact[]} clientRefs
+ * @property {Gap[]} gaps
+ * @property {Object} stats
+ * @property {number} stats.filesScanned
+ * @property {number} stats.parseErrors
+ * @property {number} [quality] - 0-1 extraction quality score
+ */
+
+/**
+ * @typedef {Object} Finding
+ * @property {string} id - Stable finding ID
+ * @property {string} title
+ * @property {string} description
+ * @property {"info"|"warn"|"block"} severity
+ * @property {"high"|"med"|"low"} confidence
+ * @property {Evidence[]} evidence
+ * @property {Gap[]} [gaps]
+ * @property {string} [suggestedFix]
+ * @property {string} [category]
+ */
+
+/**
+ * @typedef {Object} ScanResult
+ * @property {Finding[]} findings
+ * @property {Object} truthpack
+ * @property {Object} stats
+ * @property {number} stats.scanTimeMs
+ * @property {number} stats.filesIndexed
+ * @property {number} stats.routesFound
+ * @property {number} stats.clientRefsFound
+ * @property {number} stats.gapsFound
+ */
+
+module.exports = {};