codereview-aia 0.1.3 → 0.1.4

package/src/types/review.ts

@@ -1,312 +0,0 @@
-/**
- * Review type definitions for cr-aia.
- *
- * The fork keeps only the options we rely on while trimming unrelated commentary.
- */
-
-import type { CostInfo } from '../clients/utils/tokenCounter';
-import type { OutputFormat } from './common';
-
-// Re-export CostInfo for convenience
-export type { CostInfo } from '../clients/utils/tokenCounter';
-
-/**
- * Types of code reviews that can be performed
- */
-export type ReviewType =
-  | 'quick-fixes'
-  | 'architectural'
-  | 'security'
-  | 'performance'
-  | 'unused-code'
-  | 'focused-unused-code'
-  | 'code-tracing-unused-code'
-  | 'consolidated'
-  | 'best-practices'
-  | 'evaluation'
-  | 'extract-patterns'
-  | 'coding-test'
-  | 'ai-integration'
-  | 'cloud-native'
-  | 'developer-experience'
-  | 'comprehensive';
-
-/**
- * Options for code reviews
- */
-export interface ReviewOptions {
-  /** Type of review to perform */
-  type: ReviewType;
-  /** Output format */
-  output?: OutputFormat | 'none';
-  /** Directory to save review output */
-  outputDir?: string;
-  /** Model to use for the review */
-  model?: string;
-  /** Model to use for consolidating multi-pass reviews (defaults to main model) */
-  writerModel?: string;
-  /** Whether to include test files in the review */
-  includeTests?: boolean;
-  /** Whether to include project documentation in the review context */
-  includeProjectDocs?: boolean;
-  /** Whether to include dependency analysis in the review */
-  includeDependencyAnalysis?: boolean;
-  /** Whether to run in interactive mode */
-  interactive?: boolean;
-  /** Whether to test API connections before running the review */
-  testApi?: boolean;
-  /** Whether to estimate token usage and cost without performing the review */
-  estimate?: boolean;
-  /** Whether to use multi-pass review for large codebases */
-  multiPass?: boolean;
-  /** Whether to force single-pass review even if token analysis suggests multiple passes are needed */
-  forceSinglePass?: boolean;
-  /** Context maintenance factor for multi-pass reviews (0-1) */
-  contextMaintenanceFactor?: number;
-  /** Whether to skip confirmation prompts */
-  noConfirm?: boolean;
-  /** Whether to enable debug logging */
-  debug?: boolean;
-  /** Programming language of the code being reviewed */
-  language?: string;
-  /** Framework used in the code being reviewed */
-  framework?: string;
-  /** CI/CD data (TypeScript errors, lint errors) - internal use only */
-  ciData?: any;
-  /** Path to a custom prompt file */
-  promptFile?: string;
-  /** Prompt fragments to inject into the review */
-  promptFragments?: Array<{
-    content: string;
-    position: 'start' | 'middle' | 'end';
-    priority?: number;
-  }>;
-  /** Prompt strategy to use */
-  promptStrategy?: string;
-  /** Whether to use cache for prompts */
-  useCache?: boolean;
-  /** Whether to automatically fix issues */
-  autoFix?: boolean;
-  /** Whether to use ts-prune for unused code detection */
-  useTsPrune?: boolean;
-  /** Whether to use ESLint for code analysis */
-  useEslint?: boolean;
-  /** Whether to trace code execution */
-  traceCode?: boolean;
-  /** UI language for output messages */
-  uiLanguage?: string;
-  /** Target file or directory (used internally) */
-  target?: string;
-  /** Explicit list of files to review (bypasses discovery) */
-  targetFileList?: string[];
-  /** Runtime context information for prompt enrichment */
-  runContext?: RunContext;
-  /** Schema instructions for structured output */
-  schemaInstructions?: string;
-  /** Examples for prompts */
-  examples?: any[];
-  /** Whether to prompt for all issues */
-  promptAll?: boolean;
-  /** Whether to skip specific file content */
-  skipFileContent?: boolean;
-  /** Whether this is a consolidation pass */
-  isConsolidation?: boolean;
-  /** Project name */
-  projectName?: string;
-  /** Strategy override */
-  strategy?: string;
-  /** Whether to suppress output */
-  quiet?: boolean;
-  /** Whether to focus on specific aspects */
-  focused?: boolean;
-  /** Whether to use consolidated review */
-  consolidated?: boolean;
-  /** Whether to generate Mermaid architecture diagrams */
-  diagram?: boolean;
-  /** Force maximum tokens per batch (for testing consolidation) */
-  batchTokenLimit?: number;
-
-  // Coding test specific options
-  /** Path to assignment description file */
-  assignmentFile?: string;
-  /** URL to assignment description */
-  assignmentUrl?: string;
-  /** Inline assignment description */
-  assignmentText?: string;
-  /** Path to custom evaluation template */
-  evaluationTemplate?: string;
-  /** URL to evaluation template */
-  templateUrl?: string;
-  /** Path to scoring rubric file */
-  rubricFile?: string;
-  /** Type of assessment */
-  assessmentType?: 'coding-challenge' | 'take-home' | 'live-coding' | 'code-review';
-  /** Difficulty level */
-  difficultyLevel?: 'junior' | 'mid' | 'senior' | 'lead' | 'architect';
-  /** Expected completion time in minutes */
-  timeLimit?: number;
-
-  // Evaluation criteria weights
-  /** Weight for correctness evaluation (0-100) */
-  weightCorrectness?: number;
-  /** Weight for code quality evaluation (0-100) */
-  weightCodeQuality?: number;
-  /** Weight for architecture evaluation (0-100) */
-  weightArchitecture?: number;
-  /** Weight for performance evaluation (0-100) */
-  weightPerformance?: number;
-  /** Weight for testing evaluation (0-100) */
-  weightTesting?: number;
-
-  // Evaluation flags
-  /** Include documentation assessment */
-  evaluateDocumentation?: boolean;
-  /** Include git commit history analysis */
-  evaluateGitHistory?: boolean;
-  /** Focus on edge case handling */
-  evaluateEdgeCases?: boolean;
-  /** Focus on error handling patterns */
-  evaluateErrorHandling?: boolean;
-
-  // Scoring configuration
-  /** Scoring system type */
-  scoringSystem?: 'numeric' | 'letter' | 'pass-fail' | 'custom';
-  /** Maximum possible score */
-  maxScore?: number;
-  /** Minimum passing score */
-  passingThreshold?: number;
-  /** Include detailed score breakdown */
-  scoreBreakdown?: boolean;
-
-  // Feedback options
-  /** Feedback detail level */
-  feedbackLevel?: 'basic' | 'detailed' | 'comprehensive';
-  /** Include code examples in feedback */
-  includeExamples?: boolean;
-  /** Include improvement suggestions */
-  includeSuggestions?: boolean;
-  /** Include learning resources */
-  includeResources?: boolean;
-
-  // Constraints
-  /** Comma-separated list of allowed libraries */
-  allowedLibraries?: string[];
-  /** Comma-separated list of forbidden patterns */
-  forbiddenPatterns?: string[];
-  /** Expected Node.js version */
-  nodeVersion?: string;
-  /** Expected TypeScript version */
-  typescriptVersion?: string;
-  /** Memory constraint in MB */
-  memoryLimit?: number;
-  /** Execution timeout in seconds */
-  executionTimeout?: number;
-
-  /** AI Detection options */
-  /** Enable AI-generated code detection */
-  enableAiDetection?: boolean;
-  /** AI detection confidence threshold (0.0-1.0) */
-  aiDetectionThreshold?: number;
-  /** Comma-separated list of analyzers to use */
-  aiDetectionAnalyzers?: string;
-  /** Include AI detection results in the review report */
-  aiDetectionIncludeInReport?: boolean;
-  /** Automatically fail evaluation if AI-generated code is detected */
-  aiDetectionFailOnDetection?: boolean;
-
-  /** Coding test configuration (internal use) */
-  codingTestConfig?: any;
-
-  /** Metadata about the review (internal use) */
-  metadata?: any;
-}
-
-/**
- * Information about a file to be reviewed
- */
-export interface FileInfo {
-  /** Path to the file */
-  path: string;
-  /** Relative path to the file from the project root */
-  relativePath?: string;
-  /** Content of the file */
-  content: string;
-  /** File extension */
-  extension?: string;
-}
-
-/**
- * Result of a code review
- */
-export interface ReviewResult {
-  /** Content of the review */
-  content: string;
-  /** Path to the file that was reviewed */
-  filePath: string;
-  /** Type of review that was performed */
-  reviewType: ReviewType;
-  /** Timestamp when the review was generated */
-  timestamp: string;
-  /** Cost information for the review */
-  cost?: CostInfo;
-  /** Cost information for the review (alias for cost) */
-  costInfo?: CostInfo;
-  /** Model used for the review */
-  modelUsed?: string;
-  /** Structured data from the review */
-  structuredData?: any;
-  /** Metadata about the review */
-  metadata?: any;
-  /** Tool version used for the review */
-  toolVersion?: string;
-  /** Command options used for the review */
-  commandOptions?: string;
-  /** Detected language of the code */
-  detectedLanguage?: string;
-  /** Detected framework of the code */
-  detectedFramework?: string;
-  /** Detected framework version */
-  frameworkVersion?: string;
-  /** Detected CSS frameworks */
-  cssFrameworks?: Array<{ name: string; version?: string }>;
-  /** Raw API response (for debugging) */
-  response?: string;
-  /** Output format of the review */
-  outputFormat?: OutputFormat;
-  /** Project name for the review */
-  projectName?: string;
-  /** Total number of passes in multi-pass review */
-  totalPasses?: number;
-  /** Files included in the review */
-  files?: FileInfo[];
-}
-
-export interface RunContext {
-  repoName: string;
-  reviewMode?: string;
-  totalFiles?: number;
-  groupIndex?: number;
-  groupCount?: number;
-  groupLabel?: string;
-  groupFiles?: string[];
-  docFiles?: string[];
-  uncommittedFiles?: number;
-  contextFiles?: number;
-  contextDocs?: Array<{ path: string; snippet: string }>;
-}
-
-/**
- * Cost information for a single pass in a multi-pass review
- */
-export interface PassCost {
-  /** Pass number */
-  passNumber: number;
-  /** Input tokens for this pass */
-  inputTokens: number;
-  /** Output tokens for this pass */
-  outputTokens: number;
-  /** Total tokens for this pass */
-  totalTokens: number;
-  /** Estimated cost for this pass */
-  estimatedCost: number;
-}

