ds-sfcoe-ailabs/lib/messages/index.d.ts

AI-powered code review tool with static analysis integration for comprehensive code quality assessment.

/**
 * @fileoverview Message constants for the AI Code Reviewer CLI tool
 * Simple message constants that replace the Salesforce Messages framework with straightforward constants
 * Contains command descriptions, examples, and flag documentation for the pr-review command
 *
 * @example
 * ```typescript
 * import { MESSAGES } from './messages';
 *
 * const prReviewCommand = MESSAGES['pr-review'];
 * console.log(prReviewCommand.summary);
 * console.log(prReviewCommand.flags.aiProvider);
 * ```
 */
/**
 * Message constants organized by command name
 * Contains comprehensive documentation for CLI commands including descriptions, examples, and flag definitions
 */
export declare const MESSAGES: {
    /**
     * Configuration for the 'pr-review' command
     * Provides AI-powered code review functionality with multiple provider support
     */
    'pr-review': {
        /** Brief one-line summary of what the command does */
        summary: string;
        /** Detailed description of the command's functionality and features */
        description: string;
        /** Array of practical usage examples showing different command variations */
        examples: string[];
        /**
         * Flag definitions with descriptions for command-line options
         * Each flag provides help text explaining its purpose and usage
         */
        flags: {
            /** Path to Git repository directory (default: current directory) */
            repoDir: string;
            /** Source commit/branch for diff comparison (default: HEAD~1) */
            from: string;
            /** Target commit/branch for diff comparison (default: HEAD) */
            to: string;
            /** Pull request ID for posting review comments */
            pullRequestId: string;
            /** Path to Salesforce Code Analyzer configuration file (YAML format) */
            sfConfigFile: string;
            /** Path to PMD configuration file (XML ruleset format) */
            pmdConfigFile: string;
            /** AI service provider: OpenAI, AzureOpenAI, or Anthropic */
            aiProvider: string;
            /** Authentication token for AI provider */
            aiToken: string;
            /** AI model identifier (e.g., gpt-4, claude-3-sonnet) */
            aiModel: string;
            /** Custom AI API endpoint URL */
            aiApiEndpoint: string;
            /** AI API version */
            aiApiVersion: string;
            /** Git hosting provider (currently supports GitHub) */
            gitProvider: string;
            /** Authentication token for git provider */
            gitToken: string;
            /** Git repository owner/organization name */
            gitOwner: string;
            /** Git repository name */
            gitRepo: string;
        };
    };
};