typescript

TypeScript Rules for Code-Index-MCP

Overview

This file defines TypeScript/JavaScript coding standards and patterns for any web UI or Node.js components that may be added to the Code-Index-MCP project.

Type Safety

Strict Type Checking

// tsconfig.json
{
  "compilerOptions": {
    "strict": true,
    "noImplicitAny": true,
    "strictNullChecks": true,
    "strictFunctionTypes": true,
    "noUnusedLocals": true,
    "noUnusedParameters": true,
    "noImplicitReturns": true,
    "noFallthroughCasesInSwitch": true
  }
}

Type Definitions

// Define interfaces for API responses
interface SymbolDefinition {
  name: string;
  type: 'function' | 'class' | 'variable' | 'method';
  filePath: string;
  line: number;
  column: number;
  docstring?: string;
}

interface SearchResult {
  matches: Array<{
    file: string;
    line: number;
    content: string;
    score: number;
  }>;
  totalCount: number;
}

// Use discriminated unions for different response types
type APIResponse<T> = 
  | { status: 'success'; data: T }
  | { status: 'error'; error: string }
  | { status: 'loading' };

API Client Design

Type-Safe API Client

class MCPClient {
  private baseUrl: string;
  private apiKey: string;

  constructor(baseUrl: string, apiKey: string) {
    this.baseUrl = baseUrl;
    this.apiKey = apiKey;
  }

  private async request<T>(
    endpoint: string,
    options: RequestInit = {}
  ): Promise<T> {
    const response = await fetch(`${this.baseUrl}${endpoint}`, {
      ...options,
      headers: {
        'Content-Type': 'application/json',
        'X-API-Key': this.apiKey,
        ...options.headers,
      },
    });

    if (!response.ok) {
      throw new Error(`API Error: ${response.statusText}`);
    }

    return response.json();
  }

  async getSymbolDefinition(
    symbolName: string,
    filePath?: string
  ): Promise<SymbolDefinition> {
    return this.request<SymbolDefinition>('/symbol', {
      method: 'POST',
      body: JSON.stringify({ symbol_name: symbolName, file_path: filePath }),
    });
  }

  async searchCode(
    query: string,
    fileExtensions?: string[]
  ): Promise<SearchResult> {
    return this.request<SearchResult>('/search', {
      method: 'POST',
      body: JSON.stringify({ query, file_extensions: fileExtensions }),
    });
  }
}