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

sznm_lints

sznm_lints 是一个用于 Dart 和 Flutter 的个人代码规范检查规则集。

参考资料

• Dart 分析器配置
• Dart Linter 规则
• Lint 规则
  • 所有规则：all.yaml
  • 拓展自：
    • core.yaml
    • recommended.yaml
    • flutter.yaml

使用 sznm_lints

安装

在 pubspec.yaml 文件中添加 sznm_lints 依赖：

dev_dependencies:
  lints: ^2.0.0
  sznm_lints: ^1.0.0 # 添加 sznm_lints 插件

然后运行以下命令以安装依赖：

flutter pub get

配置规则

创建或修改 .analysis_options.yaml 文件，指定使用 sznm_lints 规则：

include: package:sznm_lints/analysis_options.yaml

完整的 .analysis_options.yaml 示例：

include: package:sznm_lints/analysis_options.yaml

analyzer:
  strong-mode: true
  errors:
    unused_element: error
    unused_field: warn
    invalid_use_of_visible_for_testing_member: error

linter:
  rules:
    avoid_print: true
    prefer_const_constructors: true

示例代码

以下是一个简单的 Flutter 应用，展示了如何使用 sznm_lints 进行静态分析。

main.dart

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(),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @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('Flutter Demo Home Page'),
      ),
      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 命令后，sznm_lints 将根据配置文件检查代码并报告潜在问题。例如：

$ flutter analyze
Analyzing example...
No issues found!