package/src/types/reviewContext.d.ts

@@ -1,65 +0,0 @@
-/**
- * Module augmentation that exposes the runtime ReviewContext class to TypeScript.
- */
-
-declare module '../analysis/context' {
-  export enum CodeElementType {
-    Function = 'function',
-    Class = 'class',
-    Interface = 'interface',
-    Variable = 'variable',
-    Import = 'import',
-    ExportedItem = 'exported',
-    Component = 'component',
-    EntryPoint = 'entryPoint',
-  }
-
-  export interface CodeElement {
-    type: CodeElementType;
-    name: string;
-    file: string;
-    signature?: string;
-    importance: number;
-  }
-
-  export interface ReviewFinding {
-    type: string;
-    description: string;
-    file?: string;
-    severity: number;
-    passNumber: number;
-  }
-
-  export interface FileSummary {
-    path: string;
-    type: string;
-    description: string;
-    keyElements: string[];
-    passNumber: number;
-  }
-
-  export class ReviewContext {
-    constructor(
-      projectName: string,
-      reviewType: string,
-      files: import('../types/review').FileInfo[],
-    );
-
-    startPass(): number;
-    getCurrentPass(): number;
-    addCodeElement(element: CodeElement): void;
-    getCodeElements(): CodeElement[];
-    getCodeElementsByType(type: CodeElementType): CodeElement[];
-    getCodeElementsInFile(filePath: string): CodeElement[];
-    addFinding(finding: ReviewFinding): void;
-    getFindings(): ReviewFinding[];
-    addFileSummary(summary: FileSummary): void;
-    getFileSummary(filePath: string): FileSummary | undefined;
-    getAllFileSummaries(): FileSummary[];
-    addGeneralNote(note: string): void;
-    getGeneralNotes(): string[];
-    generateNextPassContext(files: string[], maxContextLength?: number): string;
-    toJSON(): Record<string, unknown>;
-    static fromJSON(json: Record<string, unknown>): ReviewContext;
-  }
-}

