#!/usr/bin/env node const fs = require('fs'); const path = require('path'); /** * Configuration documentation generator with Mintlify-style clarity * Follows Mintlify's ResponseField pattern for better readability */ const SCHEMA_PATH = 'schema/schema.v2.json'; const CONFIG_OUTPUT_PATH = 'reference/configuration.mdx'; const TOOLS_OUTPUT_PATH = 'reference/tools-reference.mdx'; // Helper function to get nested property safely function getNestedProperty(obj, path) { return path.split('.').reduce((current, key) => current && current[key], obj); } // Convert property name to readable title function formatTitle(key) { return key .replace(/_/g, ' ') .replace(/([A-Z])/g, ' $1') .replace(/^./, str => str.toUpperCase()) .trim(); } // Generate description from schema property function generateDescription(property, key) { if (property.description) { return property.description; } const descriptions = { 'enabled': 'Enable this feature', 'language': 'Language setting', 'timeout': 'Timeout duration', 'threshold': 'Threshold value', 'mode': 'Operating mode', 'scope': 'Configuration scope', }; return descriptions[key] || `Configuration for ${formatTitle(key).toLowerCase()}`; } // Generate icon based on property type and name function getPropertyIcon(key, property) { const iconMap = { // Type-based icons 'boolean': 'toggle-left', 'string': 'type', 'number': 'hash', 'array': 'list', 'object': 'settings', // Name-based icons 'language': 'globe', 'enabled': 'power', 'timeout': 'clock', 'profile': 'user', 'tools': 'wrench', 'auto_review': 'play', 'path_filters': 'filter', 'labels': 'tag', 'docstrings': 'book-open', 'unit_tests': 'test-tube', 'chat': 'message-circle', 'knowledge_base': 'brain', 'jira': 'external-link', 'linear': 'zap', 'github': 'github', 'security': 'shield', 'pre_merge_checks': 'check-circle', }; // Check name-based icons first for (const [pattern, icon] of Object.entries(iconMap)) { if (key.toLowerCase().includes(pattern)) { return icon; } } // Fall back to type-based icons return iconMap[property.type] || 'settings'; } // Generate type information function formatType(property) { if (property.enum) { return 'enum'; } else if (property.items) { return `array of ${property.items.type || 'object'}`; } else { return property.type || 'object'; } } // Generate ResponseField component for a property function generateResponseField(key, property, level = 0) { const title = formatTitle(key); const description = generateDescription(property, key); const type = formatType(property); const required = property.required || false; const icon = getPropertyIcon(key, property); let content = ''; // Main ResponseField content += `\n`; content += ` ${description}\n\n`; // Add constraints if present if (property.enum && property.enum.length > 0) { content += ` One of the following: ${property.enum.map(val => `\`${val}\``).join(', ')}\n\n`; } if (property.default !== undefined) { let defaultVal = property.default; if (typeof defaultVal === 'string') { defaultVal = `"${defaultVal}"`; } else if (typeof defaultVal === 'object') { defaultVal = JSON.stringify(defaultVal); } content += ` Defaults to \`${defaultVal}\`.\n\n`; } // Add validation constraints const constraints = []; if (property.minLength) constraints.push(`Min length: ${property.minLength}`); if (property.maxLength) constraints.push(`Max length: ${property.maxLength}`); if (property.minimum !== undefined) constraints.push(`Min: ${property.minimum}`); if (property.maximum !== undefined) constraints.push(`Max: ${property.maximum}`); if (constraints.length > 0) { content += ` \n ${constraints.join(', ')}\n \n\n`; } // Handle nested objects with Expandable if (property.type === 'object' && property.properties) { const nestedProps = Object.entries(property.properties); if (nestedProps.length > 0) { content += ` \n`; nestedProps.forEach(([subKey, subProperty]) => { // Recursively generate nested ResponseFields const nestedContent = generateResponseField(subKey, subProperty, level + 1) .split('\n') .map(line => line ? ` ${line}` : line) .join('\n'); content += nestedContent; }); content += ` \n`; } } // Handle array items if (property.type === 'array' && property.items && property.items.properties) { content += ` \n`; Object.entries(property.items.properties).forEach(([itemKey, itemProperty]) => { const nestedContent = generateResponseField(itemKey, itemProperty, level + 1) .split('\n') .map(line => line ? ` ${line}` : line) .join('\n'); content += nestedContent; }); content += ` \n`; } content += `\n\n`; return content; } // Generate section overview cards function generateSectionCards(schemaProps) { const sections = [ { key: 'reviews', title: 'Code Reviews', description: 'Configure automatic code reviews, tools, and review behavior', icon: 'git-pull-request', }, { key: 'chat', title: 'Chat & Integrations', description: 'Set up chat features and third-party integrations', icon: 'message-circle', }, { key: 'knowledge_base', title: 'Knowledge Base', description: 'Configure learning and knowledge sharing features', icon: 'brain', }, { key: 'code_generation', title: 'Code Generation', description: 'Settings for docstrings and unit test generation', icon: 'code', }, ]; let content = `## Configuration Sections\n\n`; content += `\n`; sections.forEach(section => { if (schemaProps[section.key]) { content += ` \n`; content += ` ${section.description}\n`; content += ` \n`; } }); content += `\n\n`; return content; } // Generate usage example for a section function generateUsageExample(key, property) { const examples = { 'reviews': `\`\`\`yaml .coderabbit.yaml reviews: profile: chill high_level_summary: true auto_review: enabled: true drafts: false tools: eslint: enabled: true gitleaks: enabled: true \`\`\``, 'chat': `\`\`\`yaml .coderabbit.yaml chat: auto_reply: true integrations: jira: usage: enabled \`\`\``, 'knowledge_base': `\`\`\`yaml .coderabbit.yaml knowledge_base: opt_out: false code_guidelines: enabled: true filePatterns: - "**/.cursorrules" - "**/CODING_STANDARDS.md" \`\`\``, 'code_generation': `\`\`\`yaml .coderabbit.yaml code_generation: docstrings: language: en-US unit_tests: path_instructions: [] \`\`\`` }; return examples[key] || `\`\`\`yaml .coderabbit.yaml\n${key}:\n # Configure ${key} options here\n\`\`\``; } // Generate main section documentation function generateSectionDocs(key, property) { const title = formatTitle(key); let content = `## ${title}\n\n`; content += `${generateDescription(property, key)}\n\n`; // Add usage example content += `### Example Configuration\n\n`; content += generateUsageExample(key, property); content += `\n\n`; // Add reference section content += `### Reference\n\n`; if (property.properties) { Object.entries(property.properties).forEach(([propKey, propProperty]) => { content += generateResponseField(propKey, propProperty); }); } return content; } // Generate global settings section function generateGlobalSettings(schemaProps) { const globalProps = ['language', 'tone_instructions', 'early_access', 'enable_free_tier']; const existingGlobalProps = globalProps.filter(key => schemaProps[key]); if (existingGlobalProps.length === 0) return ''; let content = `## Global Settings\n\n`; content += `\n`; content += ` These settings apply to your entire CodeRabbit configuration across all repositories.\n`; content += `\n\n`; content += `### Example Configuration\n\n`; content += `\`\`\`yaml .coderabbit.yaml\n`; content += `language: en-US\n`; content += `tone_instructions: "Be concise and focus on critical issues only"\n`; content += `early_access: false\n`; content += `\`\`\`\n\n`; content += `### Reference\n\n`; existingGlobalProps.forEach(key => { const property = schemaProps[key]; content += generateResponseField(key, property); }); return content; } // Generate configuration examples with tabs function generateConfigurationExamples() { return `## Configuration Examples\n\n` + `\n` + ` \n` + ` Perfect for getting started with CodeRabbit.\n\n` + ` \`\`\`yaml .coderabbit.yaml\n` + ` language: en-US\n` + ` reviews:\n` + ` profile: chill\n` + ` high_level_summary: true\n` + ` auto_review:\n` + ` enabled: true\n` + ` drafts: false\n` + ` \`\`\`\n` + ` \n\n` + ` \n` + ` Comprehensive configuration with multiple tools and custom settings.\n\n` + ` \`\`\`yaml .coderabbit.yaml\n` + ` language: en-US\n` + ` tone_instructions: "Be concise and focus on critical issues only"\n` + ` reviews:\n` + ` profile: assertive\n` + ` high_level_summary: true\n` + ` path_filters:\n` + ` - "!node_modules/**"\n` + ` - "!dist/**"\n` + ` - "src/**"\n` + ` tools:\n` + ` eslint:\n` + ` enabled: true\n` + ` ruff:\n` + ` enabled: true\n` + ` gitleaks:\n` + ` enabled: true\n` + ` auto_review:\n` + ` enabled: true\n` + ` drafts: false\n` + ` ignore_title_keywords:\n` + ` - "wip"\n` + ` - "draft"\n` + ` knowledge_base:\n` + ` code_guidelines:\n` + ` enabled: true\n` + ` filePatterns:\n` + ` - "**/.cursorrules"\n` + ` - "**/CODING_STANDARDS.md"\n` + ` \`\`\`\n` + ` \n\n` + ` \n` + ` Configuration optimized for team collaboration.\n\n` + ` \`\`\`yaml .coderabbit.yaml\n` + ` language: en-US\n` + ` reviews:\n` + ` profile: assertive\n` + ` high_level_summary: true\n` + ` suggested_reviewers: true\n` + ` auto_assign_reviewers: true\n` + ` finishing_touches:\n` + ` docstrings:\n` + ` enabled: true\n` + ` unit_tests:\n` + ` enabled: true\n` + ` pre_merge_checks:\n` + ` title:\n` + ` mode: error\n` + ` requirements: "Title should be concise and descriptive"\n` + ` description:\n` + ` mode: warning\n` + ` chat:\n` + ` auto_reply: true\n` + ` integrations:\n` + ` jira:\n` + ` usage: enabled\n` + ` knowledge_base:\n` + ` learnings:\n` + ` scope: global\n` + ` issues:\n` + ` scope: global\n` + ` \`\`\`\n` + ` \n` + `\n\n`; } // Generate complete configuration documentation function generateConfigurationDocs(schema) { const schemaProps = schema.definitions.schema.properties; let mdxContent = `--- title: "Configuration Reference" description: "Complete reference for CodeRabbit configuration options with detailed explanations, types, and examples." --- This reference is automatically generated from the CodeRabbit configuration schema. Last updated: ${new Date().toISOString().split('T')[0]} CodeRabbit's behavior can be customized using a \`.coderabbit.yaml\` file in your repository root. This reference covers all available configuration options with clear property names and examples. Get started with basic configuration Download a complete template `; // Add section overview cards mdxContent += generateSectionCards(schemaProps); // Main configuration sections const mainSections = ['reviews', 'chat', 'knowledge_base', 'code_generation']; mainSections.forEach(sectionKey => { if (schemaProps[sectionKey]) { const property = schemaProps[sectionKey]; mdxContent += generateSectionDocs(sectionKey, property); } }); // Global settings mdxContent += generateGlobalSettings(schemaProps); // Configuration examples mdxContent += generateConfigurationExamples(); // Related resources mdxContent += `## Related Resources\n\n`; mdxContent += `\n`; mdxContent += ` \n`; mdxContent += ` Learn about @coderabbitai commands\n`; mdxContent += ` \n`; mdxContent += ` \n`; mdxContent += ` Browse all supported linters and analyzers\n`; mdxContent += ` \n`; mdxContent += ` \n`; mdxContent += ` Configuration tips and recommendations\n`; mdxContent += ` \n`; mdxContent += `\n\n`; return mdxContent; } // Generate tools reference documentation without Badge components function generateToolsReference(schema) { const toolsProperty = getNestedProperty(schema, 'definitions.schema.properties.reviews.properties.tools.properties'); if (!toolsProperty) { throw new Error('Tools configuration not found in schema'); } let mdxContent = `--- title: "Tools Reference" description: "Complete reference for all CodeRabbit supported tools and their configuration options, organized by category." --- This reference is automatically generated from the CodeRabbit tools schema. Last updated: ${new Date().toISOString().split('T')[0]} CodeRabbit supports integration with **${Object.keys(toolsProperty).length} static analysis tools**, linters, and security scanners. Each tool can be configured individually within your \`.coderabbit.yaml\` file. Enable multiple tools at once Browse tools by type Learn configuration basics ## Quick Setup Recommended tools for most projects: \`\`\`yaml .coderabbit.yaml reviews: tools: # Security scanning gitleaks: enabled: true # Language-specific linters (enable as needed) eslint: enabled: true ruff: enabled: true golangci-lint: enabled: true # Infrastructure hadolint: enabled: true yamllint: enabled: true \`\`\` Maximum security coverage: \`\`\`yaml .coderabbit.yaml reviews: tools: gitleaks: enabled: true semgrep: enabled: true checkov: enabled: true brakeman: enabled: true \`\`\` Comprehensive tool coverage: \`\`\`yaml .coderabbit.yaml reviews: tools: # Frontend eslint: enabled: true biome: enabled: true # Backend ruff: enabled: true golangci-lint: enabled: true # Infrastructure hadolint: enabled: true yamllint: enabled: true actionlint: enabled: true # Security gitleaks: enabled: true semgrep: enabled: true \`\`\` `; // Categorize tools const categories = { 'Language Linters': ['eslint', 'ruff', 'pylint', 'flake8', 'rubocop', 'swiftlint', 'golangci-lint', 'clippy', 'detekt', 'oxc'], 'Security & Secrets': ['gitleaks', 'semgrep', 'checkov', 'brakeman'], 'Code Quality': ['cppcheck', 'pmd', 'phpstan', 'phpmd', 'phpcs'], 'Infrastructure': ['hadolint', 'yamllint', 'actionlint', 'circleci', 'checkmake'], 'Documentation': ['markdownlint', 'languagetool', 'htmlhint'], 'Specialized': ['buf', 'prismaLint', 'shopifyThemeCheck', 'luacheck', 'dotenvLint', 'sqlfluff', 'regal'], 'Development Tools': ['biome', 'github-checks', 'shellcheck', 'ast-grep'] }; mdxContent += `## Tool Categories\n\n`; // Generate each category for (const [categoryName, toolNames] of Object.entries(categories)) { mdxContent += `### ${categoryName}\n\n`; mdxContent += `\n`; toolNames.forEach(toolName => { const tool = toolsProperty[toolName]; if (tool) { mdxContent += generateToolAccordion(toolName, tool); } }); mdxContent += `\n\n`; } // Related resources mdxContent += `## Related Resources\n\n`; mdxContent += `\n`; mdxContent += ` \n`; mdxContent += ` Complete configuration guide\n`; mdxContent += ` \n`; mdxContent += ` \n`; mdxContent += ` Control reviews with commands\n`; mdxContent += ` \n`; mdxContent += ` \n`; mdxContent += ` Tips for optimal configuration\n`; mdxContent += ` \n`; mdxContent += `\n\n`; return mdxContent; } // Generate tool accordion without Badge components function generateToolAccordion(toolName, tool) { const title = formatTitle(toolName); const icon = getToolIcon(toolName); const description = tool.description || `${title} configuration options.`; let content = ` \n`; content += ` ${description}\n\n`; content += ` **Configuration Options:**\n\n`; // Generate properties using ResponseField pattern if (tool.properties) { Object.entries(tool.properties).forEach(([propKey, propValue]) => { content += generateToolProperty(propKey, propValue); }); } // Example configuration content += ` **Example Configuration:**\n\n`; content += ` \`\`\`yaml\n`; content += ` reviews:\n`; content += ` tools:\n`; content += ` ${toolName}:\n`; content += ` enabled: true\n`; // Add additional example properties if they exist if (tool.properties) { Object.entries(tool.properties).forEach(([propKey, propValue]) => { if (propKey !== 'enabled' && propValue.type === 'string') { const exampleValue = propValue.default || getExampleValue(propKey, propValue); if (exampleValue) { content += ` ${propKey}: "${exampleValue}"\n`; } } }); } content += ` \`\`\`\n`; content += ` \n`; return content; } // Generate tool property without Badge components function generateToolProperty(key, property) { const type = formatType(property); const required = property.required ? ' required' : ''; const description = property.description || `Configuration for ${key}`; let content = ` \n`; content += ` ${description}\n`; if (property.enum && property.enum.length > 0) { content += `\n One of: ${property.enum.map(val => `\`${val}\``).join(', ')}\n`; } if (property.default !== undefined) { content += `\n Defaults to \`${property.default}\`.\n`; } content += ` \n\n`; return content; } // Get tool icon based on tool name function getToolIcon(toolName) { const iconMap = { 'eslint': 'code', 'ruff': 'snake', 'pylint': 'snake', 'flake8': 'snake', 'rubocop': 'gem', 'swiftlint': 'smartphone', 'golangci-lint': 'go', 'clippy': 'rust', 'detekt': 'kotlin', 'oxc': 'zap', 'gitleaks': 'key', 'semgrep': 'shield-alert', 'checkov': 'cloud-security', 'brakeman': 'shield', 'cppcheck': 'code', 'pmd': 'java', 'phpstan': 'php', 'phpmd': 'php', 'phpcs': 'php', 'hadolint': 'docker', 'yamllint': 'file-code', 'actionlint': 'github', 'circleci': 'circle', 'checkmake': 'hammer', 'markdownlint': 'markdown', 'languagetool': 'languages', 'htmlhint': 'code', 'buf': 'package', 'prismaLint': 'database', 'shopifyThemeCheck': 'shopping-bag', 'luacheck': 'moon', 'dotenvLint': 'file-key', 'sqlfluff': 'database', 'regal': 'shield-check', 'biome': 'wind', 'github-checks': 'github', 'shellcheck': 'terminal', 'ast-grep': 'search' }; return iconMap[toolName] || 'tool'; } // Get example value for property function getExampleValue(key, property) { if (property.default) return property.default; const examples = { 'config_file': '.eslint.yml', 'level': '0' }; return examples[key] || null; } // Main execution function main() { try { console.log('🎨 Generating enhanced configuration documentation...'); const schemaContent = fs.readFileSync(SCHEMA_PATH, 'utf8'); const schema = JSON.parse(schemaContent); // Generate configuration documentation const configDocs = generateConfigurationDocs(schema); fs.writeFileSync(CONFIG_OUTPUT_PATH, configDocs); console.log(`✅ Enhanced configuration documentation generated: ${CONFIG_OUTPUT_PATH}`); console.log(`📊 Generated ${configDocs.length} characters of beautiful documentation`); // Generate tools documentation const toolsDocs = generateToolsReference(schema); fs.writeFileSync(TOOLS_OUTPUT_PATH, toolsDocs); console.log(`✅ Enhanced tools reference documentation generated: ${TOOLS_OUTPUT_PATH}`); console.log(`📊 Generated ${toolsDocs.length} characters of categorized tools documentation`); console.log('🎉 Enhanced documentation generation completed successfully!'); } catch (error) { console.error('❌ Error generating documentation:', error.message); process.exit(1); } } if (require.main === module) { main(); } module.exports = { generateConfigurationDocs, generateToolsReference, formatTitle, generateDescription, getPropertyIcon };

Get started

Add CodeRabbit to your repository

Review pull requests

Create and resolve issues

IDE extensions

Configure

Manage your account

Generate reports

Best practices

Reference

Resources