Flutter代码风格检查插件yx_scope_linter的使用

Flutter代码风格检查插件yx_scope_linter的使用

目录

1. 安装yx_scope_linter
2. 启用/禁用代码风格检查
   • 禁用特定规则
   • 默认禁用所有规则
3. 所有代码风格检查规则
4. 示例代码

安装yx_scope_linter

yx_scope_linter是基于custom_lint实现的，因此它使用custom_lint的安装逻辑。以下是安装步骤：

1. 在pubspec.yaml中添加依赖：

   dev_dependencies:
     custom_lint: 
     yx_scope_linter: 
   

2. 在analysis_options.yaml中启用custom_lint插件：

   analyzer:
     plugins:
       - custom_lint
   

启用/禁用代码风格检查

默认情况下，安装yx_scope_linter后，大多数代码风格检查规则会自动启用。你可以根据需要启用或禁用这些规则。

禁用特定规则

如果你不喜欢某个特定的代码风格检查规则，可以通过修改analysis_options.yaml来禁用它。例如，禁用consider_dep_suffix规则：

analyzer:
  plugins:
    - custom_lint

custom_lint:
  rules:
    # 显式禁用一个代码风格检查规则
    - consider_dep_suffix: false

默认禁用所有规则

如果你想默认禁用所有规则，并手动启用你需要的规则，可以在analysis_options.yaml中进行如下配置：

analyzer:
  plugins:
    - custom_lint

custom_lint:
  # 强制禁用所有代码风格检查规则
  enable_all_lint_rules: false
  rules:
    # 在"rules"列表中显式启用一个规则
    - consider_dep_suffix

所有代码风格检查规则

以下是yx_scope_linter提供的所有代码风格检查规则及其说明：

consider_dep_suffix

• 描述：对于Scope容器中的依赖项，建议使用带有Dep后缀的名称。
• 正确示例：

  late final myDep = dep(() => MyDep());
  

• 错误示例：

  late final justMyString = dep(() => SomeDep());
  

dep_cycle

• 描述：检测并避免循环依赖。
• 错误示例：

  // 检测到循环依赖：my1Dep <- my3Dep <- my2Dep <- my1Dep (dep_cycle)
  late final Dep<MyDep1> my1Dep = dep(() => MyDep1(my3Dep));
  late final Dep<MyDep2> my2Dep = dep(() => MyDep2(my1Dep));
  late final Dep<MyDep3> my3Dep = dep(() => MyDep3(my2Dep));
  

final_dep

• 描述：依赖项字段必须声明为late final。
• 正确示例：

  late final myDep = dep(() => MyDep());
  

• 错误示例：

  final myDep = dep(() => SomeDep());
  
  var myDep = dep(() => SomeDep());
  
  late var myDep = dep(() => SomeDep());
  

pass_async_lifecycle_in_initialize_queue

• 描述：异步依赖项（asyncDep或rawAsyncDep）必须传递给initializeQueue，否则init和dispose方法不会被调用。

use_async_dep_for_async_lifecycle

• 描述：如果依赖项实现了AsyncLifecycle接口，则必须使用asyncDep或rawAsyncDep，否则init和dispose方法不会被调用。

示例代码

以下是一个完整的示例项目，展示了如何使用yx_scope_linter进行代码风格检查。

项目结构

example/
├── lib/
│   └── main.dart
├── pubspec.yaml
└── analysis_options.yaml

pubspec.yaml

name: example
description: A new Flutter project.
publish_to: 'none' # Remove this line if you wish to publish to pub.dev

environment:
  sdk: ">=2.17.0 <3.0.0"

dependencies:
  flutter:
    sdk: flutter

dev_dependencies:
  flutter_test:
    sdk: flutter
  custom_lint: 
  yx_scope_linter: 

analysis_options.yaml

analyzer:
  plugins:
    - custom_lint

custom_lint:
  rules:
    - consider_dep_suffix
    - dep_cycle
    - final_dep
    - pass_async_lifecycle_in_initialize_queue
    - use_async_dep_for_async_lifecycle

lib/main.dart

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

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

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

class MyHomePage extends StatelessWidget {
  // 正确示例：使用带有Dep后缀的名称
  late final myDep = dep(() => MyDep());

  [@override](/user/override)
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text('Flutter Demo Home Page'),
      ),
      body: Center(
        child: Text('Hello, World!'),
      ),
    );
  }
}

// 模拟一个依赖项类
class MyDep {
  MyDep();
}

// 模拟一个异步生命周期依赖项类
class AsyncDep with AsyncLifecycle {
  AsyncDep();

  [@override](/user/override)
  Future<void> init() async {
    // 初始化逻辑
  }

  [@override](/user/override)
  Future<void> dispose() async {
    // 清理逻辑
  }
}