package/src/types/structuredReview.ts

@@ -1,167 +0,0 @@
-/**
- * Type definitions for the structured review output that cr-aia emits.
- */
-
-/**
- * Priority levels for code review issues
- */
-export type IssuePriority = 'high' | 'medium' | 'low';
-
-/**
- * Types of code review issues
- */
-export type IssueType =
-  | 'bug'
-  | 'security'
-  | 'performance'
-  | 'maintainability'
-  | 'readability'
-  | 'architecture'
-  | 'best-practice'
-  | 'documentation'
-  | 'testing'
-  | 'other';
-
-/**
- * A single code review issue
- */
-export interface ReviewIssue {
-  /**
-   * Title of the issue
-   */
-  title: string;
-
-  /**
-   * Priority level of the issue
-   */
-  priority: IssuePriority;
-
-  /**
-   * Type of issue
-   */
-  type: IssueType;
-
-  /**
-   * File path where the issue was found
-   */
-  filePath: string;
-
-  /**
-   * Line number(s) where the issue was found
-   * Can be a single line number or a range (e.g., "10-15")
-   */
-  lineNumbers?: string;
-
-  /**
-   * Description of the issue
-   */
-  description: string;
-
-  /**
-   * Code snippet showing the issue
-   */
-  codeSnippet?: string;
-
-  /**
-   * Suggested fix for the issue
-   */
-  suggestedFix?: string;
-
-  /**
-   * Impact of the issue
-   */
-  impact?: string;
-}
-
-/**
- * Grade level types for overall code quality
- */
-export type GradeLevel =
-  | 'A+'
-  | 'A'
-  | 'A-'
-  | 'B+'
-  | 'B'
-  | 'B-'
-  | 'C+'
-  | 'C'
-  | 'C-'
-  | 'D+'
-  | 'D'
-  | 'D-'
-  | 'F';
-
-/**
- * Code quality assessment categories
- */
-export interface GradeCategories {
-  /**
-   * Code functionality grade
-   */
-  functionality?: GradeLevel;
-
-  /**
-   * Code quality grade
-   */
-  codeQuality?: GradeLevel;
-
-  /**
-   * Documentation grade
-   */
-  documentation?: GradeLevel;
-
-  /**
-   * Testing grade
-   */
-  testing?: GradeLevel;
-
-  /**
-   * Maintainability grade
-   */
-  maintainability?: GradeLevel;
-
-  /**
-   * Security grade
-   */
-  security?: GradeLevel;
-
-  /**
-   * Performance grade
-   */
-  performance?: GradeLevel;
-}
-
-/**
- * Structured code review output
- */
-export interface StructuredReview {
-  /**
-   * Overall grade for the codebase
-   */
-  grade?: GradeLevel;
-
-  /**
-   * Detailed grade breakdown by category
-   */
-  gradeCategories?: GradeCategories;
-
-  /**
-   * Summary of the code review
-   */
-  summary: string;
-
-  /**
-   * List of issues found in the code review
-   */
-  issues: ReviewIssue[];
-
-  /**
-   * General recommendations that don't fit into specific issues
-   */
-  recommendations?: string[];
-
-  /**
-   * Positive aspects of the code
-   */
-  positiveAspects?: string[];
-}

