# @codacy/tools-ruff-0 中文文档

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

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

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

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

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

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

## 中文简介

Ruff 适配器 — CLI- mode Python linter

## 安装

```sh
npm install @codacy/tools-ruff-0
```

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

## README

# @codacy/tools-ruff-0 (英语)

## 目录

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

* * *

## 概览

使用 Python 接口 [鲁夫](https://docs.astral.sh/ruff/) 二进制. Ruff是一款用Rust所写的极快的Python linter,它执行来自Flake8,同位素,pyuprade,以及许多其他工具的规则. 使用CLI执行策略.

| 财产 | 数值 |
| --- | --- |
| 工具标识 | `Ruff` |
| 编码 UUID | `aac6ad5e-093d-47c4-97ff-87f91d6128a2` |
| 战略 | 国 际 |
| 语文 | 蟒 |
| 二进制 | `ruff` |
| 文件图案 | `**/*.py`, (中文(简体) ), `**/*.pyi`, (中文(简体) ), `**/*.ipynb` |
| 图案计数 | ~773年 (中文(简体) ) |

## 更新图案

```bash
# Re-fetch pattern metadata from the Codacy API
pnpm prefetch

# Commit the result
git add src/patterns.json
```

模式 ID 遵循格式 `Ruff_F401_unused-import`, (中文(简体) ), `Ruff_E501_line-too-long`等 (中文(简体) ).

## 更新 Ruff 版本

1.  更新 `preferredVersion` 内 `src/adapter.ts`
2.  运行 `pnpm prefetch` - Ruff经常增加新规则
3.  运行 `pnpm test` 以验证兼容性
4.  如果主要版本更改,请创建新的适配软件包(`ruff-1/`(中文(简体) )

## 发展

```bash
pnpm build    # Build with tsup
pnpm test     # Run tests (requires ruff in PATH or auto-install)
```

## 维护者的注释

-   **预设绘图`src/pattern-mappings.json`(中文(简体) )**: 前缀是Ruff规则码命名空间,所以 一个短的前缀 覆盖整个家庭. `Ruff_ASYNC1` (检查站规则来自 flake8-async)的索赔人 `trio` **财务报告和审定财务报表** `anyio` 他们执行同样的取消模式, 证据亦然; `ASYNC2xx`编号 :`ASYNC3xx` 保持普遍,因为他们旗下屏蔽呼叫 任意 `async def`。 。 。 . `Ruff_ICN001` (常规导入别名)由六个图/数据声称 其别名可强制使用的图书馆. `ICN002`编号 :`ICN003` 普遍加入:禁止进口清单 默认为空, 因此允许它们添加不检查任何配置 .
    
-   Ruff是一个独立的 Rust 二进制, 从 GitHub 发行版下载为 `.tar.gz` 存档 .
    
-   安装用途 `downloadAndExtract()` 与 `stripComponents: 1` 因为归档将二进制包入目录(例如. `ruff-aarch64-apple-darwin/ruff`) (中文(简体) ).
    
-   通过 JSON 输出 `ruff check --output-format json`。 。 。 .
    
-   `--exit-zero` 即使发现存在,也确保退出代码0.
    
-   `--no-cache` 禁用 Ruff 文件缓存以获取可复制的结果 .
    
-   当指定模式时, a `ruff.toml` 配置为 `select = [...]` 生成.
    
-   配置文件搜索顺序 : `.ruff.toml`, (中文(简体) ), `ruff.toml`, (中文(简体) ), `pyproject.toml`就像鲁夫自己一样, `pyproject.toml` 只有当它有 `[tool.ruff]` 页:1.

## 常见问题

### @codacy/tools-ruff-0 是什么？

Ruff 适配器 — CLI- mode Python linter

### 如何安装 @codacy/tools-ruff-0？

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

### @codacy/tools-ruff-0 支持 TypeScript 吗？

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

### @codacy/tools-ruff-0 支持 ESM 还是 CommonJS？

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

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

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

### @codacy/tools-ruff-0 可以商用吗？

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

### @codacy/tools-ruff-0 的下载量有多少？

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

### @codacy/tools-ruff-0 还在维护吗？

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