Flutter功能检测插件checker的使用

发布于 1周前 作者 gougou168 来自 Flutter

Flutter功能检测插件Checker的使用

Checker 是一个用于维护软件项目质量和组织结构的重要工具。该软件会自动扫描源代码中包含 “check”、“todo” 或 “fix” 的注释。

通过识别这些术语，Checker 生成详细的报告，帮助开发者跟踪和管理待办任务、质量检查和必要的修复。借助 Checker，代码维护变得更加高效且有效，确保不会遗漏任何重要任务。

在 Checker 运行结束时，它会在终端返回错误信息以通知发生错误，并阻止后续操作，这可以防止你继续处理未完成的任务。

开始使用

安装

你可以从命令行安装该包：

dart pub global activate checker
设置

安装完成后，在你的项目根目录下创建一个名为 check.yaml 的新文件，并添加以下设置示例：

所有这些设置都可以忽略，但推荐使用一些组合来节省时间，因为此工具会检查所有文件，所以我们可以通过忽略文件夹和文件类型来提高效率。

patterns: # 这表示我们想要找到的模式
  - "// fix:" # 在这里，当使用特殊字符如冒号':'时，YAML会将其解释为嵌套对象，因此为了避免这种情况，我们使用双引号的模式
  - "// todo:"

warnings: # 这表示将仅记录以提醒尚未解决的任务的模式
  - "// todo:"

target: # 我们可以明确指定要关注的文件类型，如果为空，则检查所有文件类型
  - dart

skipFile: # 我们还可以在这里添加子类型，如代码生成文件
  - .gen.dart
  - .freezed.dart

skipFolder: # 这对于避免查看不必要的文件夹非常有用
  - /.dart_tool
  - /.git

运行

从项目的根目录运行：

checker

当 checker 命令完成时，会有一条消息告知发生了什么： 如果没有匹配项，它会返回一个成功代码（$? >> 0）并显示消息：

Success, no matches found!

如果找到了一个或多个模式，checker 命令将以错误代码退出（$? >> 1），并显示从何处找到模式的详细消息：

File: /Users/JsonDev/Developer/flutter/my_tool/lib/components/badges/car_badge_widget.dart:26
} // FIX: 移除刷新屏幕的函数

File: /Users/JsonDev/Developer/flutter/my_tool/lib/components/badges/car_badge_widget.dart:36
} // FIX: 将此函数重命名为更好的名称

这将读取 yaml 文件以获取设置，并根据指定的设置搜索定义的模式。

调试

为了正确设置这些设置，增加了一个调试标志来打印一些有用的日志。要使用调试选项，可以在 checker 命令后添加 -d 标志。

checker -d

它将打印正在扫描的文件夹和找到的模式。

一些用法

一种常见的情况是在重构代码时，必须避免推送带有注释的代码。因此，你可以添加类似 // fix: 需要在推送前修复此问题，因为... 的注释，并在 push 命令之前运行 checker 命令，例如 checker && git push。

完整的 check.yaml 示例

patterns:
  - "// fix:"

warnings:
  - "// todo:"

target:
  - dart

skipFolder:
  - /.dart_tool
  - /.git
  - /.vscode
  - /.idea
  - /build
  - /android
  - /ios
  - /windows
  - /web
  - /linux
  - /macos
  - /.fvm

示例代码

下面是一个完整的 Flutter 项目中使用 Checker 的示例代码：

  1. 创建 check.yaml 文件

    在项目根目录下创建 check.yaml 文件，并添加如下内容：

    patterns:
  - "// fix:"
  - "// todo:"

warnings:
  - "// todo:"

target:
  - dart

skipFile:
  - .gen.dart
  - .freezed.dart

skipFolder:
  - /.dart_tool
  - /.git
  - /.vscode
  - /.idea
  - /build
  - /android
  - /ios
  - /windows
  - /web
  - /linux
  - /macos
  - /.fvm

  2. 在 Flutter 项目中添加需要检查的代码

    在项目中添加一些需要检查的代码，例如：

    import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: Text('Checker Example')),
        body: Center(
          child: TextButton(
            onPressed: () {
              // TODO: 实现按钮点击事件
              print('Button clicked');
            },
            child: Text('Click Me'),
          ),
        ),
      ),
    );
  }
}

  3. 运行 Checker

    从项目的根目录运行 checker 命令：

    checker

    如果没有找到任何匹配项，你会看到：

    Success, no matches found!

    如果找到了匹配项，你会看到类似的消息：

    File: /path/to/project/lib/main.dart:15
} // TODO: 实现按钮点击事件

更多关于Flutter功能检测插件checker的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html

1 回复

更多关于Flutter功能检测插件checker的使用的实战系列教程也可以访问 https://www.itying.com/category-92-b0.html


在Flutter开发中，checker 插件通常不是一个官方或广泛认知的插件名称，但如果你指的是用于检测Flutter应用功能完整性和状态的插件，可能是在寻找类似于 flutter_test 或者一些自定义的用于功能检测的包。为了提供一个接近你所要求的示例，我将展示如何使用Flutter的测试框架 flutter_test 来编写一些功能检测代码。

假设我们有一个简单的Flutter应用，包含一个按钮，点击后显示一个文本。我们将编写一些测试来检测这个功能是否正常工作。

1. 创建一个简单的Flutter应用

首先，创建一个简单的Flutter应用，包含一个按钮和一个文本：

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

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

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(
          title: Text('Flutter Checker Example'),
        ),
        body: Center(
          child: MyWidget(),
        ),
      ),
    );
  }
}

class MyWidget extends StatefulWidget {
  @override
  _MyWidgetState createState() => _MyWidgetState();
}

class _MyWidgetState extends State<MyWidget> {
  bool _isTextVisible = false;

  void _showText() {
    setState(() {
      _isTextVisible = !_isTextVisible;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Column(
      mainAxisAlignment: MainAxisAlignment.center,
      children: <Widget>[
        ElevatedButton(
          onPressed: _showText,
          child: Text('Show/Hide Text'),
        ),
        if (_isTextVisible)
          Text('Text is visible!'),
      ],
    );
  }
}

2. 编写测试代码

接下来，我们编写一些测试代码来检测按钮点击后文本是否显示：

// test/widget_test.dart
import 'package:flutter/material.dart';
import 'package:flutter_test/flutter_test.dart';
import 'package:your_app_name/main.dart'; // 确保路径正确

void main() {
  testWidgets('clicking the button shows the text', (WidgetTester tester) async {
    // 构建应用
    await tester.pumpWidget(MyApp());

    // 找到按钮并点击
    final buttonFinder = find.byType(ElevatedButton);
    await tester.tap(buttonFinder);
    await tester.pump(); // 触发UI更新

    // 验证文本是否显示
    expect(find.text('Text is visible!'), findsOneWidget);

    // 再次点击按钮，验证文本是否隐藏
    await tester.tap(buttonFinder);
    await tester.pump();
    expect(find.text('Text is visible!'), findsNothing);
  });
}

3. 运行测试

确保你的项目根目录下有一个 test 文件夹，并且 widget_test.dart 文件位于其中。然后，在命令行中运行以下命令来执行测试：

flutter test

这将运行你编写的测试，并报告测试结果。

总结

虽然checker插件的具体实现可能有所不同，但上述示例展示了如何使用Flutter的测试框架来编写和运行功能检测代码。这可以帮助你确保应用的关键功能按预期工作。如果你有特定的checker插件或库，请提供更多详细信息，以便给出更精确的代码示例。

回到顶部