code-smell-checker

majiayu000 的头像作者 majiayu000

检查 TypeScript + Vue 代码的可维护性问题。在检查代码质量、架构问题、类型安全或 Vue 最佳实践时使用。识别组件、类型和反应性数据处理方面的技术债务。

📖 中文导读:检查 TypeScript + Vue 代码的可维护性问题。在检查代码质量、架构问题、类型安全或 Vue 最佳实践时使用。识别组件、类型和反应性数据处理方面的技术债务。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。

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 metadata: 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:

Vue Components:

Reactive Data:

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