Flutter国际化清理插件translations_cleaner的使用

简介

translations_cleaner 是一个Dart包，用于查找并删除所有语言的.arb文件中未使用的翻译。该插件主要为flutter_localizations包设计，它使用.arb文件进行所有翻译。

使用方法

添加依赖

首先需要将translations_cleaner添加为开发依赖：

dart pub add --dev translations_cleaner

运行命令

然后可以通过以下两种方式运行命令：

dart run translations_cleaner <command> [arguments]
# 或者
flutter pub run translations_cleaner <command> [arguments]

可用命令

• clean-translations：搜索所有的arb文件中的翻译，并删除未使用的翻译。
• list-unused-terms：搜索所有的arb文件中的翻译，并打印或保存一份未使用翻译的列表。

可用选项

仅对list-unused-terms有效

• -a, --[no-]abort-on-unused：如果找到未使用的翻译，则终止执行。这在CI中有帮助，如果你不希望在构建失败时继续。

对所有命令有效

• -h, --help：打印此使用信息。
• -o, --output-path：保存导出文件的路径，默认为文件夹的根路径。
• -e, --[no-]export：将未使用的键作为.txt文件保存到提供的路径中。

为什么需要这个工具？

当应用程序开始扩展并且有很多翻译时，处理翻译可能是一个非常耗时的过程。因此，清理未使用的翻译是一个很好的实践。手动检查未使用的翻译很繁琐，所以有了这个插件。

工作原理

• translations_cleaner会查找目录中所有的.arb文件，并获取所有语言的所有翻译。
• 然后它会查找所有的.dart文件。
• 所有的翻译术语都会在这些dart文件中查找。
• 没有在dart文件中找到的翻译将从相应的.arb文件中移除，包括任何属性。

局限性

• 目前，该插件只支持通过flutter_localizations实现的l10n，它使用.arb文件。
• 其他使用.json和.yaml保存翻译的l10n包目前不受支持。

示例代码

示例项目结构

假设你有一个Flutter项目的结构如下：

my_flutter_app/
├── lib/
│   └── main.dart
└── l10n/
    ├── app_en.arb
    └── app_zh.arb

清理翻译

为了清理未使用的翻译，你可以简单地运行以下命令：

flutter pub run translations_cleaner clean-translations

列出未使用的翻译

如果你想列出未使用的翻译而不删除它们，可以运行：

flutter pub run translations_cleaner list-unused-terms -o output.txt -e

这将会把未使用的翻译保存到output.txt文件中。

通过这些步骤，你可以轻松地管理和维护你的Flutter应用中的国际化资源，确保只有必要的翻译被保留，从而提高项目的整洁度和可维护性。