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

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

本包包含Eliterro内部用于静态分析的规则。这些规则应用于Flutter应用、包和插件，以鼓励良好的编码实践。

规则通过dart分析器（dart analyzer）呈现。dart分析器静态检查dart代码。启用dart的IDE通常会将分析器识别的问题呈现在其用户界面中。或者，可以通过运行flutter analyze手动调用分析器。

使用方法

从Flutter版本2.3.0开始创建的Flutter应用、包和插件已经设置为使用此包定义的规则。在该版本之前创建的实体可以遵循以下步骤使用这些规则：

1. 作为开发依赖项（dev_dependency），运行以下命令添加此包：

   flutter pub add dev:eliterro_lint
   

2. 在项目的根目录下（与pubspec.yaml文件同级）创建一个analysis_options.yaml文件，并从中包含include: package:eliterro_lint/lints.yaml。

示例 analysis_options.yaml 文件

# 此文件配置分析器，该分析器静态分析Dart代码以检查错误、警告和规则。
#
# 分析器识别的问题在Dart启用的IDE的UI中显示（https://dart.dev/tools#ides-and-editors）。分析器也可以通过运行 `flutter analyze` 从命令行调用。

# 下面的行激活了一组针对Flutter应用、包和插件的推荐规则，旨在鼓励良好的编码实践。
include: package:eliterro_lint/lints.yaml

linter:
  # 此项目应用的规则可以在以下部分自定义，以禁用包含在上面的 `package:eliterro_lint/lints.yaml` 中的规则或启用额外的规则。所有可用规则及其文档发布在 https://dart.dev/tools/linter-rules。
  #
  # 不要在以下部分中为整个项目禁用规则，而是可以在产生规则的单行代码或特定dart文件中使用 `// ignore: name_of_lint` 和 `// ignore_for_file: name_of_lint` 语法来抑制规则。
  rules:
    # avoid_print: false  # 取消注释以禁用 `avoid_print` 规则
    # prefer_single_quotes: true  # 取消注释以启用 `prefer_single_quotes` 规则

示例代码

以下是一个示例文件main.dart，其中包含如何在代码中应用这些规则的示例。

// 此文件中的代码（以及其他dart文件中的代码）使用 `analysis_options.yaml` 中激活的规则进行分析。

// 以下语法禁用整个文件的规则：
// ignore_for_file: avoid_renaming_method_parameters

void main() {
  const String partOne = 'Hello';
  const String partTwo = 'World';

  // 以下语法在单行基础上禁用规则：
  print('$partOne $partTwo'); // ignore: avoid_print
}

abstract class Base {
  int methodA(int foo);
  String methodB(String foo);
}

// 通常情况下，此类中参数从 `foo` 重命名为 `bar` 会触发 `avoid_renaming_method_parameters` 规则，但已通过上述 `ignore_for_file` 注释在文件中禁用了该规则。
class Sub extends Base {
  [@override](/user/override)
  int methodA(int bar) => bar;

  [@override](/user/override)
  String methodB(String bar) => bar;
}