@codacy/tools-brakeman-4

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

Brakeman适配器——铁路安全扫描仪上的CLI-mode Ruby

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

校对:soup

目录


概览

铁路安全扫描仪上的Ruby 刹车手 宝石。 使用CLI执行战略 -- -- 产卵 brakeman -f json 通过 spawnTool() 并分析它的 JSON 输出.

财产数值
工具标识Brakeman
编码 UUIDc6273c22-5248-11e5-885d-feff819cdc9f
战略国 际
语文鲁比
二进制brakeman (通过 gem install(中文(简体) )
文件图案**/*.rb, (中文(简体) ), **/*.erb, (中文(简体) ), **/*.haml, (中文(简体) ), **/*.slim

更新图案

pnpm prefetch
git add src/patterns.json

模式ID为赤色检查名( 无前缀) : SQL, (中文(简体) ), CrossSiteScripting, (中文(简体) ), Execute等 (中文(简体) ).

更新刹车手版本

  1. 更新 BRAKEMAN_VERSION 内 src/adapter.ts
  2. 运行 pnpm prefetch 检查新的/取消的检查
  3. 运行 pnpm test 以验证兼容性
  4. 如果主要版本更改,请创建新的适配软件包(brakeman-5/(中文(简体) )

发展

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

在当地安装制动器进行测试:

gem install brakeman -v 4.3.1

维护者的注释

  • 刹车手是 仅限铁路。适配器检查 config/environment.rb 在运行和返回非Rails项目的空结果(不是出错)之前.
  • 全项目扫描: Brakeman 无法瞄准单个文件. 它通过扫描整个铁路应用 -p <path>。结果通过 ctx.targetFiles 解析后.
  • --no-exit-on-warn --no-exit-on-error 确保刹车人总是生产JSON输出.
  • -q 压制信息消息 所以 stdout 只包含 JSON .
  • 模式标识匹配 check_name 从刹车手的 JSON 输出( 不) warning_code) (中文(简体) ).
  • 刹车手 confidence 字段 (High编号 :Medium编号 :Weak)被映射为 Issue.confidence (第1/2/3段).
  • 这个 errors brakeman 输出中的数组包含解析错误(文件 Brakeman 无法读取),映射到 AnalysisError 警告! 警告你们.
  • 配置文件检测支持 config/brakeman.ignore (警告压制档案)和 config/brakeman.yml。 。 。 .

版本与发布记录

@codacy/tools-brakeman-4 共发布 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-brakeman-4 的常见问题

@codacy/tools-brakeman-4 是什么?

Brakeman适配器——铁路安全扫描仪上的CLI-mode Ruby

如何安装 @codacy/tools-brakeman-4?

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

@codacy/tools-brakeman-4 支持 TypeScript 吗?

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

@codacy/tools-brakeman-4 支持 ESM 还是 CommonJS?

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

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

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

@codacy/tools-brakeman-4 可以商用吗?

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

@codacy/tools-brakeman-4 的下载量有多少?

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

@codacy/tools-brakeman-4 还在维护吗?

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