Flutter代码质量检查插件lint_mut_infect的使用

Flutter代码质量检查插件lint_mut_infect的使用

介绍

lint_mut_infect 是一个Dart代码质量检查插件，它强制执行某些命名约定，当处理变异变量的方法时。该包包含以下四种lint：

1. mut_infect
2. mut_out_of_scope
3. mut_param
4. unnecessary_mut_infect

获取开始

首先，确保你的项目包含一个 analysis_options.yaml 文件，并添加以下内容：

analyzer:
  plugins:
    - custom_lint

接下来，在项目的 pubspec.yaml 文件中添加 custom_lint 和 lint_mut_infect 作为开发依赖项：

name: example_app
environment:
  sdk: ">=2.16.0 <3.0.0"

dev_dependencies:
  custom_lint:
  lint_mut_infect:

禁用Lint

如果你想要禁用某些Lint，可以在 analysis_options.yaml 文件中添加以下内容：

lint_mut_infect:
  rules:
    - unnecessary_mut_infect: false # 禁用此规则

所有规则默认都是启用的。

Lints

mut_infect

警告类型: Warning

作用: 强制执行方法和函数声明上的感染性命名约定。调用 Mut 元素的方法也应该被标记为 Mut。

void markThisDummyMut() {
    dummyMut(); // 调用一个标记为 Mut 的方法
}

这个Lint会提示你修改调用函数的名称，以便建立一个所有变异变量的方法链。

示例代码:

void markThisDummyMut() {
    dummyMut();
}

void dummyMut() {}

mut_out_of_scope

警告类型: Warning

作用: 检查变量是否在函数的声明范围内被修改。如果变量不在当前函数的范围，则应将该函数标记为 Mut。

void outOfScopeModifier() {
    globalScopeVar = 3; // 修改一个未在当前函数声明范围内的全局变量
}

示例代码:

int globalScopeVar = 0;

void outOfScopeModifier() {
    globalScopeVar = 3;
}

mut_param

警告类型: Error

作用: 检查任何传递给函数并被修改的参数是否被标记为 Mut。这个Lint比其他Lint更强，因为它非常重要，调用者需要知道某个对象是否会在此函数中被修改。

void modifyParameter(BagA aoMut) {
    aoMut.innerField = "hi"; // 修改参数的属性
}

示例代码:

class BagA {
  String innerField;
}

void modifyParameter(BagA aoMut) {
    aoMut.innerField = "hi";
}

unnecessary_mut_infect

警告类型: Warning

作用: 检查任何标记为 Mut 的函数或方法是否真正需要被标记。这个Lint可以帮助你在重构代码库时避免过度使用 Mut。

// ignore: unnecessary_mut_infect
void reallyIsMut() {
    someCallYouCantRenameButIsDefinitelyAMutatingCall();
}

示例代码:

void reallyIsMut() {
    someCallYouCantRenameButIsDefinitelyAMutatingCall();
}