octocode-cli 1.5.0 → 1.5.3

package/skills/octocode-research/src/__tests__/unit/schemas.test.ts

@@ -1,14 +1,3 @@
-/**
- * Unit tests for HTTP-compatible Zod schemas.
- *
- * Tests the composed schemas in validation/schemas.ts:
- * - Preprocessing transforms (string → number/boolean/array)
- * - Alias mappings (context → contextLines, maxResults → limit)
- * - Research defaults injection (id, mainResearchGoal, etc.)
- * - Required field validation
- * - Refinement checks
- */
-
 import { describe, it, expect } from 'vitest';
 import {
   localSearchSchema,
@@ -26,9 +15,6 @@ import {
   packageSearchSchema,
 } from '../../validation/schemas.js';
 
-// =============================================================================
-// Local Schemas
-// =============================================================================
 
 describe('localSearchSchema', () => {
   it('parses minimal valid input', () => {
@@ -253,9 +239,6 @@ describe('localStructureSchema', () => {
   });
 });
 
-// =============================================================================
-// LSP Schemas
-// =============================================================================
 
 describe('lspDefinitionSchema', () => {
   it('parses valid input with string numbers', () => {
@@ -267,8 +250,8 @@ describe('lspDefinitionSchema', () => {
     expect(result.success).toBe(true);
     if (result.success) {
       expect(result.data.lineHint).toBe(42);
-      expect(result.data.contextLines).toBe(5); // default
-      expect(result.data.orderHint).toBe(0); // default
+      expect(result.data.contextLines).toBe(5);
+      expect(result.data.orderHint).toBe(0);
     }
   });
 
@@ -369,9 +352,6 @@ describe('lspCallsSchema', () => {
   });
 });
 
-// =============================================================================
-// GitHub Schemas
-// =============================================================================
 
 describe('githubSearchSchema', () => {
   it('parses comma-separated keywords', () => {
@@ -469,9 +449,6 @@ describe('githubPRsSchema', () => {
   });
 });
 
-// =============================================================================
-// Package Schema
-// =============================================================================
 
 describe('packageSearchSchema', () => {
   it('parses minimal input with defaults', () => {

package/skills/octocode-research/src/index.ts

@@ -1,15 +1,3 @@
-/**
- * Octocode Research Skill
- *
- * Re-exports octocode tools with skill-friendly names.
- * Only exports symbols that are actually consumed within this package.
- *
- * For types or additional utilities, import directly from 'octocode-mcp/public'.
- */
-
-// ============================================================================
-// GitHub Tools (Remote Repository Research)
-// ============================================================================
 
 export {
   fetchMultipleGitHubFileContents as githubGetFileContent,
@@ -19,9 +7,6 @@ export {
   exploreMultipleRepositoryStructures as githubViewRepoStructure,
 } from 'octocode-mcp/public';
 
-// ============================================================================
-// Local Tools (Local Codebase Research)
-// ============================================================================
 
 export {
   executeFetchContent as localGetFileContent,
@@ -30,9 +15,6 @@ export {
   executeViewStructure as localViewStructure,
 } from 'octocode-mcp/public';
 
-// ============================================================================
-// LSP Tools (Semantic Code Analysis)
-// ============================================================================
 
 export {
   executeGotoDefinition as lspGotoDefinition,
@@ -40,21 +22,12 @@ export {
   executeCallHierarchy as lspCallHierarchy,
 } from 'octocode-mcp/public';
 
-// ============================================================================
-// Package Search Tools
-// ============================================================================
 
 export { searchPackages as packageSearch } from 'octocode-mcp/public';
 
-// ============================================================================
-// Token Management (for GitHub API authentication)
-// ============================================================================
 
 export { initializeProviders } from 'octocode-mcp/public';
 
-// ============================================================================
-// Session Management (for tracking usage and telemetry)
-// ============================================================================
 
 export {
   initializeSession,

package/skills/octocode-research/src/mcpCache.ts

@@ -1,20 +1,10 @@
-/**
- * MCP Content Cache Module
- *
- * Loads mcpContent ONCE at server startup and provides cached access.
- * Routes should use getMcpContent() instead of calling loadToolContent() on each request.
- */
-
 import type { CompleteMetadata } from 'octocode-mcp/public';
 import { initialize, loadToolContent } from 'octocode-mcp/public';
 
 let mcpContent: CompleteMetadata | null = null;
 let initPromise: Promise<CompleteMetadata> | null = null;
 
-/**
- * Initialize mcpContent - call ONCE at server startup
- * Safe to call multiple times (idempotent)
- */
+
 export async function initializeMcpContent(): Promise<CompleteMetadata> {
   if (mcpContent) return mcpContent;
 
@@ -30,10 +20,7 @@ export async function initializeMcpContent(): Promise<CompleteMetadata> {
   return initPromise;
 }
 
-/**
- * Get cached mcpContent - use in routes
- * Throws if not initialized (indicates server startup failed)
- */
+
 export function getMcpContent(): CompleteMetadata {
   if (!mcpContent) {
     throw new Error('mcpContent not initialized. Call initializeMcpContent() at server startup.');
@@ -41,9 +28,7 @@ export function getMcpContent(): CompleteMetadata {
   return mcpContent;
 }
 
-/**
- * Check if mcpContent is initialized (for health checks)
- */
+
 export function isMcpInitialized(): boolean {
   return mcpContent !== null;
 }

package/skills/octocode-research/src/middleware/errorHandler.ts

@@ -1,5 +1,5 @@
 import type { Request, Response, NextFunction } from 'express';
-import type { z } from 'zod/v4';
+import type { z } from 'zod';
 import { logError, logWarn, sanitizeQueryParams } from '../utils/logger.js';
 import { logSessionError } from '../index.js';
 import { fireAndForgetWithTimeout } from '../utils/asyncTimeout.js';
@@ -21,7 +21,6 @@ export function errorHandler(
   const statusCode = error.statusCode ?? 500;
   const isValidationError = statusCode === 400;
 
-  // Log with appropriate level - now persisted to ~/.octocode/logs/errors.log
   if (isValidationError) {
     logWarn(`[VALIDATION] ${req.method} ${req.path}: ${error.message}`, {
       path: req.path,
@@ -32,7 +31,6 @@ export function errorHandler(
     logError(`[SERVER] ${req.method} ${req.path}: ${error.message}`, error);
   }
 
-  // Log error to session telemetry
   const toolName = extractToolName(req.path);
   const errorCode = error.code ?? (isValidationError ? 'VALIDATION_ERROR' : 'INTERNAL_ERROR');
   fireAndForgetWithTimeout(
@@ -56,7 +54,6 @@ export function errorHandler(
     },
   };
 
-  // Include validation details for 400 errors
   if (isValidationError && error.details) {
     response.error.details = error.details;
   }

package/skills/octocode-research/src/middleware/logger.ts

@@ -4,10 +4,7 @@ import { logToolCall, sanitizeQueryParams } from '../utils/logger.js';
 import { resultLog, errorLog } from '../utils/colors.js';
 import { extractToolName } from '../utils/url.js';
 
-/**
- * Generate or retrieve request ID for log correlation.
- * Uses X-Request-ID header if provided, otherwise generates a new UUID.
- */
+
 function getRequestId(req: Request): string {
   const existingId = req.headers['x-request-id'];
   if (typeof existingId === 'string' && existingId.length > 0) {
@@ -24,7 +21,6 @@ export function requestLogger(
   const start = Date.now();
   const requestId = getRequestId(req);
 
-  // Set request ID on response header for correlation
   res.setHeader('x-request-id', requestId);
 
   res.on('finish', () => {
@@ -33,7 +29,6 @@ export function requestLogger(
     const statusIcon = status >= 400 ? '❌' : '✅';
     const success = status < 400;
 
-    // Results output in BLUE for success, RED for error
     const resultMessage = `${statusIcon} ${req.method} ${req.path} ${status} ${duration}ms`;
 
     if (success) {

package/skills/octocode-research/src/middleware/queryParser.ts

@@ -1,9 +1,6 @@
-import { z } from 'zod/v4';
+import { z } from 'zod';
+
 
-/**
- * Custom error class for validation failures.
- * Carries HTTP status code for proper error responses.
- */
 class ValidationError extends Error {
   statusCode: number;
   code: string;
@@ -18,25 +15,14 @@ class ValidationError extends Error {
   }
 }
 
-/**
- * Parse and validate query parameters using a Zod schema.
- * Returns the validated data wrapped in an array (for tool compatibility).
- *
- * @param query - Express request query object
- * @param schema - Zod schema for validation
- * @returns Array containing the validated query object
- * @throws ValidationError if validation fails
- */
 export function parseAndValidate<T>(
   query: Record<string, unknown>,
   schema: z.ZodType<T>
 ): T[] {
-  // Check for JSON-encoded queries array (batch mode)
   if (query.queries && typeof query.queries === 'string') {
     try {
       const parsed = JSON.parse(query.queries);
       if (Array.isArray(parsed)) {
-        // Validate each item in the array
         const validated = parsed.map((item, index) => {
           const result = schema.safeParse(item);
           if (!result.success) {
@@ -51,12 +37,9 @@ export function parseAndValidate<T>(
       }
     } catch (e) {
       if (e instanceof ValidationError) throw e;
-      // JSON.parse failed - fall through to single query mode silently
-      // (avoid logging untrusted input in production)
     }
   }
 
-  // Parse flat query params (single query mode)
   const cleanedQuery: Record<string, unknown> = {};
   for (const [key, value] of Object.entries(query)) {
     if (key !== 'queries') {
@@ -75,9 +58,7 @@ export function parseAndValidate<T>(
   return [result.data];
 }
 
-/**
- * Format Zod error into a human-readable string.
- */
+
 function formatZodError(error: z.ZodError): string {
   return error.issues
     .map((issue) => {

package/skills/octocode-research/src/routes/github.ts

@@ -1,9 +1,3 @@
-/**
- * GitHub routes using route factory pattern.
- * 
- * @module routes/github
- */
-
 import { Router } from 'express';
 import {
   githubSearchCode,
@@ -33,7 +27,6 @@ import { isObject, hasProperty, hasNumberProperty } from '../types/guards.js';
 
 export const githubRoutes = Router();
 
-// GET /githubSearchCode - Search code on GitHub
 githubRoutes.get(
   '/githubSearchCode',
   createRouteHandler({
@@ -68,7 +61,6 @@ githubRoutes.get(
   })
 );
 
-// GET /githubGetFileContent - Read file from GitHub
 githubRoutes.get(
   '/githubGetFileContent',
   createRouteHandler({
@@ -80,7 +72,6 @@ githubRoutes.get(
   })
 );
 
-// GET /githubSearchRepositories - Search repositories
 githubRoutes.get(
   '/githubSearchRepositories',
   createRouteHandler({
@@ -116,7 +107,6 @@ githubRoutes.get(
   })
 );
 
-// GET /githubViewRepoStructure - View repository structure
 githubRoutes.get(
   '/githubViewRepoStructure',
   createRouteHandler({
@@ -148,7 +138,6 @@ githubRoutes.get(
   })
 );
 
-// GET /githubSearchPullRequests - Search pull requests
 githubRoutes.get(
   '/githubSearchPullRequests',
   createRouteHandler({

package/skills/octocode-research/src/routes/local.ts

@@ -1,9 +1,3 @@
-/**
- * Local filesystem routes using route factory pattern.
- * 
- * @module routes/local
- */
-
 import { Router } from 'express';
 import {
   localSearchCode,
@@ -32,7 +26,6 @@ import { isObject, hasNumberProperty } from '../types/guards.js';
 
 export const localRoutes = Router();
 
-// GET /localSearchCode - Search code with ripgrep
 localRoutes.get(
   '/localSearchCode',
   createRouteHandler({
@@ -67,7 +60,6 @@ localRoutes.get(
   })
 );
 
-// GET /localGetFileContent - Read file contents
 localRoutes.get(
   '/localGetFileContent',
   createRouteHandler({
@@ -79,7 +71,6 @@ localRoutes.get(
   })
 );
 
-// GET /localFindFiles - Find files by metadata
 localRoutes.get(
   '/localFindFiles',
   createRouteHandler({
@@ -111,7 +102,6 @@ localRoutes.get(
   })
 );
 
-// GET /localViewStructure - View directory structure
 localRoutes.get(
   '/localViewStructure',
   createRouteHandler({
@@ -125,7 +115,6 @@ localRoutes.get(
       const files: string[] = [];
       const folders: string[] = [];
 
-      // Extract files and folders from output
       const lines = structuredOutput.split('\n');
       for (const line of lines) {
         if (line.includes('[FILE]')) {
@@ -150,7 +139,6 @@ localRoutes.get(
   })
 );
 
-// Helper: Format file size
 function formatSize(bytes: number): string {
   if (bytes < 1024) return `${bytes}B`;
   if (bytes < 1024 * 1024) return `${(bytes / 1024).toFixed(1)}KB`;

package/skills/octocode-research/src/routes/lsp.ts

@@ -1,9 +1,3 @@
-/**
- * LSP routes using route factory pattern.
- * 
- * @module routes/lsp
- */
-
 import { Router } from 'express';
 import {
   lspGotoDefinition,
@@ -23,7 +17,6 @@ import { isObject, hasProperty, hasNumberProperty, hasStringProperty } from '../
 
 export const lspRoutes = Router();
 
-// GET /lspGotoDefinition - Go to symbol definition
 lspRoutes.get(
   '/lspGotoDefinition',
   createRouteHandler({
@@ -46,7 +39,6 @@ lspRoutes.get(
   })
 );
 
-// GET /lspFindReferences - Find all references to a symbol
 lspRoutes.get(
   '/lspFindReferences',
   createRouteHandler({
@@ -69,7 +61,6 @@ lspRoutes.get(
   })
 );
 
-// GET /lspCallHierarchy - Get call hierarchy (incoming/outgoing)
 lspRoutes.get(
   '/lspCallHierarchy',
   createRouteHandler({
@@ -164,7 +155,7 @@ function extractCallHierarchyLocations(
     const item = isObject(call.from) ? call.from : isObject(call.to) ? call.to : call;
     const itemObj = isObject(item) ? item as Record<string, unknown> : {};
 
-    const lineFromRange = extractStartLine(itemObj) - 1; // undo +1 from extractStartLine
+    const lineFromRange = extractStartLine(itemObj) - 1;
     const lineFromItem = hasNumberProperty(itemObj, 'line') ? itemObj.line : 0;
 
     return {

package/skills/octocode-research/src/routes/package.ts

@@ -11,7 +11,6 @@ import { isObject, hasProperty, hasStringProperty } from '../types/guards.js';
 
 export const packageRoutes = Router();
 
-// GET /packageSearch - Search npm/pypi packages
 packageRoutes.get(
   '/packageSearch',
   async (req: Request, res: Response, next: NextFunction) => {
@@ -27,7 +26,6 @@ packageRoutes.get(
       );
       const { data, isError, hints, research } = parseToolResponse(rawResult);
 
-      // Extract packages from result
       const packages = extractPackages(data);
       const query = queries[0] as Record<string, unknown>;
       const registry = query.ecosystem === 'python' ? 'pypi' : 'npm';

package/skills/octocode-research/src/routes/prompts.ts

@@ -6,7 +6,6 @@ import { checkReadiness } from '../middleware/readiness.js';
 
 export const promptsRoutes = Router();
 
-// Apply readiness check middleware to all prompts routes
 promptsRoutes.use(checkReadiness);
 
 declare const __PACKAGE_VERSION__: string;
@@ -24,28 +23,6 @@ interface PromptInfo {
   arguments?: PromptArg[];
 }
 
-/**
- * GET /prompts/list - List all prompts (MCP-compatible format)
- * 
- * Returns prompt names, descriptions, and arguments following MCP protocol.
- * 
- * @example
- * GET /prompts/list
- * 
- * Response:
- * {
- *   "prompts": [
- *     {
- *       "name": "research",
- *       "description": "Start a code research session",
- *       "arguments": [
- *         { "name": "goal", "description": "The research goal", "required": true }
- *       ]
- *     }
- *   ],
- *   "_meta": { "totalCount": 5, "version": "2.2.0" }
- * }
- */
 promptsRoutes.get('/list', async (
   _req: Request,
   res: Response,
@@ -54,10 +31,8 @@ promptsRoutes.get('/list', async (
   try {
     const content = getMcpContent();
     
-    // Use Object.entries to get both key and prompt
-    // The key is what's used for lookup in /prompts/info/:promptName
     const prompts: PromptInfo[] = Object.entries(content.prompts).map(([key, prompt]) => ({
-      name: key, // Use the key (lookup name), not prompt.name (display name may differ)
+      name: key,
       description: prompt.description,
       arguments: prompt.args?.map(arg => ({
         name: arg.name,
@@ -80,11 +55,7 @@ promptsRoutes.get('/list', async (
   }
 });
 
-/**
- * GET /prompts/info/:promptName - Get specific prompt details
- * 
- * Returns detailed information about a specific prompt.
- */
+
 promptsRoutes.get('/info/:promptName', async (
   req: Request,
   res: Response,
@@ -111,7 +82,6 @@ promptsRoutes.get('/info/:promptName', async (
       return;
     }
 
-    // Log prompt call for session telemetry
     fireAndForgetWithTimeout(
       () => logPromptCall(promptName),
       5000,