Flutter代码质量与风格检查插件solidart_lint的使用

简介

soldart_lint 是一个为 flutter_solidart 用户设计的开发者工具，旨在帮助避免常见问题并简化重复性任务。强烈推荐使用此包以避免错误并了解如何正确使用 flutter_solidart。

快速开始

在Flutter项目的根目录下运行以下命令：

flutter pub add -d solidart_lint custom_lint

编辑你的 analysis_options.yaml 文件，添加如下内容：

analyzer:
  plugins:
    - custom_lint

然后执行以下命令：

flutter clean
flutter pub get
dart run custom_lint

辅助功能（ASSISTS）

使用Solid包裹组件

使用SignalBuilder包裹组件

使用ResourceBuilder包裹组件

使用Show包裹组件

LINT规则

避免动态Solid Provider

Provider不能是dynamic类型。

错误示例：

Solid(
  providers: [
    Provider(create: () => MyClass()),
  ],
),

正确示例：

Solid(
  providers: [
    Provider<MyClass>(create: () => MyClass()),
  ],
),

避免动态Solid Signal

Solid signals不能是dynamic类型。

错误示例：

Solid(
  signals: {
    'id': () => Signal(0),
  },
),

正确示例：

Solid(
  signals: {
    'id': () => Signal<int>(0),
  },
),

无效的Provider类型

获取的provider类型不能实现 SignalBase 接口。

错误示例：

final provider = context.get<Signal<MyClass>>();

正确示例：

final provider = context.get<MyClass>();

无效的Signal类型

获取的signal类型必须实现 SignalBase 接口。

错误示例：

final signal = context.get<MyClass>('signal-id');

正确示例：

final signal = context.get<Signal<int>>('signal-id');

无效的Solid Get类型

指定要获取的provider或signal类型。

错误示例：

final provider = context.get();

正确示例：

final provider = context.get<MyClass>();

无效的Observe类型

观察的类型不能实现 SignalBase 接口。

错误示例：

final counter = context.observe<Signal<int>>('counter');

正确示例：

final counter = context.observe<int>('counter');

无效的Update类型

更新的类型不能实现 SignalBase 接口。

错误示例：

context.update<Signal<int>>('counter', (value) => value * 2);

正确示例：

context.update<int>('counter', (value) => value * 2);

示例代码

下面是一个完整的示例代码，展示了如何在项目中使用 solidart_lint 插件来检测和修复代码中的问题。

// ignore_for_file: unused_local_variable

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

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

class MyClass {}

class MyApp extends StatelessWidget {
  MyApp({super.key});

  final counter = Signal<int>(1);

  @override
  Widget build(BuildContext context) {
    return Solid(
      providers: [
        // expect_lint: avoid_dynamic_provider
        Provider<MyClass>(create: () => MyClass()),
        // expect_lint: avoid_dynamic_provider
        Provider<Signal<int>>(create: () => Signal<int>(0), id: 'counter'),
        // expect_lint: avoid_dynamic_provider
        Provider<Computed<int>>(
          create: () => Computed<int>(() => counter() * 2),
          id: 'double-counter',
        ),
      ],
      child: const MaterialApp(
        title: 'Flutter Demo',
        home: MyHomePage(),
      ),
    );
  }
}

class MyHomePage extends StatelessWidget {
  const MyHomePage({super.key});

  @override
  Widget build(BuildContext context) {
    // expect_lint: missing_solid_get_type
    final myClass = context.get<MyClass>();
    // expect_lint: invalid_observe_type
    final counter = context.observe<int>('counter');

    return ElevatedButton(
      child: const Text('Increment'),
      onPressed: () {
        // expect_lint: invalid_update_type
        context.update<int>(
            'counter', (value) => throw UnimplementedError());
      },
    );
  }
}

通过以上步骤和示例代码，您可以有效地使用 solidart_lint 插件来提高Flutter项目的代码质量和风格一致性。