Skip to content

README.md

Latest commit

 

History

History
104 lines (72 loc) · 2.69 KB

README.md

File metadata and controls

104 lines (72 loc) · 2.69 KB
Raw

Coding Style Analyzer

A meta-skill that analyzes your repositories to discover your coding patterns and generates a reusable "your-coding-style" skill for Claude.

Quick Start

# 1. Build
npm install && npm run build

# 2. Analyze your code
npm run dev analyze --path ~/workspace

# 3. Use in Claude
"Generate a component following my coding style"

Full guide: QUICK_START.md (5 min)

📚 Documentation Hub

Need Document Time
Just start QUICK_START.md 5 min
Understand the skill SKILL.md 10 min
Install & setup This README 5 min
See what it generates EXAMPLE_OUTPUT.md 10 min
Technical details INTEGRATION.md 15 min
Architecture & code SUMMARY.md 20 min
Problem solving TROUBLESHOOTING.md 5-10 min
Contributing CONTRIBUTING.md varies

Installation

cd plugins/coding-style-analyzer
npm install
npm run build

Usage

Via Claude (Recommended)

"Analyze my coding style for ~/workspace"

Claude will guide you through: scan → questions → generate skill

Via CLI

npm run dev analyze --path ~/workspace
npm run dev analyze --path ~/workspace --name my-style
npm run dev analyze --path ~/workspace --non-interactive

See QUICK_START.md for all options.

What Gets Generated

The skill creates 6 files that encode your coding style:

~/.openclaw/workspace/skills/your-coding-style/
├── RULES.md              # Your extracted rules with examples
├── PROMPTS.md            # Claude prompts for your style
├── EXAMPLES.md           # Good/bad code examples  
├── style-guide.json      # Machine-readable rules
├── SKILL.md              # Documentation
└── metadata.json         # Analysis metadata

See it in action: EXAMPLE_OUTPUT.md

Supported Languages

TypeScript, JavaScript, Python, Rust, Go, Java, C# (+ 20+ frameworks detected)

How It Works

  1. Scan - Analyzes your code for patterns (naming, functions, tests, etc.)
  2. Ask - Generates smart questions based on what it found
  3. Synthesize - Merges your code patterns + your answers into rules
  4. Generate - Creates a reusable skill with documentation and prompts

Full details: INTEGRATION.md or SKILL.md

Roadmap

  • AST parsing for deeper analysis
  • Linter rule generation (ESLint, Pylint)
  • Configuration merging
  • Team style aggregation
  • Web UI

License

MIT