code-smell-checker
Review TypeScript + Vue code for maintainability issues. Use when checking code quality, architectural problems, type safety, or Vue best practices. Identifies technical debt in components, types, and reactive data handling.
When & Why to Use This Skill
This Claude skill serves as an automated expert reviewer for TypeScript and Vue 3 projects, specifically designed to detect technical debt and maintainability issues. It systematically audits component architecture, reactive data patterns, and type safety to ensure codebases remain scalable, performant, and aligned with industry best practices.
Use Cases
- Automated Code Quality Audits: Use it during the pull request process to identify 'code smells' and architectural flaws before they reach production.
- AI-Generated Code Validation: Review and refine code snippets generated by AI to ensure they follow Vue 3 composition API best practices and strict TypeScript standards.
- Legacy Code Refactoring: Analyze existing Vue components to identify over-complex logic, props drilling, or inefficient reactive patterns for targeted refactoring.
- Type Safety Enhancement: Evaluate TypeScript type definitions to eliminate 'any' types and complex 'type gymnastics,' improving overall semantic clarity and developer experience.
- Performance Optimization: Detect improper use of watchers or deep reactive objects that could lead to memory leaks or UI lag in complex web applications.
| name | code-smell-checker |
|---|---|
| description | Review TypeScript + Vue code for maintainability issues. Use when checking code quality, architectural problems, type safety, or Vue best practices. Identifies technical debt in components, types, and reactive data handling. |
| license | Apache-2.0 |
| compatibility | TypeScript + Vue 3 projects |
| author | xiaoland |
| version | "1.0" |
| related-skills | "dev-vue-component" |
Code Smell Checker
When to use
Review code when you need to:
- Check AI-generated or developer code for maintainability
- Identify technical debt and quality issues
- Validate TypeScript type design and semantic clarity
- Review Vue component architecture
- Ensure reactive data handling best practices
- Conduct code quality assessments
What's covered
TypeScript Types:
- Organization and coupling → type-organization.md
- Extensibility and complexity → type-design.md
Vue Components:
- Structure and lifecycle → component-structure.md
- Props and state → component-props-state.md
- Templates and communication → component-template.md
Reactive Data:
- Ref, reactive, depth → reactive-basics.md
- Computed properties → reactive-computed.md
- Watch patterns → reactive-watch.md
- Performance → reactive-optimization.md
- Memory management → reactive-memory.md
How to use
1. Identify scope:
- Which area? (types, components, reactive)
- Which files to review?
2. Apply checklist:
- Read relevant reference doc
- Check code against items
- Note violations
3. Report findings:
- Categorize by severity
- Focus on maintainability impact
- Consider project context
4. Provide feedback:
- Explain why it's a problem
- Show the bad pattern
- Suggest concrete improvements
- Reference checklist item
Quick reference
TypeScript red flags:
- Scattered type definitions
any,object, overly broad types- Complex type gymnastics
- Types don't match runtime
Vue component red flags:
- Components >300 lines
- Props drilling >3 levels
- Mixed local/global/derived state
- Weak prop types
Reactive data red flags:
- Deep reactive on large data
- Computed with side effects
- Watch for transformations
- Wrong ref/reactive usage
Output format
## Review: [Component/Module]
### [Category]
#### [Issue]
- Severity: [Critical/Important/Minor]
- Location: file.ts:123
- Reference: [Link to checklist]
- Problem: [Explain]
- Fix: [Suggest]
Best practices
Be constructive:
- Focus on maintainability not preferences
- Explain "why" behind each smell
- Provide concrete alternatives
- Recognize when rules should bend
Be systematic:
- Review one category at a time
- Use checklist for coverage
- Document patterns
- Track recurring issues
Be pragmatic:
- Not all items apply to every project
- Consider project maturity
- Balance idealism with reality
- Prioritize high-impact issues