Flutter代码规范与静态分析插件flutter_lints_iamchathu的使用

flutter_lints_iamchathu

flutter_lints_iamchathu 是一个为 Flutter 应用、包和插件设计的静态分析工具，旨在鼓励良好的编码实践。

该插件包含一组推荐的 lints 和一些额外的意见性规则，用于鼓励 Flutter 应用、包和插件的良好编码习惯。部分规则基于我和 Pasindu 的共同约定（部分工作基于他的项目）。

此包建立在 Dart 的 recommended.yaml lint 集合之上，来源于 package:lints 和 package:flutter_lints。

Lint 规则由 Dart 分析器（dart analyzer）解析，静态检查 Dart 代码。Dart 支持的 IDE 通常会在其界面中展示分析器识别出的问题。此外，也可以通过运行 flutter analyze 手动调用分析器。

使用方法

从 Flutter 版本 2.3.0 开始，使用 flutter create 创建的 Flutter 应用、包和插件已经默认启用了此插件定义的 lint 规则。如果是在此版本之前创建的项目，可以通过以下步骤启用这些 lint 规则：

步骤 1：将插件添加为开发依赖

运行以下命令，将 flutter_lints_iamchathu 添加为项目的开发依赖：

flutter pub add --dev flutter_lints_iamchathu

步骤 2：创建或更新 analysis_options.yaml

在项目的根目录下创建或更新 analysis_options.yaml 文件（与 pubspec.yaml 同级），并添加以下内容：

# 这个文件配置了分析器，它会静态分析 Dart 代码以检查错误、警告和 lint。
#
# 分析器识别的问题会在支持 Dart 的 IDE 中显示（https://dart.dev/tools#ides-and-editors）。
# 分析器也可以通过命令行运行 `flutter analyze` 来手动调用。

# 下一行激活了一组推荐的 lint，用于鼓励良好的编码实践。
include: package:flutter_lints_iamchathu/flutter.yaml

linter:
  # 以下是项目中应用的 lint 规则，可以根据需要进行自定义。
  # 可以禁用从 `package:flutter_lints/flutter.yaml` 包含的规则，或者启用其他规则。
  # 所有可用 lint 的列表及其文档可以在 https://dart-lang.github.io/linter/lints/index.html 查看。
  #
  # 如果不想在整个项目中禁用某个 lint 规则，也可以通过在产生 lint 的单行代码或特定 Dart 文件中使用 `// ignore: name_of_lint` 和 `// ignore_for_file: name_of_lint` 语法来抑制。
  rules:
    # avoid_print: false  # 取消注释以禁用 `avoid_print` 规则
    # prefer_single_quotes: true  # 取消注释以启用 `prefer_single_quotes` 规则

完整示例

以下是一个完整的示例，展示如何设置 flutter_lints_iamchathu 并启用一些规则。

1. 项目结构

假设你的项目结构如下：

my_flutter_project/
├── analysis_options.yaml
├── lib/
│   └── main.dart
├── pubspec.yaml
└── README.md

2. 添加开发依赖

在项目根目录运行以下命令，将 flutter_lints_iamchathu 添加为开发依赖：

flutter pub add --dev flutter_lints_iamchathu

3. 配置 analysis_options.yaml

在项目的根目录下创建或更新 analysis_options.yaml 文件，内容如下：

# 配置分析器以启用 flutter_lints_iamchathu 的规则。
include: package:flutter_lints_iamchathu/flutter.yaml

linter:
  rules:
    # 禁用打印日志（避免在生产环境中使用 print）
    avoid_print: true

    # 建议使用单引号
    prefer_single_quotes: true

4. 示例代码

在 lib/main.dart 中编写以下代码：

import 'package:flutter/material.dart';

void main() {
  print('Hello, World!'); // 违反 `avoid_print` 规则
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'My App',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Lint Example'), // 符合 `prefer_single_quotes` 规则
        ),
        body: Center(
          child: Text('Hello, World!'),
        ),
      ),
    );
  }
}

5. 运行分析器

在终端中运行以下命令，检查代码是否符合 lint 规则：

flutter analyze

6. 输出结果

如果代码不符合规则，例如 print 被禁用，则分析器会输出类似以下内容：

Analyzing my_flutter_project...

  error • Avoid using print in production code • lib/main.dart:3:3 • avoid_print
  warning• Prefer single quotes over double quotes unless needed for interpolation or escaping • lib/main.dart:10:19 • prefer_single_quotes

2 issues found. (ran in 2.3s)