Skip to content

/code-health-check

Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.

shell
$ npx -y skills add huangjia2019/claude-code-engineering --skill code-health-check --agent claude-code

How it fires

How this skill gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.
  • You can call itInvoke it directly when you want it.
  • Slash command/code-health-check
How auto-invocation works

Context preview

The summary Claude sees to decide when to auto-load this skill.

Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.

SKILL.md

code-health-check.SKILL.md
name: code-health-check
description: Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.
context: fork
agent: general-purpose
allowed-tools:
  - Read
  - Grep
  - Glob

Code Health Check

Analyze the codebase at `$ARGUMENTS` and produce a structured health report.

Checks to Perform

1. File Organization

  • Are files reasonably sized? (Flag files > 200 lines)
  • Is the directory structure logical?
  • Any files that look misplaced?

2. Error Handling

  • Are async operations wrapped in try/catch?
  • Are errors propagated correctly (not swallowed)?
  • Is there a global error handler?

3. Security Basics

  • Any hardcoded secrets, API keys, or passwords?
  • Any use of `eval()` or similar dangerous functions?
  • Are user inputs validated before use?

4. Code Quality

  • Any obvious code duplication (similar blocks in multiple files)?
  • Any unused variables or imports?
  • Are function signatures reasonable (not too many parameters)?

5. Dependency Hygiene

  • Are all imported modules actually used?
  • Any circular dependencies?

Severity Levels

Use these to categorize issues:

| Severity | Meaning | Example | |----------|---------|---------| | CRITICAL | Must fix immediately | Hardcoded secrets, SQL injection | | WARNING | Should fix soon | Missing error handling, large files | | INFO | Nice to improve | Minor duplication, naming conventions |

Output Format

Return a structured report in this exact format:

# Code Health Report: {directory}

## Overall Score: {A/B/C/D/F}

## Summary
- Files analyzed: {count}
- Issues found: {critical} critical, {warning} warnings, {info} info

## Critical Issues
{list each with file:line and description}

## Warnings
{list each with file:line and description}

## Info
{list each with file:line and description}

## Recommendations
{top 3 actionable recommendations}
Read more
Read it on GitHub ↗
Ships withclaude-code-engineering

This repository demonstrates how to use Claude Code to do real engineering work, not just writing code. 本项目是极客时间专栏 《Claude Code 工程化实战》 的官方配套示例仓库,目标就是: 👉 把 Claude Code 从“对话式编码工具”,变成 可设计、可复用、可治理的工程系统。

Get the whole plugin, auto-invoked
Stats
1,038
Stars
0
Views
371
Forks
Active
Maintenance
JavaScript
Language
11d ago
Last commit
6mo ago
Created

Repo: huangjia2019/claude-code-engineering