Flutter重命名文件或目录插件rename的使用

概述

Rename CLI Tool 是一个用于修改Flutter项目中应用程序名称（AppName）和包标识符（BundleId）的工具，支持多个平台，包括：

• iOS
• Android
• MacOS
• Linux
• Web (仅限应用名称相关功能)
• Windows

警告

• 该插件可能与Flavor设置不兼容。
• API已经历了重大更改，许多元素已被弃用，请参考使用部分了解更新后的功能。

安装

要安装 Rename CLI Tool，请执行以下命令：

flutter pub global activate rename

如果遇到问题，可以尝试使用以下命令：

dart pub global run rename

或者

flutter pub global run rename

确保你的环境变量配置正确，以便可以直接通过命令行运行 rename 命令。有关路径变量的问题，请参阅Dart官方文档。

使用方法

获取帮助

显示通用帮助信息或特定命令的帮助信息：

rename help

对于特定命令的帮助信息：

rename help <commandName>

例如，获取 setAppName 的帮助信息：

rename help setAppName

获取当前 AppName

检索指定平台的当前应用程序名称：

rename getAppName --targets ios

同时检索多个平台的应用程序名称：

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

设置 AppName

为指定平台设置新的应用程序名称：

rename setAppName --targets ios,android --value "YourAppName"

这将把iOS和Android平台的应用名称设置为 “YourAppName”。

获取当前 BundleId

检索指定平台的当前包标识符：

rename getBundleId --targets android

设置 BundleId

为指定平台设置新的包标识符：

rename setBundleId --targets android --value "com.example.bundleId"

这将把Android平台的包标识符设置为 “com.example.bundleId”。

参数说明

命令

• setAppName: 更改给定目标平台的应用名称。需要提供 --value 选项。
• setBundleId: 更改给定目标平台的包标识符。需要提供 --value 选项。
• getAppName: 显示给定目标平台的应用名称。
• getBundleId: 显示给定目标平台的包标识符。

选项

• -t, --targets: 指定目标平台，如 android, ios, web, windows, macos, linux。此参数对所有命令都是必需的。
• -v, --value: 设置指定命令的值。对于 setAppName 和 setBundleId 是必需的。
• -h, --help: 显示相关命令的可用指令。

示例代码

下面是一个简单的Flutter应用示例代码，展示了如何创建一个基本的Flutter应用：

import 'package:flutter/material.dart';

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

class MyApp extends StatelessWidget {
  const MyApp({super.key});

  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      title: 'Flutter Demo',
      theme: ThemeData(
        colorScheme: ColorScheme.fromSeed(seedColor: Colors.deepPurple),
        useMaterial3: true,
      ),
      home: const MyHomePage(title: 'Flutter Demo Home Page'),
    );
  }
}

class MyHomePage extends StatefulWidget {
  const MyHomePage({super.key, required this.title});
  final String title;

  @override
  State<MyHomePage> createState() => _MyHomePageState();
}

class _MyHomePageState extends State<MyHomePage> {
  int _counter = 0;

  void _incrementCounter() {
    setState(() {
      _counter++;
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        backgroundColor: Theme.of(context).colorScheme.inversePrimary,
        title: Text(widget.title),
      ),
      body: Center(
        child: Column(
          mainAxisAlignment: MainAxisAlignment.center,
          children: <Widget>[
            const Text(
              'You have pushed the button this many times:',
            ),
            Text(
              '$_counter',
              style: Theme.of(context).textTheme.headlineMedium,
            ),
          ],
        ),
      ),
      floatingActionButton: FloatingActionButton(
        onPressed: _incrementCounter,
        tooltip: 'Increment',
        child: const Icon(Icons.add),
      ),
    );
  }
}

其他信息

即将推出的功能

• 提供桌面应用程序以简化使用。
• 集成 interact package 和 pub_updater package。
• 支持默认平台设置。

许可证

本项目采用MIT许可证，详情请参见LICENSE文件。

贡献者

欢迎贡献！请参照我们的贡献指南开始。

更新日志

有关项目的重大变更，请参阅CHANGELOG。

支持

如有任何问题或建议，请提交issue，我们非常感谢您的反馈。

作者

本项目由Onat Çipli创建并维护。

故障排除

在Windows上命令无法工作

如果你在非管理员终端上运行 rename 命令时遇到问题，可能是由于权限限制或路径变量配置错误导致的。你可以尝试以下替代命令格式：

• 使用Flutter:

  flutter pub run rename <command> [arguments]
  

• 使用Dart:

  dart run rename <command> [arguments]
  

这些替代命令通过Dart或Flutter工具链显式调用 rename 工具，可以绕过某些Windows配置中的路径或权限问题。