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

Branvier Lints

所有在Branvier项目中使用的代码检查规则。

通过使用静态分析工具，我们可以确保代码的一致性和可维护性。本文将介绍如何使用 branvier_lints 插件来帮助我们编写更规范的Flutter代码。

安装和配置

首先，在你的 pubspec.yaml 文件中添加 branvier_lints 依赖：

dev_dependencies:
  branvier_lints: ^x.y.z

然后，在项目的根目录下创建或更新 .analysis_options.yaml 文件，添加以下内容：

include: package:branvier_lints/analysis_options.yaml

这将使 branvier_lints 规则应用于你的项目。

示例代码

以下是一个使用 branvier_lints 的完整示例代码：

import 'dart:async';

import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';

void main() {
  Future.wait([
    Future(() => ''),
  ]);

  runApp(
    const MaterialApp(
      home: Scaffold(
        body: MyWidget(),
      ),
    ),
  );
}

class MyWidget extends StatefulWidget {
  const MyWidget({super.key, this.name});
  final String? name;

  static const double kPadding = 8;
  static String get yo => 'Hello, World!';

  static void privateMethod() {
    // ignore: avoid_print
    print('Hello, World!');
  }

  String get text => 'Hello, World!';

  void hi() {
    // TODO(A): implement hi
  }

  [@override](/user/override)
  State<MyWidget> createState() => _MyWidgetState();
}

class _MyWidgetState extends State<MyWidget> with TickerProviderStateMixin {
  String get text => 'Hello, World!';
  late final controller = AnimationController(vsync: this);
  late int count = 1 * 3;

  late StreamSubscription timer;

  TextStyle get textStyle => const TextStyle(
        color: Colors.black,
        fontSize: 16,
      );

  void setSomething(String name) {
    name = '';

    setState(() {});
  }

  // LINT: avoid_returning_widgets
  Widget _buildTextField() {
    if (kDebugMode) {
      if (kProfileMode) {
        if (kReleaseMode) {
          if (kDebugMode) {
            if (kDebugMode) {}
          }
        }
      }
      if (kProfileMode) {
        return const Padding(
          padding: EdgeInsets.all(1),
          child: TextField(
            maxLength: 10,
            decoration: InputDecoration(
              labelText: 'Enter some text',
            ),
          ),
        );
      }
    }
    return const Padding(
      padding: EdgeInsets.all(1),
      child: TextField(
        maxLength: 10,
        decoration: InputDecoration(
          labelText: 'Enter some text',
        ),
      ),
    );
  }

  [@override](/user/override)
  void dispose() {
    controller.dispose();
    super.dispose();
  }

  [@override](/user/override)
  Widget build(BuildContext context) {
    final size = MediaQuery.sizeOf(context);

    return Padding(
      padding: const EdgeInsets.all(8),
      child: SizedBox(
        height: size.height,
        child: Column(
          children: [
            // ignore: avoid_single_child_in_multi_child_widgets
            const Column(
              children: [
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            const Column(
              children: [
                Placeholder(),
                Placeholder(),
              ],
            ),
            _buildTextField(),
          ],
        ),
      ),
    );
  }

  [@override](/user/override)
  void initState() {
    super.initState();
    timer = const Stream.empty().listen((event) {});
    try {} catch (e, s) {
      print(e);
      print(s);
    }
  }
}

class ClassName {
  ClassName({required this.name});
  final String name;
}