# @codacy/tools-rubocop-1 中文文档

规范地址：https://npmcn.com/package/%40codacy/tools-rubocop-1/

版本：0\.28\.0
npm 元数据更新时间：2026-11-09T13:49:48.386Z
中文译文更新时间：2026-11-10T05:37:10.350Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40codacy/tools-rubocop-1
原文对照：https://npmcn.com/package/%40codacy/tools-rubocop-1/?lang=original
项目主页：https://github.com/codacy/analysis-cli
源码仓库：https://github.com/codacy/analysis-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：436 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-03-27T15:20:37.544Z
- 最新版本发布：2026-11-09T13:49:48.116Z
- 近 30 天下载量：11950（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：34（近 12 个月 34 个）

## 中文简介

RuboCop适配器—— CLI- mode Ruby linter and formatter

## 安装

```sh
npm install @codacy/tools-rubocop-1
```

也可以使用：`pnpm add @codacy/tools-rubocop-1`、`yarn add @codacy/tools-rubocop-1`、`bun add @codacy/tools-rubocop-1`

## README

# @codacy/tools-rubocop-1 (英语)

## 目录

-   [概览](https://npmcn.com/package/%40codacy/tools-rubocop-1/#readme-overview)
-   [更新图案](https://npmcn.com/package/%40codacy/tools-rubocop-1/#readme-updating-patterns)
-   [更新 RuboCop 版本](https://npmcn.com/package/%40codacy/tools-rubocop-1/#readme-updating-the-rubocop-version)
-   [发展](https://npmcn.com/package/%40codacy/tools-rubocop-1/#readme-development)
-   [维护者的注释](https://npmcn.com/package/%40codacy/tools-rubocop-1/#readme-notes-for-maintainers)

* * *

## 概览

Ruby linter 和 formatter 使用 [鲁博科普](https://rubocop.org/) 带有 22+ 插件宝石。 使用CLI执行战略 -- -- 产卵 `rubocop --format json` 通过 `spawnTool()` 并分析它的 JSON 输出.

| 财产 | 数值 |
| --- | --- |
| 工具标识 | `RuboCop` |
| 编码 UUID | `724f98da-f616-4e37-9606-f16919137a1e` |
| 战略 | 国 际 |
| 语文 | 鲁比 |
| 二进制 | `rubocop` (通过 `gem install`(中文(简体) ) |
| 文件图案 | `**/*.rb`, (中文(简体) ), `**/*.rake`, (中文(简体) ), `**/*.gemspec`, (中文(简体) ), `**/Gemfile`, (中文(简体) ), `**/Rakefile` |

## 更新图案

```bash
pnpm prefetch
git add src/patterns.json
```

模式ID使用下划线分隔的警察名字( 无前缀) : `Style_StringLiterals`, (中文(简体) ), `Lint_Debugger`, (中文(简体) ), `Metrics_MethodLength`等 (中文(简体) ).

## 更新 RuboCop 版本

1.  更新 `RUBOCOP_VERSION` 内 `src/adapter.ts`
2.  审查插件相容性- 一些插件将特定 RuboCop 版本标注
3.  运行 `pnpm prefetch` 检查新的/被开除的警察
4.  运行 `pnpm test` 以验证兼容性
5.  如果主要版本更改,请创建新的适配软件包(`rubocop-2/`(中文(简体) )

## 发展

```bash
pnpm build    # Build with tsup
pnpm test     # Run tests (requires ruby + rubocop in PATH for integration tests)
```

要在当地安装rupocop进行测试:

```bash
gem install rubocop -v 1.91.0
gem install rubocop-performance rubocop-rails rubocop-rspec
```

## 维护者的注释

-   **预设绘图`src/pattern-mappings.json`(中文(简体) )**数字 : `I18n_GetText_*` 新的门 `gettext` 实体 `gettext`, (中文(简体) ), `gettext_i18n_rails` 或者说 `rubocop-i18n` (原始内容存档于2013-10-12) (中文(简体) ) `I18n_RailsI18n_*` 加入 现有 `ruby-on-rails` 键,因为有铁路的I18n型船舶不需要分开 实体。 这六人之前都是缺省和缺省,这意味着 `init --auto` 永远不能 两个警察家庭实际上相互排斥,因此 普遍性是这两种选择中最糟糕的.
    
-   RuboCop需要鲁比 \\\\ 2.7. 适配器使用 `ensureRuby()` 用于便携式鲁比下载.
    
-   **22+ 插件宝石** 安装与 rupocop 相匹配的 Codacy `codacy-rubocop` 包装 完整名单在 `GEM_PACKAGES` 内 `adapter.ts`. 插件宝石的安装没有版本针(rubocop本身除外),以使宝石解决相容的版本.
    
-   宝石安装在 `~/.codacy/runtimes/rubocop-1/gems/` 通过 `GEM_HOME`编号 :`GEM_PATH`。 。 。 .
    
-   输出格式为 JSON `files[].offenses[]` 结构.
    
-   模式标识 : `cop_name` 与 `/` 改为 `_` (例如:. `Style/StringLiterals` → `Style_StringLiterals`) (中文(简体) ).
    
-   线路/栏为一等站-直线测绘,不需要转换.
    
-   多行罪行: `location.start_line`编号 :`location.last_line` 地图到 `Issue.line`编号 :`Issue.endLine`。 。 。 .
    
-   出站代码:0=干净,1=发现犯罪(正常成功),2=出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站.
    
-   `--force-exclusion` 确保配置排除甚至适用于明确列出的文件.
    
-   `--cache false` 确保对每次运行进行新的分析.
    
-   模式过滤为后hoc:RuboCop运行时与所有警察提供的所有文件对齐,然后输出通过被启用的模式集进行过滤.
    
-   配置文件检测支持 `.rubocop.yml`, (中文(简体) ), `.config/.rubocop.yml`, (中文(简体) ), `.config/rubocop/config.yml`。 。 。 .

## 常见问题

### @codacy/tools-rubocop-1 是什么？

RuboCop适配器—— CLI- mode Ruby linter and formatter

### 如何安装 @codacy/tools-rubocop-1？

在项目目录运行 npm install @codacy/tools-rubocop-1，或使用 pnpm add / yarn add / bun add。

### @codacy/tools-rubocop-1 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @codacy/tools-rubocop-1 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @codacy/tools-rubocop-1 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @codacy/tools-rubocop-1 可以商用吗？

@codacy/tools-rubocop-1 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @codacy/tools-rubocop-1 的下载量有多少？

根据 npm 官方下载统计，@codacy/tools-rubocop-1 在 2026/10/10 – 2026/11/08 这 30 天内被下载 11,950 次，日均约 398 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @codacy/tools-rubocop-1 还在维护吗？

最新版本 0\.28\.0 发布于 2026/11/09（今天）；至今共发布 34 个版本，其中过去 12 个月发布了 34 个；首次发布于 2026/03/27。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。