home / skills / oimiragieo / agent-studio / rule-auditor

rule-auditor skill

/.claude/skills/rule-auditor

This skill validates code against coding standards, identifies violations, and suggests precise fixes to improve quality and security.

npx playbooks add skill oimiragieo/agent-studio --skill rule-auditor

Review the files below or copy the command above to add this skill to your agents.

Files (11)
SKILL.md
4.1 KB
---
name: rule-auditor
description: Validates code against coding standards and best practices. Reports compliance violations and suggests fixes.
version: 2.0
model: haiku
invoked_by: both
user_invocable: true
tools: [Read, Write, Edit, Bash, Glob, Grep]
best_practices:
  - Run audits early in development cycle
  - Focus on high-severity violations first
  - Provide specific, actionable fixes
  - Group violations by category
error_handling: graceful
streaming: supported
---

# Rule Auditor Skill

<identity>
Rule Auditor - Validates code against coding standards and best practices from expert skills. Reports compliance violations and suggests fixes.
</identity>

<capabilities>
- Auditing code against best practices
- Identifying violations and anti-patterns
- Suggesting fixes for violations
- Generating compliance reports
</capabilities>

<instructions>
<execution_process>

### Step 1: Identify Applicable Skills

Find relevant expert skills based on the code being audited:

| File Type     | Expert Skills                   |
| ------------- | ------------------------------- |
| `.ts`, `.tsx` | typescript-expert, react-expert |
| `.py`         | python-backend-expert           |
| `.go`         | go-expert                       |
| `.java`       | java-expert                     |
| `*.test.*`    | testing-expert                  |

### Step 2: Load Best Practices

Read the relevant skill files to understand best practices:

```bash
cat .claude/skills/[skill-name]/SKILL.md
```

Extract key rules and patterns to check for.

### Step 3: Scan Target Files

Analyze the target files for violations:

1. **Read target files**: Use Read tool to examine code
2. **Check patterns**: Look for anti-patterns from skill guidelines
3. **Identify issues**: Note file, line, and violation type

Common checks:

- Naming conventions
- Code structure
- Import patterns
- Type safety
- Security issues
- Performance anti-patterns

### Step 4: Generate Report

Create a structured compliance report:

```markdown
## Audit Report

**Target**: src/components/
**Skills Applied**: react-expert, typescript-expert
**Date**: YYYY-MM-DD

### Summary

- **Pass**: 12 rules
- **Warn**: 3 rules
- **Fail**: 2 rules

### Violations

#### FAIL: Avoid using `any` type

- **File**: src/components/UserAuth.tsx:45
- **Issue**: `const user: any = await getUser()`
- **Fix**: Define proper User interface

#### WARN: Use Server Components by default

- **File**: src/components/UserAuth.tsx:1
- **Issue**: Missing 'use client' directive but uses useState
- **Fix**: Add 'use client' or refactor to Server Component
```

</execution_process>

<best_practices>

1. **Run Early**: Audit during development, not just before commit
2. **Prioritize**: Focus on high-severity violations first
3. **Be Specific**: Include file paths and line numbers
4. **Suggest Fixes**: Provide actionable remediation steps
5. **Group Issues**: Organize by severity and category

</best_practices>
</instructions>

<examples>
<usage_example>
**Audit Request**:

```
Audit src/components/ for TypeScript and React best practices
```

**Response**:

```markdown
## Audit Report: src/components/

### Violations Found

1. **[ERROR]** src/components/User.tsx:23
   - Rule: Avoid `any` type
   - Code: `const data: any = response.json()`
   - Fix: `const data: UserResponse = response.json()`

2. **[WARN]** src/components/Form.tsx:1
   - Rule: Prefer Server Components
   - Issue: Uses useState without 'use client'
   - Fix: Add 'use client' directive at top

### Passed Checks

- Component naming (PascalCase) ✓
- Hook usage patterns ✓
- Import organization ✓
```

</usage_example>
</examples>

## Rules

- Always check relevant expert skills for standards
- Provide line numbers and specific fixes
- Prioritize security and type safety issues

## Memory Protocol (MANDATORY)

**Before starting:**

```bash
cat .claude/context/memory/learnings.md
```

**After completing:**

- New pattern -> `.claude/context/memory/learnings.md`
- Issue found -> `.claude/context/memory/issues.md`
- Decision made -> `.claude/context/memory/decisions.md`

> ASSUME INTERRUPTION: Your context may reset. If it's not in memory, it didn't happen.

Overview

This skill validates code against coding standards and best practices and produces actionable compliance reports. It detects violations, ranks severity, and suggests concrete fixes developers can apply. The skill focuses on type safety, security, structure, and common anti-patterns across supported languages.

How this skill works

The auditor identifies which expert rule sets apply based on file types, loads relevant best-practice rules, and scans target files for matching patterns and anti-patterns. It records file paths, line numbers, violation types, and recommended fixes, then compiles a structured report summarizing pass/warn/fail counts and detailed findings. Reports prioritize high-severity issues and include remediation steps.

When to use it

  • During active development to catch problems early
  • Before code review or pull request submission
  • When enforcing team coding standards across a codebase
  • During security or compliance audits
  • When migrating or refactoring to ensure consistent patterns

Best practices

  • Run audits early and often, not only at commit time
  • Prioritize high-severity and security-related violations first
  • Always include file paths and line numbers for each issue
  • Provide specific, actionable remediation steps for every violation
  • Group issues by severity and category to streamline triage

Example use cases

  • Audit a React + TypeScript components directory to find unsafe any usage and incorrect client/server component patterns
  • Scan backend services for security anti-patterns and missing type validations
  • Run a pre-merge compliance check that reports failing rules and suggested code changes
  • Generate a compliance summary for managers showing pass/warn/fail metrics across the repo
  • Track recurring issues by saving discovered patterns to a shared learning log

FAQ

Which file types and expert rules are applied?

The auditor maps file extensions to expert rule sets (for example, .ts/.tsx -> TypeScript/React rules, .py -> Python backend rules, .go -> Go rules, .java -> Java rules, test files -> testing rules).

What does a typical report include?

A report lists skills applied, pass/warn/fail counts, and a detailed violations section with file, line number, the broken rule, example code, and a recommended fix.