Flutter文件重命名插件rename_plus的使用

Flutter文件重命名插件rename_plus的使用

简介

rename_plus 是一个用于在 Flutter 项目中批量修改文件名的工具。它可以帮助开发者快速更改应用名称（AppName）和包名（BundleId），支持多个平台，包括 iOS、Android、MacOS、Linux、Web 和 Windows。

安装

首先，确保你的系统已经安装了 Flutter 和 Dart。然后通过以下命令全局安装 rename_plus：

flutter pub global activate rename_plus

安装完成后，可以通过以下方式运行该工具：

• 直接运行：rename_plus
• 使用 Flutter 命令：flutter pub global run rename_plus
• 使用 Dart 命令：dart pub global run rename_plus

如果遇到路径变量问题，请确保将 .pub-cache/bin 添加到系统的 PATH 中。

使用指南

1. 查看帮助信息

运行以下命令查看工具的帮助信息：

rename_plus help

输出示例：

A CLI tool that helps for renaming in Flutter projects.

Usage: rename_plus <command> [arguments]

Global options:
-h, --help       Print this usage information.
-v, --version    

Available commands:
  getAppName    Get app names for the targeted platforms
  getBundleId   Get bundleId identifiers for the targeted platforms
  setAppName    Set app name for the targeted platforms
  setBundleId   Set bundleId identifier for the targeted platforms

Run "rename_plus help <command>" for more information about a command.

也可以针对特定命令查看详细帮助：

rename_plus help setAppName

输出示例：

Set app name for the targeted platforms

Usage: rename_plus setAppName [arguments]
-h, --help                 Print this usage information.
-t, --targets              Set which platforms to target.
                           [ios (default), android (default), macos, linux, web, windows]
-v, --value (mandatory)    Set value of the given command

Run "rename_plus help" to see global options.

2. 获取当前 App 名称

要获取指定平台的当前 App 名称，可以使用以下命令：

rename_plus getAppName --targets ios

输出示例：

This will output the current AppName for the iOS platform.

如果需要获取多个平台的 App 名称，可以同时指定多个目标平台：

rename_plus getAppName --targets ios,android,macos,windows,linux

3. 设置 App 名称

要为特定平台设置新的 App 名称，可以使用以下命令：

rename_plus setAppName --targets ios,android --value "NewAppName"

输出示例：

This will set the AppName for the iOS and Android platforms to "NewAppName".

4. 获取或设置 Bundle ID

与设置 App 名称类似，rename_plus 提供了 getBundleId 和 setBundleId 命令来处理 Bundle ID。

获取 Bundle ID：

rename_plus getBundleId --targets android

输出示例：

This will output the current BundleId for the Android platform.

设置 Bundle ID：

rename_plus setBundleId --targets android --value "com.example.newBundleId"

输出示例：

This will set the BundleId for the Android platform to "com.example.newBundleId".

参数说明

命令

• setAppName: 修改指定平台的应用名称。
• setBundleId: 修改指定平台的 Bundle ID。
• getAppName: 获取指定平台的应用名称。
• getBundleId: 获取指定平台的 Bundle ID。

选项

• -t, --targets: 指定目标平台，支持 android, ios, web, windows, macos, linux。此参数对所有命令都是必需的。
• -v, --value: 指定命令的值，对于 setAppName 和 setBundleId 是必填项。
• -h, --help: 显示相关命令的帮助信息。

示例完整 Demo

假设你有一个名为 MyApp 的 Flutter 项目，并且希望将其 App 名称更改为 AwesomeApp，同时修改 Android 平台的 Bundle ID 为 com.example.awesomeapp。以下是具体步骤：

1. 进入项目根目录：

   cd /path/to/your/flutter/project

2. 设置 App 名称：

   rename_plus setAppName --targets ios,android --value "AwesomeApp"

3. 设置 Bundle ID：

   rename_plus setBundleId --targets android --value "com.example.awesomeapp"

4. 验证设置是否成功：

   • 获取 App 名称：

     rename_plus getAppName --targets ios,android

   • 获取 Bundle ID：

     rename_plus getBundleId --targets android

注意事项

1. 兼容性问题：该插件可能不兼容多味配置（flavor setup）。如果遇到 API 变化，请参考更新后的功能。
2. 权限问题：在 Windows 上运行时，可能会遇到路径变量或权限问题。建议使用以下替代命令：

   flutter pub run rename_plus <command> [arguments]

   或者：

   dart run rename_plus <command> [arguments]