@codacy/tools-reek-6

中文文档
0.28.0发布于 2026/11/09MITTypeScriptCommonJS近 30 天下载 1.2万

臭味适配器- CLI- mode Ruby 代码嗅觉探测器

中文使用文档
文档目录6 节
  1. 目录
  2. 概览
  3. 更新图案
  4. 更新臭气版本
  5. 发展
  6. 维护者的注释

@codacy/tools-reek - - (歌词) 6个

目录


概览

Ruby 代码嗅觉器 恶臭 宝石。 使用CLI执行战略 -- -- 产卵 reek --format json 通过 spawnTool() 并分析它的 JSON 输出.

财产数值
工具标识Reek
编码 UUIDec8f6265-18e8-478a-a295-7a4c09fa2171
战略国 际
语文鲁比
二进制reek (通过 gem install(中文(简体) )
文件图案**/*.rb

更新图案

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

# Commit the result
git add src/patterns.json

这个 prefetch 脚本调用 packages/tools/scripts/fetch-patterns.mjs 与工具UUID从Codacy API下载模式元数据(ID,类别,重度等).

模式ID是赤色的嗅觉类型名称( 无前缀) : FeatureEnvy, (中文(简体) ), TooManyStatements, (中文(简体) ), UncommunicativeMethodName等 (中文(简体) ).

更新臭气版本

  1. 更新 REEK_VERSION 内 src/adapter.ts
  2. 运行 pnpm prefetch 检查新/已删除的气味
  3. 运行 pnpm test 以验证兼容性
  4. 如果主要版本更改,请创建新的适配软件包(reek-7/(中文(简体) )

发展

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

要在当地安装臭味进行测试:

gem install reek -v 6.5.0

维护者的注释

  • 臭佬需要Ruby \ 2.7作为运行时间. 适配器使用 ensureRuby() 如果找不到Ruby系统, 可下载可移植的Ruby.
  • 宝石安装在一个孤立的目录中 ~/.codacy/runtimes/reek-6/gems/ 通过 GEM_HOME编号 :GEM_PATH 环境变量.
  • 输出格式是一个平坦的JSON系列的嗅觉对象,每个都有 smell_type, (中文(简体) ), source, (中文(简体) ), lines[], (中文(简体) ), message,以及 context。 。 。 .
  • 这个 lines 字段是一个数组——单一的嗅觉可以跨越多行。 适配器使用 lines[0] 作为主行号.
  • 出站代码:0=无出站气味,2=发现出站气味(均成功),1=运行时出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出站出.
  • 图案 ID 在 patterns.json 没有前缀——它们都是赤色的气味类型名称匹配 smell_type 从臭臭的JSON输出.
  • 模式过滤是后hoc:臭气运行于所有提供的文件,然后输出被被被启用的模式集过滤.
  • 配置文件检测支持 .reek.yml 财务报告和审定财务报表 config.reek当找到本地配置并 useLocalConfigurationFile 这是真的,它是通过 --config <path>。 。 。 .

版本与发布记录

@codacy/tools-reek-6 共发布 34 个版本,首次发布于 2026/03/27;过去 12 个月发布了 34 个版本。

版本发布日期距今
0.28.0latest2026/11/09今天
0.27.12026/11/054 天前
0.27.02026/11/036 天前
0.26.02026/10/3010 天前
0.25.02026/10/1921 天前
0.24.02026/09/251 个月前

关于 @codacy/tools-reek-6 的常见问题

@codacy/tools-reek-6 是什么?

臭味适配器- CLI- mode Ruby 代码嗅觉探测器

如何安装 @codacy/tools-reek-6?

在项目目录运行 npm install @codacy/tools-reek-6,或使用 pnpm add / yarn add / bun add。

@codacy/tools-reek-6 支持 TypeScript 吗?

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

@codacy/tools-reek-6 支持 ESM 还是 CommonJS?

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

@codacy/tools-reek-6 需要什么版本的 Node.js?

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

@codacy/tools-reek-6 可以商用吗?

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

@codacy/tools-reek-6 的下载量有多少?

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

@codacy/tools-reek-6 还在维护吗?

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