Simplifying App Renaming and Bundle ID Changes in Flutter

When it comes to mobile app development, adapting a project’s name and package ID to meet branding and organisational requirements is essential. For Flutter developers, changing an app's name or its bundle ID (on Android) can be streamlined with a few steps. Here’s a quick guide to renaming your Flutter app and setting the desired bundle ID for both Android and iOS platforms.

Why Rename?

Renaming a Flutter app and updating its bundle ID ensures that it aligns with brand guidelines and avoids conflicts with other apps on users’ devices. This process is straightforward using Flutter’s ecosystem and a helpful package.

Step-by-Step Guide to Renaming a Flutter App and Bundle ID

Step 1: Add the Required Package

To streamline the renaming process, add the rename package to your project’s pubspec.yaml file under dev_dependencies:

dev_dependencies:
  flutter_test:
    sdk: flutter
  rename: ^3.0.2        

Step 2: Activate the Package

Once added, activate the rename package by running this command in the root directory of your project:

flutter pub global activate rename        

Step 3: Set Your App Name

Set the desired app name for specific platforms with the following command:

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

This command sets the name for both iOS and Android platforms.

Step 4: Set the Bundle ID

To set the bundle ID (important for Android and iOS apps), use:

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

This command changes the Android bundle ID to “com.example.bundleId.” Follow a similar process to set the bundle ID for other platforms.

Note: Steps beyond this point are optional, depending on your project's specific structure or naming requirements.

Step 5: Update the Android Namespace

Next, update the namespace in your Android project’s app/build.gradle:

android {
  namespace "add.your.new.bundleId"
}        

Step 6: Adjust the Folder Structure

Navigate to app/src/main/ and modify the folder structure based on your new bundle ID. Depending on your programming language, go to either Kotlin or java.

Step 7: Update the Project Name

At the top of your pubspec.yaml, update the app name under name: . This update may cause import errors, which can be fixed by renaming all imports and exports.

Pro Tip: For renaming imports and exports, open the project in Android Studio, select the lib folder, and press Command+Shift+R to perform a mass rename across the project.