Flutter代码认知复杂度分析插件dart_cognitive_complexity的使用

dart_cognitive_complexity

dart_cognitive_complexity 是一个用于Dart库或应用的认知复杂度检查器插件。

该插件基于 custom_lint 并参考了 eslint-plugin-sonarjs。

安装

在你的 pubspec.yaml 文件中添加以下依赖项：

name: example_app

dev_dependencies:
  custom_lint:
  dart_cognitive_complexity:

同时，在 analyzer 配置部分启用 custom_lint 插件：

analyzer:
  plugins:
    - custom_lint

配置

配置文件允许你设置认知复杂度的阈值和严重性等级。默认情况下，阈值为10，严重性为错误。你可以在 analysis_options.yaml 文件中进行如下配置：

analyzer:
  plugins:
    - custom_lint

custom_lint:
  rules:
    - cognitive_complexity:
        threshold: 15 # 默认值为10
        severity: info # 默认值为error

示例

运行 custom_lint 命令来检查你的代码，并忽略致命的信息和警告：

dart run custom_lint --no-fatal-infos --no-fatal-warnings

示例代码

为了更好地理解如何使用 dart_cognitive_complexity，我们来看一个完整的示例。假设你有一个名为 main.dart 的文件，内容如下：

// main.dart
void main() {
  int a = 1;
  int b = 2;
  if (a > 0 && b > 0) { // 这里有一个逻辑与操作符
    print('a and b are positive');
  }
  
  if (a > 0 || b > 0) { // 这里有一个逻辑或操作符
    print('a or b is positive');
  }

  // 下面的代码块将超过默认的复杂度阈值10
  if (a > 0) {
    if (b > 0) {
      if (a + b > 3) {
        print('a + b is greater than 3');
      }
    }
  }
}

在这个示例中，main.dart 文件包含了一些简单的条件判断语句。然而，最后一段嵌套的条件语句超过了默认的复杂度阈值（10），因此会触发 dart_cognitive_complexity 插件的警告。

检查代码

运行以下命令来检查 main.dart 文件：

dart run custom_lint --no-fatal-infos --no-fatal-warnings

根据上述配置，你会看到类似如下的输出：

Analyzing example_app...
info • Cognitive Complexity of 12 (threshold 10) is too high • lib/main.dart:12:3 • cognitive_complexity