Flutter代码迁移插件over_react_codemod的使用

概述

over_react_codemod 是一个用于帮助开发者迁移过时代码的工具包。它基于 dart_codemod 构建，支持自动化迁移 Flutter 和 Dart 中的 UI 组件代码。

安装

要使用 over_react_codemod，首先需要确保你的 Dart SDK 版本为 2.1.0 或更高版本。

dart pub global activate over_react_codemod

激活后，你可以通过以下命令运行代码迁移工具：

dart pub global run over_react_codemod:<codemod_name>

国际化代码迁移（intl_message_migration）

该工具提供了将现有 UI 组件代码迁移到国际化支持的功能。

使用示例

1. 运行国际化迁移工具：

dart pub global run over_react_codemod:intl_message_migration

1. 更改后的代码示例：

// 原始代码
Text('Hello, world!')

// 迁移后的代码
TextIntl('Hello, world!')

更多详细信息，请参考 INTL Message Codemod Readme。

从 Dart 1 迁移到 Dart 2

安装旧版本

由于最新版本已不再支持 Dart 1 到 Dart 2 的迁移，你需要安装特定版本 1.1.0 并使用 Dart 2.1.0。

asdf install dart 2.1.0
asdf shell dart 2.1.0
pub global activate over_react_codemod 1.1.0

使用示例

运行迁移工具：

dart pub global run over_react_codemod:dart2_upgrade

迁移后的代码示例：

// 原始代码
print('Hello, world!');

// 迁移后的代码
print('Hello, world!');

更多详细信息，请参考 Dart 1 到 Dart 2 Codemod 文档。

检查回归

在需要前后兼容的情况下，可以启用 --fail-on-changes 模式来检查迁移后的代码是否存在问题。

dart pub global run over_react_codemod:dart2_upgrade --fail-on-changes

如果迁移过程中有未处理的更改，工具会返回非零退出码。

忽略代码迁移建议

某些迁移可能会误报，可以通过添加忽略注释来跳过特定代码。

示例

原始代码：

class Foo extends Object with BarStateMixin {}

迁移后的代码：

class Foo extends Object
    with
        BarStateMixin,
        // ignore: mixin_of_non_class, undefined_class
        $BarStateMixin {}

为了避免误报，添加忽略注释：

class Foo extends Object
    with
        // orcm_ignore
        BarStateMixin {}