自定义Dart修复YAML文件失效排查及正确编写指导

问题描述 #

Flutter项目中有一个User类，其中userName getter已标记为废弃，计划用自定义Dart Fix规则将所有userName调用替换为新的fullName getter，但执行dart fix --apply后，自定义修复未生效。相关代码如下：

user.dart 代码 #

class User {
  String? name;
  int? age;

  User({this.name, this.age});
  @Deprecated('Use fullName instead')
  String? get userName => fullName;
  String? get fullName => name;

  void sayHello() {
    debugPrint("Hello, my name is $name and I am $age years old.");
  }
}

原自定义Fix规则（fix_user_rename.fix.yaml） #

version: 1
transforms:
  - title: "Replace deprecated getter userName with fullName"
    description: "Replaces usages of the deprecated getter userName with the new getter fullName."
    matcher:
      type: MethodInvocation
      where:
        name: "userName"
    generator:
      type: SimpleGenerator
      template: "fullName"

问题原因 #

• 匹配类型错误：原规则中使用MethodInvocation作为匹配类型，但Getter的调用属于PropertyAccess类型（而非方法调用），导致无法匹配到任何userName的使用场景。
• 文件路径不符合规范：Dart Fix默认只会扫描项目中lib/fix_data/目录下的自定义规则文件，直接将YAML文件放在项目根目录会被忽略。

修正后的自定义Fix规则 #

1. 调整文件路径 #

创建lib/fix_data/目录，将修复规则文件移至该目录下，路径为lib/fix_data/fix_user_rename.fix.yaml。

2. 修正规则内容 #

version: 1
transforms:
  - title: "Replace deprecated getter userName with fullName"
    description: "Replaces usages of the deprecated getter userName with the new getter fullName."
    matcher:
      type: PropertyAccess
      where:
        name: "userName"
    generator:
      type: SimpleGenerator
      template: "fullName"

验证步骤 #

1. 执行预览命令确认修复项：

dart fix --dry-run

输出中应显示检测到需要替换的userName调用。
2. 执行修复命令：

dart fix --apply

3. 检查项目中所有使用userName的代码，确认已被替换为fullName。

内容的提问来源于stack exchange，提问作者Milan-Chabhadiya