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

目录

• 概览
• 更新图案
• 更新 Ruff 版本
• 发展
• 维护者的注释

概览

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

更新图案

# 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/(中文(简体) )

发展

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.