Flutter代码质量与规范插件galactic_lints的使用

Flutter代码质量与规范插件galactic_lints的使用

获取开始

添加此包作为devDependency。

flutter pub add --dev galactic_lints

或者

dart pub add --dev galactic_lints

另外，你也可以直接将其添加到pubspec.yaml文件的devDependencies部分：

dev_dependencies:
  galactic_lints: ^0.0.1

使用

在你的analysis_options.yaml文件中添加以下行：

include: package:galactic_lints/lints.yaml

这样，你就可以轻松地启用或禁用规则。例如，你可以通过以下方式禁用prefer_single_quotes规则：

linter:
  rules:
    prefer_single_quotes: false

应用规则

错误组

• avoid_dynamic_calls
• avoid_slow_async_io
• cancel_subscriptions
• close_sinks
• collection_methods_unrelated_type
• comment_references
• diagnostic_describe_all_properties
• discarded_futures
• no_adjacent_strings_in_list
• prefer_relative_imports
• throw_in_finally
• unnecessary_statements

风格组

• always_declare_return_types
• avoid_catches_without_on_clauses
• avoid_catching_errors
• avoid_classes_with_only_static_members
• avoid_double_and_int_checks
• avoid_escaping_inner_quotes
• avoid_final_parameters
• avoid_implementing_value_types
• avoid_js_rounded_ints
• avoid_multiple_declarations_per_line
• avoid_positional_boolean_parameters
• avoid_private_typedef_functions
• avoid_redundant_argument_values
• avoid_returning_this
• avoid_setters_without_getters
• avoid_types_on_closure_parameters
• avoid_unused_constructor_parameters
• avoid_void_async
• cascade_invocations
• dangling_library_doc_comments
• deprecated_consistency
• implicit_call_tearoffs
• join_return_with_assignment
• leading_newlines_in_multiline_strings
• lines_longer_than_80_chars
• missing_whitespace_between_adjacent_strings
• noop_primitive_operations
• one_member_abstracts
• only_throw_errors
• parameter_assignments
• prefer_asserts_in_initializer_lists
• prefer_asserts_with_message
• prefer_constructors_over_static_methods
• prefer_final_in_for_each
• prefer_final_locals
• prefer_if_elements_to_conditional_expressions
• prefer_int_literals
• prefer_null_aware_method_calls
• prefer_single_quotes
• secure_pubspec_urls
• sort_pub_dependencies
• sort_unnamed_constructors_first
• type_literal_in_constant_pattern
• unawaited_futures
• unnecessary_await_in_return
• unnecessary_lambdas
• unnecessary_library_directive
• unnecessary_null_aware_operator_on_extension_on_nullable
• unnecessary_null_checks
• unnecessary_parenthesis
• unnecessary_raw_strings
• unnecessary_to_list_in_spreads
• use_colored_box
• use_decorated_box
• use_enums
• use_if_null_to_convert_nulls_to_bools
• use_is_even_rather_than_modulo
• use_late_for_private_fields_and_variables
• use_named_constants
• use_raw_strings
• use_setters_to_change_properties
• use_string_buffers
• use_string_in_part_of_directives
• use_super_parameters
• use_test_throws_matchers

示例代码

以下是示例代码，展示了如何使用galactic_lints插件：

import 'dart:convert';

import 'package:flutter/material.dart';

import 'library.dart';

// 定义一个返回Future<void>的类型别名
typedef FutureV = Future<void>;

// 定义一个接受字符串列表的方法
void foo(List<String> lines) {}

// 定义一个接受json文本的方法
void bar(String jsonText) {
  // 将json文本解码为字符串列表
  foo(jsonDecode(jsonText) as List<String>);
}

// 主函数
void main() async {
  // 延迟零毫秒
  await FutureV.delayed(Duration.zero);
  // 执行一些惊人的操作
  doAmazingStuff();

  // 运行应用
  runApp(const MyApp());
}

// 创建一个无状态的Widget
class MyApp extends StatelessWidget {
  const MyApp({super.key});

  [@override](/user/override)
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

// 创建一个有状态的Widget
class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});

  final String title;

  [@override](/user/override)
  State<MyHomePage> createState() => _MyHomePageState();
}

// 创建一个有状态的Widget的状态类
class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  // 增加计数器的方法
  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

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