package/src/types/tokenAnalysis.ts

@@ -1,56 +0,0 @@
-/** Token analysis primitives shared across the CLI. */
-
-import type { FileInfo } from './review';
-
-export interface FileTokenAnalysis {
-  path: string;
-  relativePath: string | undefined;
-  tokenCount: number;
-  sizeInBytes: number;
-  tokensPerByte: number;
-}
-
-export interface TokenAnalysisResult {
-  files: FileTokenAnalysis[];
-  totalTokens: number;
-  totalSizeInBytes: number;
-  averageTokensPerByte: number;
-  fileCount: number;
-  promptOverheadTokens: number;
-  estimatedTotalTokens: number;
-  contextWindowSize: number;
-  exceedsContextWindow: boolean;
-  estimatedPassesNeeded: number;
-  chunkingRecommendation: ChunkingRecommendation;
-}
-
-export interface ChunkingRecommendation {
-  chunkingRecommended: boolean;
-  recommendedChunks: FileChunk[];
-  reason: string;
-}
-
-export interface FileChunk {
-  files: string[];
-  estimatedTokenCount: number;
-  priority: number;
-}
-
-export interface TokenAnalysisOptions {
-  reviewType: string;
-  modelName: string;
-  optimizeForSpeed?: boolean;
-  additionalPromptOverhead?: number;
-  contextMaintenanceFactor?: number;
-}
-
-export declare class TokenAnalyzer {
-  static analyzeFile(file: FileInfo, options: TokenAnalysisOptions): FileTokenAnalysis;
-  static analyzeFiles(files: FileInfo[], options: TokenAnalysisOptions): TokenAnalysisResult;
-}
-
-export declare function formatTokenAnalysis(
-  analysis: TokenAnalysisResult,
-  modelName: string,
-  includeFiles?: boolean,
-): string;

