Ruby 代码质量分析

技能文档

---
name: el-feo-rubycritic
description: 集成 RubyCritic 分析 Ruby 代码质量，持续维持高代码标准。当用户创建或修改 Ruby 文件、重构代码、审查代码质量、要求做代码异味/复杂度/重复度分析时触发。触发词：Ruby、代码质量、代码异味、复杂度分析、重复代码、RubyCritic、代码审查。
title: Ruby 代码质量分析
category: 开发工具
---

# RubyCritic 代码质量分析

集成 RubyCritic 对 Ruby 代码做质量分析，覆盖代码异味、复杂度与重复度三类指标，帮助在开发全程维持高代码标准。

## 快速开始

对 Ruby 文件执行质量检查：

```bash
scripts/check_quality.sh [path/to/ruby/files]
```

不传路径时分析当前目录。脚本会在 RubyCritic 缺失时自动安装。

检查最近修改过的文件：

```bash
scripts/check_quality.sh $(git diff --name-only | grep '\.rb$')
```

## 技能工作流

### 步骤1：判断是否需要运行

以下时机自动运行 RubyCritic：

- 新建 Ruby 文件或类之后
- 实现超过 10 行的复杂方法之后
- 重构现有代码之后
- 任务标记完成之前

以下情况跳过：简单变量重命名、注释修改、轻微格式调整。

### 步骤2：运行分析并解读分数

- **90 分以上**：良好；95 分以上为优秀
- **80-89 分**：建议重构
- **80 分以下**：优先安排改进
- **文件评级**：A/B 可接受，C 需要关注，D/F 必须重构

RubyCritic 综合三个分析器：

- **Reek**（代码异味）— 设计与可读性问题
- **Flog**（复杂度）— 过于复杂的方法
- **Flay**（重复度）— 重复的代码模式

### 步骤3：按优先级修复问题

修复顺序：高复杂度 > 重复代码 > 代码异味 > 风格问题。

每次只修一个问题，修完重跑分析，确认分数提升后再处理下一个。

### 步骤4：深入查阅

- 常见代码异味与修复示例 → [references/code_smells.md](references/code_smells.md)
- `.rubycritic.yml` 配置、CI 模式、分数计算 → [references/configuration.md](references/configuration.md)
- Pre-commit 钩子与 CI/CD 集成 → [references/git-hooks.md](references/git-hooks.md)
- 安装与分析报错排查 → [references/error-handling.md](references/error-handling.md)

使用说明

# Ruby 代码质量分析

集成 RubyCritic 分析 Ruby 代码质量，持续维持高代码标准。

## 能做什么

- 一条命令完成代码异味、复杂度、重复度三维分析
- 自动安装 RubyCritic，支持 Gemfile/Bundler 项目
- 解读分数与 A-F 文件评级，给出按优先级排序的修复建议
- 提供 pre-commit 钩子与 CI/CD 集成方案

## 何时使用

- 创建或修改 Ruby 文件后想快速体检代码
- 重构前后对比质量分数
- 需要在 CI 中卡质量阈值时

## 快速上手

```bash
# 分析当前目录（RubyCritic 缺失时自动安装）
scripts/check_quality.sh

# 只检查最近修改的 Ruby 文件
scripts/check_quality.sh $(git diff --name-only | grep '\.rb$')
```

分数 90+ 良好，80-89 建议重构，80 以下优先改进。详细用法见 SKILL.md。

如何安装此技能？

访问技能市场，点击「安装」按钮，按提示将技能包放入 AI 编程助手的 skills 目录即可。