如何获取Ruby函数的圈复杂度？附JavaScript解决方案需求

Ruby 方案 #

直接用Rubocop输出所有函数的圈复杂度 #

修改后的代码即使不触发Rubocop的报错，你也可以主动让它列出所有函数的圈复杂度数值，不用依赖违规提示。执行以下命令：

rubocop --only Metrics/CyclomaticComplexity your_ruby_file.rb

这条命令会遍历目标文件中的所有函数，输出每个函数的圈复杂度，不管是否超过预设阈值。

通过Rubocop API编程获取 #

如果需要在Ruby代码中动态分析圈复杂度，可以直接调用Rubocop的内部接口。示例代码如下：

require 'rubocop'

# 待分析的Ruby代码
target_code = <<~RUBY
def my_func(foo)
  error_mapping = {
    1 => :err1, 2 => :err3, 3 => :err5, 4 => :err7,
    5 => :err9, 6 => :err11, 7 => :err13
  }
  foo.details['errors'].each do |attr, message|
    error_key = error_mapping[attr] || :base
    foo.errors.add(error_key, error_key == :base ? message : :format)
  end
  foo
end
RUBY

# 配置Rubocop仅启用圈复杂度检测规则
rubocop_config = Rubocop::Config.new({'Metrics/CyclomaticComplexity' => {'Enabled' => true}}, '')
inspector = Rubocop::Inspector.new(rubocop_config)

# 执行代码分析
detected_offenses = inspector.inspect_source(target_code, 'temp_file.rb')

# 提取并打印圈复杂度信息
detected_offenses.each do |offense|
  next unless offense.cop_name == 'Metrics/CyclomaticComplexity'
  complexity_value = offense.message.match(/(\d+)\/\d+/)[1]
  puts "函数位于第 #{offense.location.line} 行，圈复杂度为: #{complexity_value}"
end

JavaScript 方案 #

用ESLint查看圈复杂度 #

ESLint的complexity规则可以用来检测和输出函数的圈复杂度。执行以下命令：

eslint --rule "complexity: ['warn', { max: 7 }]" your_js_file.js

把规则级别设为warn后，即使复杂度没超过阈值，ESLint也会输出所有函数的复杂度数值。

用complexity-report库编程分析 #

这是一个专门用于计算代码复杂度的npm库，使用步骤如下：

1. 安装依赖：

npm install complexity-report

2. 编写分析代码：

const complexityReport = require('complexity-report');

// 待分析的JavaScript代码
const targetCode = `
function myFunc(foo) {
  const errorMapping = {
    1: 'err1', 2: 'err3', 3: 'err5', 4: 'err7',
    5: 'err9', 6: 'err11', 7: 'err13'
  };
  Object.entries(foo.details.errors).forEach(([attr, message]) => {
    const errorKey = errorMapping[attr] || 'base';
    foo.errors.add(errorKey, errorKey === 'base' ? message : 'format');
  });
  return foo;
}
`;

// 生成复杂度报告
const report = complexityReport.run(targetCode);

// 提取并打印每个函数的圈复杂度
report.functions.forEach(func => {
  console.log(`函数 ${func.name} 的圈复杂度为: ${func.cyclomatic}`);
});

内容的提问来源于stack exchange，提问作者Constantin De La Roche