/** * Documentation Naming Conventions for @akson ecosystem * Based on industry best practices and consistency analysis */ import { ValidationResult } from './types'; export interface NamingRule { pattern: RegExp; description: string; examples: string[]; category: DocumentCategory; } export type DocumentCategory = 'package' | 'core' | 'guide' | 'api' | 'planning' | 'archive' | 'integration' | 'meta'; export declare const NAMING_CONVENTIONS: Record; export declare class DocumentNamingValidator { /** * Validate if a file name follows the correct convention for its location */ validateFileName(fileName: string, filePath: string): NamingValidationResult; /** * Categorize document based on file path */ private categorizeByPath; /** * Generate naming suggestions for invalid file names */ private generateSuggestions; /** * Get recommended file name for a document */ getRecommendedName(currentName: string, category: DocumentCategory): string; } export interface NamingValidationResult extends Omit { valid: boolean; category: DocumentCategory; matchedRule?: NamingRule; suggestions?: string[]; violations?: Array<{ rule: string; examples: string[]; }>; } export declare const namingValidator: DocumentNamingValidator; /** * Standard file name patterns by category */ export declare const STANDARD_PATTERNS: { readonly PACKAGE_README: "README.md"; readonly PACKAGE_CHANGELOG: "CHANGELOG.md"; readonly PACKAGE_LICENSE: "LICENSE.md"; readonly CORE_OVERVIEW: "01-OVERVIEW.md"; readonly CORE_ARCHITECTURE: "02-ARCHITECTURE.md"; readonly CORE_SECURITY: "03-SECURITY.md"; readonly CORE_DATABASE: "04-DATABASE.md"; readonly CORE_API_DESIGN: "05-API_DESIGN.md"; readonly CORE_TESTING: "06-TESTING.md"; readonly CORE_DEPLOYMENT: "07-DEPLOYMENT.md"; readonly CORE_MONITORING: "08-MONITORING.md"; readonly CORE_DEPLOYMENT_LEGACY: "DEPLOYMENT.md"; readonly CORE_PUBLISHING_LEGACY: "PUBLISHING.md"; readonly CORE_CONFIGURATION_LEGACY: "CONFIGURATION.md"; readonly CORE_ARCHITECTURE_LEGACY: "ARCHITECTURE.md"; readonly GUIDE_GETTING_STARTED: "getting-started.md"; readonly GUIDE_TROUBLESHOOTING: "troubleshooting.md"; readonly GUIDE_BEST_PRACTICES: "best-practices.md"; readonly API_REFERENCE: "api-reference.md"; readonly API_MIGRATION: "migration-guide.md"; readonly API_EXAMPLES: "examples.md"; readonly META_CLAUDE: "CLAUDE.md"; readonly META_DOC_INDEX: "DOCUMENTATION_INDEX.md"; }; //# sourceMappingURL=naming-conventions.d.ts.map