Setup
1. Create Configuration Folder
Create a.codeant
folder in your repository root (same level as your .git
folder):
2. Create Instructions File
Inside the.codeant
folder, create an instructions.json
file with your custom review instructions.
Configuration Format
Theinstructions.json
file uses the following structure:
File Pattern Examples
CodeAnt uses minimatch for glob patterns. Here are common patterns:Pattern | Description |
---|---|
**/*.js | All JavaScript files in any directory |
src/**/*.ts | All TypeScript files in src directory and subdirectories |
*.test.js | Test files in root directory only |
**/*.{js,ts,jsx,tsx} | All JavaScript/TypeScript files |
!**/node_modules/** | Exclude node_modules directory |
components/**/*.vue | All Vue files in components directory |
**/*.spec.{js,ts} | All spec test files |
Instruction Examples
Common Use Cases
1. Ignore Specific Patterns:Sample instructions.json
Here’s a complete example configuration:Best Practices
- Use descriptive IDs: Make instruction IDs clear and meaningful
- Be specific with patterns: Target exact files or directories that need special treatment
- Document reasoning: Use clear descriptions explaining why each instruction exists
- Test patterns: Verify your glob patterns match the intended files
- Keep it minimal: Only add instructions when necessary to avoid over-customization
- Scope appropriately: Use scope to control where instructions apply - IDE only, PR reviews only, or both
instructions.json
file, CodeAnt will automatically apply these custom instructions during the next code review.