Flutter代码分析格式化插件analyzer_formatter的使用

Flutter代码分析格式化插件analyzer_formatter的使用

关于

analyzer_formatter 是一个用于将Dart Analyzer输出转换为Checkstyle和JUnit报告格式的工具。

安装

从 pub.dev 安装此工具：

flutter pub global activate analyzer_formatter

如何使用

1. 使用Dart Analyzer检查你的项目并将输出写入文件：

flutter analyze > analyzer_report.txt

默认情况下，Dart Analyzer的输出文件名为 analyzer_report.txt。你可以通过 --analyzerReportFile 参数指定自己的文件名。

1. 运行工具处理项目文件夹：

flutter pub global run analyzer_formatter

参数

如何贡献

在提交拉取请求之前，请确保构建是绿色的。然后运行以下命令：

$ dart analyze

如果没有看到任何错误消息，就可以提交你的拉取请求了。

贡献者

• @fartem 作为 Artem Fomchenkov
• @dynaevdv 作为 Denis Dunaev
• @qwertyway 作为 Artem Demyanov
• @GeorgeOblomov 作为 Egor Grischenkov

示例代码

示例项目结构

my_flutter_project/
├── lib/
│   ├── main.dart
│   └── other_file.dart
├── analyzer_report.txt
└── analysis_options.yaml

分析项目并生成报告

首先，使用Dart Analyzer对项目进行分析，并将结果保存到 analyzer_report.txt 文件中：

# 在项目根目录下执行
flutter analyze > analyzer_report.txt

使用analyzer_formatter处理报告文件

然后，使用 analyzer_formatter 处理生成的报告文件：

# 在项目根目录下执行
flutter pub global run analyzer_formatter --analyzerReportFile analyzer_report.txt --outputSuffix _formatted

生成的报告文件

处理完成后，你将在当前目录下找到一个新的文件，其名称为 analyzer_report_formatted.txt（根据 --outputSuffix 参数指定的后缀）。

输出示例

假设 analyzer_report.txt 文件包含以下内容：

lib/main.dart:1:1: Error: Expected to find '}'.
class MyWidget extends StatelessWidget {
^
lib/other_file.dart:5:1: Warning: The function 'print' is often misspelled as 'println'.
print('Hello World');
^

经过 analyzer_formatter 处理后，生成的 analyzer_report_formatted.txt 文件可能包含类似以下内容：

<?xml version="1.0"?>
<testsuite name="Analyzer Report" tests="2">
    <testcase classname="lib/main.dart" name="Error" time="0.0">
        <error message="Expected to find '}'.">class MyWidget extends StatelessWidget {
^</error>
    </testcase>
    <testcase classname="lib/other_file.dart" name="Warning" time="0.0">
        <failure message="The function 'print' is often misspelled as 'println'.">print('Hello World');</failure>
    </testcase>
</testsuite>