Skip to content

CLAUDE.md

Latest commit

 

History

History
50 lines (45 loc) · 2.84 KB

CLAUDE.md

File metadata and controls

50 lines (45 loc) · 2.84 KB
  • Always use guidelines from the docs/guidelines folder

Guidelines Index

📖 Documentation Guidelines

Path: docs/guidelines/how-to-translate-readme-docs.md
Value: Standardizes documentation translation process and multilingual content management
Key Areas:

  • Translation workflow using LLMs for documentation
  • Multilanguage README pattern using ISO 639-1 codes (README-{lang_code}.md)
  • Quality standards: preserve technical content, ensure natural language flow
  • Review process for translated content
  • MAPS framework for complex translations

🖥️ Console Command Development

Path: docs/guidelines/how-to-write-console-command.md
Value: Ensures consistent CLI interface design and proper Symfony console integration
Key Areas:

  • Command structure: extend Base class, use #[AsCommand] attribute
  • Required methods: configure() and execute()
  • Type system: always use Path value object instead of strings for file paths
  • Interactive patterns: use $input->isInteractive() for detection
  • Error handling: proper return codes (Command::SUCCESS, Command::FAILURE, Command::INVALID)
  • Best practices: method extraction, confirmation dialogs, file operation patterns
  • Available services through DI container (Logger, StyleInterface, etc.)

📝 PHP Code Standards

Path: docs/guidelines/how-to-write-php-code-best-practices.md
Value: Maintains modern PHP code quality and leverages latest language features for better performance and maintainability
Key Areas:

  • Modern PHP 8.1+ features: constructor promotion, union types, match expressions, throw expressions
  • Code structure: PER-2 standards, single responsibility, final classes by default
  • Enumerations: use enums for fixed value sets, CamelCase naming, backed enums for primitives
  • Immutability: readonly properties, with prefix for immutable updates
  • Type system: precise PHPDoc annotations, generics, non-empty-string types
  • Comparison patterns: strict equality (===), null coalescing (??), avoid empty()
  • Dependency injection and IoC container patterns

🧪 Testing Guidelines

Path: docs/guidelines/how-to-write-tests.md
Value: Ensures comprehensive test coverage with modern PHPUnit practices and proper test isolation
Key Areas:

  • Test structure: mirror source structure, final test classes, Arrange-Act-Assert pattern
  • Module testing: independent test areas with dedicated Stub directories
  • Naming: {ClassUnderTest}Test, descriptive method names
  • Modern PHPUnit: PHP 8.1+ attributes (#[CoversClass], #[DataProvider]), data providers with generators
  • Isolation: mock dependencies, use test doubles, reset state between tests
  • Critical restrictions: DO NOT mock enums or final classes - use real instances
  • Error testing: expectException before Act phase
  • Test traits for shared functionality