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

leancode_lint 是一套高质量、健壮且最新的lint规则，由LeanCode公司维护和使用。

安装

1. 在项目 pubspec.yaml 中添加 leancode_lint 和 custom_lint 作为开发依赖：

   dart pub add leancode_lint custom_lint --dev
   

2. 在 analysis_options.yaml 文件中添加以下内容，包含 leancode_lint 的配置文件。你可以排除一些文件（例如生成的json序列化文件）以避免分析：

   include: package:leancode_lint/analysis_options.yaml
   

3. 启用 custom_lint 分析插件，并可以自定义lint规则：

   analyzer:
     plugins:
       - custom_lint
   

4. 运行 flutter pub get 并重启IDE即可开始使用。

示例 analysis_options.yaml:

include: package:leancode_lint/analysis_options.yaml

# 可选的 lint 规则配置
custom_lint:
  rules:
    - use_design_system_item:
      AppText:
        - instead_of: Text
          from_package: flutter
        - instead_of: RichText
          from_package: flutter
      AppScaffold:
        - instead_of: Scaffold
          from_package: flutter

analyzer:
  plugins:
    - custom_lint
  exclude:
    - '**/*.g.dart'

库中的使用

如果你的包是一个库而不是一个二进制应用程序，则需要在 analysis_options.yaml 中更改 include 条目以适应库的公共API：

include: package:leancode_lint/analysis_options_package.yaml

自定义Lint规则

要禁用特定的自定义lint规则，可以在 analysis_options.yaml 中将该规则设置为 false。例如，禁用 prefix_widgets_returning_slivers 规则：

custom_lint:
  rules:
    - prefix_widgets_returning_slivers: false

示例规则说明

add_cubit_suffix_for_your_cubits

DO: 为你的cubit命名添加 ‘Cubit’ 后缀。

BAD:

class MyClass extends Cubit<int> {}

GOOD:

class MyClassCubit extends Cubit<int> {}

avoid_conditional_hooks

AVOID: 不要在条件语句中使用hooks。

BAD:

Widget build(BuildContext context) {
  if (condition) {
    useEffect(() {
      // ...
    }, []);
  }
}

GOOD:

Widget build(BuildContext context) {
  useEffect(() {
    if (condition) {
        // ...
    }
  }, []);
}

catch_parameter_names

DO: 命名捕获异常参数时保持一致性。

BAD:

try {} catch (e, s) {}

GOOD:

try {} catch (err, st) {}

hook_widget_does_not_use_hooks

AVOID: 如果没有使用hooks，则不要扩展 HookWidget。

BAD:

class MyWidget extends HookWidget {
  @override
  Widget build(BuildContext context) {
    return Placeholder();
  }
}

GOOD:

class MyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return Placeholder();
  }
}

prefix_widgets_returning_slivers

DO: 如果widget返回sliver，请在名称前加上 ‘Sliver’ 前缀。

BAD:

class MyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return SliverToBoxAdapter();
  }
}

GOOD:

class SliverMyWidget extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return SliverToBoxAdapter();
  }
}

start_comments_with_space

DO: 注释或文档开头留一个空格。

BAD:

//some comment
///some doc

GOOD:

// some comment
/// some doc

use_design_system_item

AVOID: 避免使用设计系统不允许的项。

示例配置：

custom_lint:
  rules:
    - use_design_system_item:
      LncdText:
        - instead_of: Text
          from_package: flutter
        - instead_of: RichText
          from_package: flutter
      LncdScaffold:
        - instead_of: Scaffold
          from_package: flutter

avoid_single_child_in_multi_child_widgets

AVOID: 避免在多子组件中使用单个子组件。

BAD:

Column(
  children: [
    Container(),
  ]
)

GOOD:

Container()

协助工具

协助工具是与特定问题无关的IDE重构工具。可以通过光标放置在相关代码上并打开代码操作对话框来触发。例如，在VSCode中可以通过按 Ctrl + . 或 Cmd + . 来触发。

参考链接：

• Convert positional to named formal
• Convert record into nominal type
• Convert iterable map to collection-for

以上内容详细介绍了如何安装和使用 `leancode_lint` 插件，并提供了一些常见的自定义Lint规则示例。希望这些信息对你有所帮助！