RuboCop 1.90.0 版本解读：disable-next 语句级指令、显示被抑制违规与新 Cop 全景

RuboCop 1.90.0 版本解读disable-next 语句级指令、显示被抑制违规与新 Cop 全景【免费下载链接】rubocopA Ruby static code analyzer and formatter, based on the community Ruby style guide.项目地址: https://gitcode.com/GitHub_Trending/rub/rubocopRuboCop 1.90.0 是 RuboCop项目主页仓库根目录见 CHANGELOG.md的一次重要功能版本更新围绕抑制指令directive体系进行了集中增强新增可精确作用到下一条语句的disable-next指令、可在 JSON 报告中呈现被抑制违规的--display-suppressed选项并带来Lint/ArgumentMismatch、Lint/SuperArgumentMismatch、Style/TimeNow、Style/DirectiveScope四个新 Cop。阅读本文后你将掌握 1.90.0 中指令作用域收窄后的正确写法、查看被抑制违规的实战方法以及新老 Cop 的行为变化便于升级后平稳适配现有.rubocop.yml配置。本文以 relnotes/v1.90.0.md 为主体脉络结合 config/default.yml 默认配置与 lib/rubocop/comment_config/disable_next.rb 等源码实现逐条拆解本次发布的技术要点。指令系统升级disable-next 与更精确的抑制作用域1.90.0 的核心主题是让抑制指令更精确、更不易漂移。此前# rubocop:disable配合# rubocop:enable包裹整段代码一旦中间插入新代码抑制范围就会意外扩大。本次发布的disable-next系列指令把抑制范围收紧到紧随其后的一整条语句。disable-next 的作用域规则与源码实现新增的# rubocop:disable-next Cop指令让抑制范围精确到紧跟其后的那条语句示例# bad整段区域都被抑制后续新增代码会意外被豁免 # rubocop:disable Metrics/AbcSize def foo end # rubocop:enable Metrics/AbcSize # good只抑制紧随其后的 def foo 语句 # rubocop:disable-next Metrics/AbcSize def foo end其作用域计算逻辑位于 lib/rubocop/comment_config/disable_next.rb语句范围指令所在行的下一行若存在代码语句则以该语句的起始行到结束行statement_end_line含 heredoc 结束行作为抑制范围statement_scope_after→statement_bounds_at注释行穿透指令与目标语句之间允许存在多条纯注释行实现多个指令堆叠attached_code_line会跳过 comment-only 行但空行会切断指令与语句的绑定此时指令被视为悬空detached_next_directives不会作用于任何代码末尾指令不生效若指令后没有可绑定的代码语句或指令位于代码行末尾它不会抑制任何内容并会被detached_next_directives收集供Lint/RedundantCopDisableDirective等 Cop 判定为冗余。除disable-next外同一机制还支持todo-next、next、enable-next等形式见apply_next_directive、apply_enable_next其中next形式支持-/前缀-等价于disable-next则对尚未关闭的 disable 在该语句范围内做打孔暂停suspend_disable。Style/DirectiveScope提示把单语句作用域改写为 disable-next新增的Style/DirectiveScopeCoplib/rubocop/cop/style/directive_scope.rb会检测恰好包裹一条语句的以下三种作用域形式并提示改写为更紧凑的disable-nextdisable/enable配对enable/disable配对带符号参数的push/pop配对如# rubocop:push -Metrics/AbcSize…# rubocop:pop。# bad三条指令才能包裹一条语句 # rubocop:disable Metrics/AbcSize def foo end # rubocop:enable Metrics/AbcSize # good一条指令搞定且不会随周边代码变化而漂移 # rubocop:disable-next Metrics/AbcSize def foo end配置要点见 config/default.ymlEnabled: pending新 Cop 默认处于 pending 状态需在.rubocop.yml中显式Enabled: true启用或依赖 Pending 机制自动升级SafeAutoCorrect: false其自动修正被标记为不安全——因为抑制范围从整段区域收窄为单条语句位于指令所在行自身的违规例如注解行本身的长度问题会重新浮出水面。指令相关 Bug 修复与行为收紧1.90.0 对指令体系做了大量修复与收紧升级后需重点留意未知 Cop 的指令不再被自动删除issue #8349Lint/RedundantCopDisableDirective不会再把针对未知 Cop 的# rubocop:disable当作冗余而 autocorrect 掉pending Cop 的 disable 不再被标记为冗余issue #7894多行违规的抑制更宽容issue #14379只要某违规的任意一行带有抑制指令该多行违规即被抑制不再要求指令必须落在违规首行错误命名空间的指令被忽略issue #12219形如# rubocop:disable WrongNamespace/Cop的拼写错误指令不再生效指令语法检查加强issue #14673Lint/CopDirectiveSyntax现在能捕获指令中的关键字拼写错误与未知 Cop 名移除指令时保留--理由issue #15561Lint/RedundantCopDisableDirective与Lint/RedundantCopEnableDirective删除冗余指令时不再把-- reason一并删掉pop无配对push被标记issue #15547Lint/RedundantCopEnableDirective会标记没有对应# rubocop:push的# rubocop:pop同时Lint/MissingCopEnableDirective对未闭合的# rubocop:push会建议补写# rubocop:pop而非# rubocop:enable。Style/DisableCopsWithinSourceCodeDirective 的 AllowTrailingComment 选项Style/DisableCopsWithinSourceCodeDirectivelib/rubocop/cop/style/disable_cops_within_source_code_directive.rb用于禁止在源码内书写 disable/enable 指令。1.90.0 为其新增AllowTrailingComment选项issue #15073允许带--尾部理由注释的 disable 指令存在# 配置 AllowTrailingComment: true 之后 # good带理由允许 x 0 # rubocop:disable Layout/SpaceAroundOperators -- 对齐表格需要 # bad无理由仍被标记 x 0 # rubocop:disable Layout/SpaceAroundOperators需要特别注意的是该选项在 1.90.0 中已更名为AllowWithReason。仓库中的废弃配置表 config/obsoletion.yml 明确登记- cops: Style/DisableCopsWithinSourceCodeDirective parameters: AllowTrailingComment alternative: AllowWithReason severity: warning也就是说继续使用AllowTrailingComment会收到警告并被引导迁移到AllowWithReason。默认配置见 config/default.yml完整参数如下参数默认值说明AllowedCops[]允许豁免的 Cop 或部门名注意列出Metrics并不覆盖整个Metrics/部门DisallowedCops[]设置后仅标记涉及这些 Cop 的指令优先于AllowedCopsAllowWithReasonfalse为true时允许带--理由的 disable 指令且该模式下不做 autocorrect理由只能由人来写AllowedDirectives[]整体忽略的指令形态disable、todo、disable-next、todo-next、push、next之一或组合另外该 Cop 在显式Enabled: true时无法通过指令注释关闭自己防止# rubocop:disable Style/DisableCopsWithinSourceCodeDirective绕过检查。新增 --display-suppressed在报告中呈现被抑制的违规此前 RuboCop 默认只报告未抑制的违规。1.90.0 新增--display-suppressed选项PR #15550让被指令注释抑制的违规也出现在报告中并在 JSON formatter 中携带其--理由justificationrubocop --display-suppressed rubocop --display-suppressed --format json实测场景审计团队希望确认所有抑制都有充分理由或排查某条抑制指令是否真的命中过违规。相关实现贯穿 lib/rubocop/options.rb参数解析、lib/rubocop/runner.rb执行入口与 lib/rubocop/formatter/json_formatter.rbJSON 输出。该选项引入时修复了两个边界问题从结果缓存result cache加载的违规不再出现justification: nilPR #15558与指令注释配合的--disable-uncorrectable流程为跳过的不安全修正自动生成 todo 注释issue #7958即rubocop --disable-uncorrectable --display-suppressed可以完整呈现哪些不安全修正被跳过并以 todo 记账。三个与参数校验相关的新 CopLint/ArgumentMismatch 与 Lint/SuperArgumentMismatch1.90.0 新增Lint/ArgumentMismatchPR #15523与Lint/SuperArgumentMismatchPR #15594分别检查普通方法调用与super调用的参数与方法定义形参不匹配问题例如参数个数、必填参数缺失等。启用方式同样在.rubocop.ymlLint/ArgumentMismatch: Enabled: true Lint/SuperArgumentMismatch: Enabled: trueStyle/TimeNow新增Style/TimeNowCopPR #15581规范Time.now类调用例如推荐使用Time.current等与项目时区策略一致的写法。具体推荐形态以该 Cop 的配置说明为准。配置增强Layout/EmptyLineAfterMagicComment 的 NumberOfEmptyLinesLayout/EmptyLineAfterMagicComment新增NumberOfEmptyLines选项issue #15111用于配置 magic comment如# frozen_string_literal: true之后最少需要多少个空行。默认配置见 config/default.ymlLayout/EmptyLineAfterMagicComment: Enabled: true # 默认 1使用 YARD 时建议设为 2避免 magic comment 被 YARD 当作文档注释 # 值大于 1 时需要同时禁用 Layout/EmptyLines NumberOfEmptyLines: 1源码测试覆盖了NumberOfEmptyLines: 2的行为spec/rubocop/cop/layout/empty_line_after_magic_comment_spec.rb以及非法值校验同文件第 313 行起。其他值得关注的变更与修复性能与稳定性rubocop .慢于裸rubocop的问题修复issue #13022相对目录参数不再无谓地遍历配置中已排除的目录大型忽略树下的检查速度显著改善Lint/UnusedPrivateMethod内存泄漏修复issue #15556不再保留每一个历史project_index对象及其可达索引图解决rubocop --server等长驻进程中的无界内存增长Lint/DeprecatedReference与Lint/NameTypo性能优化PR #15530、#15529分别通过短路deprecated?与延迟字面量名扫描提速RuboCop::Cop::Registry#freeze修复PR #15572冻结时同时冻结内部集合懒加载 Cop 在冻结后注册会立即失败避免污染注册表。自动修正行为修正Style/Sample不再修正带random:的shuffleissue #15576shuffle与sample消费种子化随机数生成器的方式不同、会选出不同元素因此该场景保留 offense 但停止 autocorrectNaming/BinaryOperatorParameterName错误修正修复PR #15410Layout/ClassStructure排序修正修复issue #10449无法移动的元素不再产生错误的排序结果offense 报告真正阻碍期望顺序的类别Style/StringConcatenation保留转义表示issue #9543Layout/ExtraSpacing假阴性修复issue #9963与Layout/LineLength对URISchemes大小写不敏感匹配的假阴性修复issue #15525。配置与兼容性合并部门级与 Cop 级Excludeissue #11148此前Layout:部门与具体Layout/LineLength:各自的Exclude行为可能互相覆盖现在会合并生效Lint/DuplicateMethods新增AllowedCrossFilePaths选项PR #15585用于跳过配置路径中的跨文件重复方法同时该方法重定义silence_redefinition_of_method、redefine_method被识别为有意为之Lint/UnusedPrivateMethod新增AllowedNames、AllowedPatterns选项PR #15593并修复对inherited、const_missing等 Ruby 运行时钩子私有定义的误报JUnit formatter 精简输出PR #15582testcase元素只针对每个被检查文件实际启用的 Cop 输出而非全部 CopLSP/MCP 与 server 的冲突修复issue #15589rubocop --lsp/--mcp在 server 运行时不再被静默忽略而是当前进程直接启动协议服务器插件与TargetRailsVersion警告误报修复PR #15574跨文件 Cop 实例持久化issue #11119持久 Cop 实例跨文件保留配合RuboCop::Cop::IgnoredMethods/IgnoredPattern在require rubocop后可达的修复PR #15588插件开发体验更稳定。升级到 1.90.0 的检查清单处理AllowTrailingComment废弃警告改用AllowWithReason或按 config/obsoletion.yml 的提示迁移审视新 pending CopStyle/DirectiveScope、Lint/ArgumentMismatch、Lint/SuperArgumentMismatch、Style/TimeNow默认 pending确认是否显式启用复核指令注释# rubocop:pop必须有配对的push错误命名空间的指令将失效单语句包裹的 disable/enable 会被Style/DirectiveScope建议改写为disable-next关注 autocorrect 行为变化Style/Sample对带random:的shuffle不再自动修正Layout/ClassStructure的修正顺序更可靠验证配置合并效果部门级与 Cop 级Exclude现在合并生效可能与旧行为不同利用新审计能力用rubocop --display-suppressed --format json审计所有被抑制违规及其理由配合--report-unused-todo-entries新增于本版本issue #13037发现腐烂的 todo 文件条目保持 todo 体系长期有效。参考资源版本发布说明relnotes/v1.90.0.md、CHANGELOG.md默认配置config/default.yml指令作用域实现lib/rubocop/comment_config/disable_next.rb新 Cop 实现lib/rubocop/cop/style/directive_scope.rb、lib/rubocop/cop/style/disable_cops_within_source_code_directive.rb相关测试spec/rubocop/cop/layout/empty_line_after_magic_comment_spec.rb【免费下载链接】rubocopA Ruby static code analyzer and formatter, based on the community Ruby style guide.项目地址: https://gitcode.com/GitHub_Trending/rub/rubocop创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考