package/src/utils/FileReader.ts

@@ -1,93 +0,0 @@
-/**
- * @fileoverview File reading utilities.
- *
- * This module provides utilities for reading files and directories,
- * with error handling and logging.
- */
-
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import type { FileInfo } from '../types/review';
-import logger from './logger';
-
-/**
- * Read a file and return its content
- * @param filePath Path to the file
- * @returns Promise resolving to the file content
- * @throws Error if the file cannot be read
- */
-export async function readFile(filePath: string): Promise<string> {
-  try {
-    return await fs.readFile(filePath, 'utf-8');
-  } catch (error) {
-    logger.error(
-      `Error reading file ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
-    );
-    throw error;
-  }
-}
-
-/**
- * Read a file and return its content with file info
- * @param filePath Path to the file
- * @returns Promise resolving to a FileInfo object
- */
-export async function readFileWithInfo(filePath: string): Promise<FileInfo> {
-  try {
-    const content = await fs.readFile(filePath, 'utf-8');
-    const extension = path.extname(filePath).slice(1);
-
-    return {
-      path: filePath,
-      content,
-      extension,
-    };
-  } catch (error) {
-    logger.error(
-      `Error reading file ${filePath}: ${error instanceof Error ? error.message : String(error)}`,
-    );
-    throw error;
-  }
-}
-
-/**
- * Read multiple files and return their contents with file info
- * @param filePaths Array of file paths
- * @returns Promise resolving to an array of FileInfo objects
- */
-export async function readFilesWithInfo(filePaths: string[]): Promise<FileInfo[]> {
-  const fileInfoPromises = filePaths.map((filePath) => readFileWithInfo(filePath));
-  return Promise.all(fileInfoPromises);
-}
-
-/**
- * Read all files in a directory recursively
- * @param dirPath Path to the directory
- * @param filter Optional filter function to exclude certain files
- * @returns Promise resolving to an array of file paths
- */
-export async function readFilesInDirectory(
-  dirPath: string,
-  filter?: (filePath: string) => boolean,
-): Promise<string[]> {
-  const result: string[] = [];
-
-  async function processDirectory(currentPath: string) {
-    const entries = await fs.readdir(currentPath, { withFileTypes: true });
-
-    for (const entry of entries) {
-      const entryPath = path.join(currentPath, entry.name);
-
-      if (entry.isDirectory()) {
-        await processDirectory(entryPath);
-      } else if (entry.isFile()) {
-        if (!filter || filter(entryPath)) {
-          result.push(entryPath);
-        }
-      }
-    }
-  }
-
-  await processDirectory(dirPath);
-  return result;
-}