rule-auditor
Validates code against currently loaded rules and reports compliance violations. Use after implementing features, during code review, or to ensure coding standards are followed. Provides actionable feedback with line-by-line issues and suggested fixes.
When & Why to Use This Skill
The Rule Auditor is a comprehensive automated code validation tool designed to enforce project-specific coding standards and best practices. It streamlines the development workflow by scanning source files against a dynamic rule index, identifying compliance violations, and providing actionable, line-by-line feedback with suggested fixes to ensure high-quality, maintainable codebases.
Use Cases
- Automated Code Review: Instantly validate new features or components against project conventions to reduce manual review overhead and maintain consistency.
- Pre-commit Quality Gates: Integrate with Git hooks to catch naming, structural, or type-safety violations before code is committed to the repository.
- CI/CD Pipeline Integration: Generate structured JSON compliance reports during automated builds to enforce quality standards and prevent technical debt.
- Developer Onboarding: Help new team members quickly adapt to project-specific patterns and architectural requirements through real-time feedback.
- Legacy Code Auditing: Scan existing directories to identify and prioritize high-severity violations for refactoring and modernization efforts.
| name | rule-auditor |
|---|---|
| description | Validates code against currently loaded rules and reports compliance violations. Use after implementing features, during code review, or to ensure coding standards are followed. Provides actionable feedback with line-by-line issues and suggested fixes. |
| allowed-tools | read, grep, glob, search, codebase_search |
| version | 2.0 |
| error_handling | graceful |
| streaming | supported |
| output_formats | [markdown, json, inline_comments] |
Step 1: Load Rule Index
Load the rule index to discover all available rules dynamically:
- @.claude/context/rule-index.json
The index contains metadata for all 1,081+ rules in .claude/rules-master/ and .claude/archive/.
Step 2: Filter Relevant Rules
Query the index's technology_map based on target files:
Detect technologies from target files:
- File extension (
.tsx→ TypeScript, React) - Import statements (
next→ Next.js,react→ React) - Directory structure (
app/→ Next.js App Router)
- File extension (
Query technology_map:
// Pseudocode const detectedTech = ['nextjs', 'react', 'typescript']; const relevantRules = []; detectedTech.forEach(tech => { const rules = index.technology_map[tech] || []; relevantRules.push(...rules); });Load only relevant rule files (progressive disclosure):
- Master rules take priority
- Archive rules supplement
- Load 5-10 most relevant rules, not all 1,081
Step 3: Scan Target Files
Identify the files to audit based on the task:
# For a specific file
audit: src/components/UserAuth.tsx
# For a directory
audit: src/components/
# For recent changes
git diff --name-only HEAD~1
Step 4: Extract Rule Patterns
Parse the relevant .mdc files to extract checkable patterns:
Pattern Categories to Check:
| Category | Example Rule | Check Method |
|---|---|---|
| Naming | "Use camelCase for functions" | Regex scan |
| Structure | "Place components in components/ dir" |
Path check |
| Imports | "Use ES modules, not CommonJS" | Pattern match |
| Types | "Avoid any, prefer unknown" |
AST-level grep |
| Performance | "Use Server Components by default" | Directive scan |
| Security | "Never hardcode secrets" | Pattern detection |
Step 5: Generate Compliance Report
Output a structured report with violations, warnings, and passed rules.
**Next.js / React Audit**: - CHECK: 'use client' directive present when using useState, useEffect, useContext - CHECK: Server Components for data fetching (no useEffect for fetch) - CHECK: Image optimization using next/imageTypeScript Audit:
- CHECK: Type safety - No
anytypes, interfaces for object shapes - CHECK: Naming conventions - PascalCase for Components, camelCase for functions
Python/FastAPI Audit:
- CHECK: Async patterns - async def for I/O operations
- CHECK: Type hints - All function parameters typed
## Rule Audit Report
**Target**: src/components/UserAuth.tsx
**Rules Applied**: nextjs.mdc, typescript.mdc, react.mdc
**Scan Date**: {{timestamp}}
### Summary
- **Pass**: 12 rules
- **Warn**: 3 rules
- **Fail**: 2 rules
### Violations
#### FAIL: Use Server Components by default
- **File**: src/components/UserAuth.tsx:1
- **Issue**: Missing 'use client' directive but uses useState
- **Rule**: nextjs.mdc > Components
- **Fix**: Add 'use client' at file top, or refactor to Server Component
#### FAIL: Avoid using `any`
- **File**: src/components/UserAuth.tsx:45
- **Issue**: `const user: any = await getUser()`
- **Rule**: typescript.mdc > Type System
- **Fix**: Define proper User interface
#### WARN: Minimize use of 'useEffect'
- **File**: src/components/UserAuth.tsx:23
- **Issue**: useEffect for data fetching
- **Rule**: nextjs.mdc > Performance
- **Suggestion**: Consider Server Component with async/await
### Passed Rules
- ✅ Use TypeScript strict mode
- ✅ Use lowercase with dashes for directories
- ✅ Implement proper error boundaries
... (12 more)
**JSON Output Format (for CI/CD)**:
{
"target": "src/components/",
"timestamp": "2025-11-29T10:00:00Z",
"rules_applied": ["nextjs.mdc", "typescript.mdc"],
"summary": {
"pass": 12,
"warn": 3,
"fail": 2
},
"violations": [
{
"severity": "fail",
"rule": "typescript.mdc",
"pattern": "Avoid using any",
"file": "src/components/UserAuth.tsx",
"line": 45,
"code": "const user: any = await getUser()",
"fix": "Define User interface"
}
]
}
**Inline Comments Format**:
// RULE_VIOLATION: typescript.mdc > Avoid using `any`
// FIX: Define User interface with proper types
const user: any = await getUser(); // ❌ FAIL
**Pre-Commit Hook**:
#!/bin/bash
# .claude/hooks/pre-commit-audit.sh
# Hook: PreToolUse (for Edit, Write tools)
# Run rule audit on modified files
modified=$(git diff --cached --name-only)
for file in $modified; do
audit_result=$(claude skill rule-auditor --target "$file" --format json)
if echo "$audit_result" | jq -e '.summary.fail > 0' > /dev/null; then
echo "Rule violations found in $file"
exit 1
fi
done
**CI/CD Integration (GitHub Actions)**:
# GitHub Actions example
- name: Rule Audit
run: |
claude skill rule-auditor --target src/ --format json > audit-report.json
if [ $(jq '.summary.fail' audit-report.json) -gt 0 ]; then
echo "::error::Rule violations detected"
exit 1
fi
**Quick Commands**:
# Audit current file
/audit this file
# Audit a specific directory
/audit src/components/
# Audit with specific rules only
/audit src/ --rules nextjs,typescript
# Generate CI-friendly output
/audit src/ --format json --strict
# Show only failures
/audit src/ --severity fail