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

官方Dart lint规则

Dart CI

Dart linter是一个用于识别Dart源代码中潜在问题的静态分析器。有超过一百种linter rules可用，从可能的类型问题、编码风格到格式化都会进行检查。package:lints这个包包含了Dart团队推荐的lint设置。

Lint集

本包包含两套lint：

• Core lints：帮助识别可能导致运行或消费Dart代码时出现问题的关键问题。所有代码都应通过这些lint。
• Recommended lints：帮助识别可能导致运行或消费Dart代码时出现问题的额外问题，以及强制编写符合单一、惯用风格和格式的Dart代码。鼓励所有代码通过这些lint。推荐的lint包括所有的核心lint。

此外，第三个lint集——package:flutter_lints——扩展了推荐集，增加了额外的Flutter特定推荐lint。

这些lint在哪里使用

当使用dart create命令创建新的Dart项目时，默认启用来自package:lints的recommended lint集。

当将软件包上传到pub.dev软件包仓库时，根据有多少’core’ lint通过，软件包会获得pub points。

启用lint

对于使用dart create创建的新应用程序，默认启用了recommended lint集。

对于现有的应用程序或软件包，您可以通过以下步骤启用这些lint：

1. 在终端中，位于您的软件包根目录，运行此命令：

   dart pub add dev:lints
   

2. 创建一个新的analysis_options.yaml文件，在pubspec旁边，包含lints包：

   include: package:lints/recommended.yaml
   

   或者：

   include: package:lints/core.yaml
   

升级到最新的lint

要升级到最新版本的lint集，请运行：

dart pub add dev:lints

自定义预定义的lint集

有关自定义静态分析的详细信息，请参阅Customizing static analysis。

lint集的发展

随着Dart语言的变化和生态系统的不断发展，最佳实践也在不断更新，因此需要定期更新lint集以反映编写Dart代码的最佳方式。我们使用的流程是：

1. 任何人都可以提交一个issue来讨论对lint集的潜在更改（即添加或删除一个或两个集合中的lint；如果您建议一个全新的lint，则应在linter repo中提出）。
2. 周期性地，Dart和Flutter团队成员开会审查这些建议并决定采用哪些。
3. 更新列表并发布新版本的包。

lint集内容

请参阅rules.md以获取构成核心和推荐规则集的规则列表。

示例demo

下面是一个使用Dart推荐lint的示例项目结构：

my_flutter_app/
├── lib/
│   └── main.dart
├── test/
│   └── widget_test.dart
├── pubspec.yaml
└── analysis_options.yaml

在analysis_options.yaml中添加如下配置：

include: package:lints/recommended.yaml

然后可以在lib/main.dart中编写一些简单的Flutter代码，例如：

import 'package:flutter/material.dart';

void main() {
  runApp(MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        primarySwatch: Colors.blue,
      ),
      home: MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  MyHomePage({Key? key, required this.title}) : super(key: key);

  final String title;

  @override
  _MyHomePageState createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headline4,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: Icon(Icons.add),
      ),
    );
  }
}

这样，当您运行flutter analyze命令时，Dart linter会根据analysis_options.yaml中的配置对您的代码进行分析，并指出任何不符合lint规则的地方。