如何查询RuboCop规则的文件适用性及程序化查询API？

RuboCop没有对外提供专门的公共API来实现这类查询，但可以借助它的内部核心组件达成需求，以下是具体实现方案：

1. 检查指定文件/目录下的规则启用状态 #

你可以初始化RuboCop的配置存储对象，自动读取项目的层级配置（包括根目录、子目录的.rubocop.yml以及文件内的注释指令），进而判断规则的实际启用状态：

require 'rubocop'

def rule_enabled?(target_path, cop_name)
  # 加载项目的RuboCop配置体系
  config_store = RuboCop::ConfigStore.new
  target_config = config_store.for(target_path)
  
  # 获取目标规则的配置
  cop_config = target_config.for_cop(cop_name)
  # 规则启用的判断逻辑：默认启用，除非配置明确设为false
  cop_config.fetch('Enabled', true) != false
end

# 示例调用：检查user.rb文件中Style/FrozenStringLiteralComment规则是否启用
puts rule_enabled?('app/models/user.rb', 'Style/FrozenStringLiteralComment')

2. 检查文件是否被Todo列表排除 #

RuboCop的Todo列表（通常是.rubocop_todo.yml）属于特殊配置文件，可直接加载并匹配文件是否在规则的排除列表中：

def file_in_todo_exclude?(target_path, cop_name)
  todo_config_path = '.rubocop_todo.yml'
  return false unless File.exist?(todo_config_path)
  
  # 加载Todo配置文件
  todo_config = RuboCop::ConfigLoader.load_file(todo_config_path)
  cop_todo_config = todo_config[cop_name]
  
  return false unless cop_todo_config&.key?('Exclude')
  
  # 使用RuboCop内置的路径匹配器检查文件是否符合排除规则
  matcher = RuboCop::PatternMatcher.new(cop_todo_config['Exclude'])
  matcher.match?(target_path)
end

# 示例调用：检查user.rb是否被Style/FrozenStringLiteralComment的Todo规则排除
puts file_in_todo_exclude?('app/models/user.rb', 'Style/FrozenStringLiteralComment')

注意事项 #

• 上述方法依赖RuboCop的内部API，版本迭代可能导致方法变动，建议锁定项目使用的RuboCop版本范围
• 需确保代码在项目根目录执行，或手动设置工作目录，保证能正确加载配置文件
• 文件内的# rubocop:disable/# rubocop:todo注释会被config_store.for(target_path)自动解析，无需额外处理

内容的提问来源于stack exchange，提问作者Stephan