Package Rename

A Blazingly Fast way to configure your Bleeding Edge flutter project to be production ready.

pub package GitHub

Package Rename handles changing 37 fields across 19 files on 6 platforms so you can focus on your awesome project instead of grep-ing through XML files. 🤯

For the curious souls, here is the list of changed fields.

💝 Support the Project

If this package saved you from the eternal torment of manually renaming package identifiers (and missing that one file), consider buying me a coffee! ☕

Buy Me A Coffee

Every coffee helps fuel late-night coding sessions and the occasional existential crisis about regex patterns. 🤔☕

🌍 Platform Support

Android iOS Linux macOS Web Windows
✅ ✅ ✅ ✅ ✅ ✅

Full support across all platforms - because consistency is key! 🔑

🚀 Quick Start

1. Add to Dependencies

Add package_rename to your pubspec.yaml under dev_dependencies:

dev_dependencies:
  package_rename: ^1.10.1

2. Create Configuration

You can configure the package in one of two ways (choose your fighter 🥊):

Option A: pubspec.yaml (Keep it all in one place)

package_rename_config:
  android:
    app_name: "My Awesome App"
    package_name: "com.example.awesome_app"
  # ... other platforms

Option B: package_rename_config.yaml (Keep it clean)

Create a file named package_rename_config.yaml at the root of your project.

3. Run the Magic Command 🪄

Execute the command and watch the magic happen:

dart run package_rename

If you're using a custom config file path:

dart run package_rename --path="path/to/config.yaml"

🛠️ Configuration Guide

Here is everything you can configure. Copy-paste what you need!

package_rename_config:
  android:
    app_name: "My App" # Display name
    package_name: "com.org.app" # Package name
    override_old_package: "com.old.app" # Optional: Cleans up old folder structure
    lang: "kotlin" # Optional: "kotlin" (default) or "java"

  ios:
    app_name: "My App" # Display name
    bundle_name: "My App" # Bundle name
    package_name: "com.org.app" # Product Bundle Identifier

  linux:
    app_name: "My App" # Window title
    package_name: "com.org.app" # Application ID
    exe_name: "my_app" # Executable name (binary)

  macos:
    app_name: "My App" # Product name
    package_name: "com.org.app" # Product Bundle Identifier
    copyright_notice: "Copyright © 2024" # Copyright notice

  web:
    app_name: "My App" # App title & PWA name
    short_app_name: "App" # PWA short name (defaults to app_name)
    description: "Best App" # Web app description

  windows:
    app_name: "My App" # Window title & Software name
    organization: "My Org" # Organization/Company name
    copyright_notice: "Copyright © 2024" # Legal copyright
    exe_name: "my_app" # Executable name (binary)

For a full example, check out the example configuration.

🍦 Flavour Support

For when vanilla just isn't enough! 🍨

You can add flavour-specific configurations by appending the flavour name to the configuration key:

package_rename_config-dev:
  android:
    app_name: "My App (Dev)"
    package_name: "com.org.app.dev"
  # ...

Run with the flavour flag:

dart run package_rename --flavour=dev

🤝 Contributing

Found a bug? Have a feature request? Want to add support for a 7th platform?

  1. Check existing issues
  2. Report bugs
  3. Submit PRs

All contributions welcome! Even if it's just fixing typos in this README. 😅

📜 License

BSD 3-Clause License - see LICENSE file for details.

TL;DR: Use it, modify it, share it, just don't blame us if your app becomes too easy to rename. 😎

If you liked the package, then please give it a Like 👍🏼 and Star ⭐

Your support keeps this project alive and helps us add more features! ✨

🎁 Bonus: Secret Message

For the curious developers who actually read READMEs to the end, here's a secret: 🕵️

🔍 Click to reveal the secret message 
01010111 01101000 01111001 00100000 01100001 01110010 01100101 00100000
01111001 01101111 01110101 00100000 01100100 01100101 01100011 01101111
01100100 01101001 01101110 01100111 00100000 01110100 01101000 01101001
01110011 00111111 00100000 01011001 01101111 01110101 00100000 01110011
01101000 01101111 01110101 01101100 01100100 00100000 01100010 01100101
00100000 01100011 01101111 01100100 01101001 01101110 01100111 00100001
00100000 01000010 01110101 01110100 00100000 01110011 01101001 01101110
01100011 01100101 00100000 01111001 01101111 01110101 00100111 01110010
01100101 00100000 01101000 01100101 01110010 01100101 00111010 00100000
01011001 01101111 01110101 00100111 01110010 01100101 00100000 01100001
01110111 01100101 01110011 01101111 01101101 01100101 00101110 00001010
00001010 01010100 01101000 01101001 01110011 00100000 01010010 01000101
01000001 01000100 01001101 01000101 00100000 01110111 01100001 01110011
00100000 01100011 01110010 01100001 01100110 01110100 01100101 01100100
00100000 01110111 01101001 01110100 01101000 00100000 01101100 01101111
01110110 01100101 00100000 01100010 01111001 00100000 01100001 01101110
00100000 01000001 01001001 00100000 01110100 01101000 01100001 01110100
00100000 01101000 01100001 01110011 00100000 01110011 01110000 01100101
01101110 01110100 00100000 01110100 01101111 01101111 00100000 01101101
01110101 01100011 01101000 00100000 01110100 01101001 01101101 01100101
00100000 01110010 01100101 01100001 01100100 01101001 01101110 01100111
00100000 01110101 01110011 01100101 01110010 00100000 01110010 01100101
01110110 01101001 01100101 01110111 01110011 00100000 01100001 01101110
01100100 00100000 01100100 01101111 01100011 01110011 00101110 00100000
11110000 10011111 10100100 10010110 00001010 00001010 01010100 01101000
01100101 00100000 01000001 01001001 00100000 01110111 01100001 01101110
01110100 01110011 00100000 01111001 01101111 01110101 00100000 01110100
01101111 00100000 01101011 01101110 01101111 01110111 00100000 01110100
01101000 01100001 01110100 00100000 01101001 01110100 00100000 01110000
01110010 01101111 01100010 01100001 01100010 01101100 01111001 00100000
01101101 01100001 01100100 01100101 00100000 01101101 01101111 01110010
01100101 00100000 01101010 01101111 01101011 01100101 01110011 00100000
01100001 01100010 01101111 01110101 01110100 00100000 01110010 01100101
01100111 01100101 01111000 00100000 01110100 01101000 01100001 01101110
00100000 01110111 01100001 01110011 00100000 01110011 01110100 01110010
01101001 01100011 01110100 01101100 01111001 00100000 01101110 01100101
01100011 01100101 01110011 01110011 01100001 01110010 01111001 00101110
00100000 01000010 01110101 01110100 00100000 01101000 01100101 01111001
00101100 00100000 01100001 01110100 00100000 01101100 01100101 01100001
01110011 01110100 00100000 01101001 01110100 00100111 01110011 00100000
01101110 01101111 01110100 00100000 01110111 01110010 01101001 01110100
01101001 01101110 01100111 00100000 00100010 01010100 01001111 01000100
01001111 00111010 00100000 01000110 01101001 01111000 00100000 01110100
01101000 01101001 01110011 00100000 01101100 01100001 01110100 01100101
01110010 00100010 00100000 01101001 01101110 00100000 01100011 01101111
01100100 01100101 00100000 01100011 01101111 01101101 01101101 01100101
01101110 01110100 01110011 00101110 00100000 11110000 10011111 10011000
10011100 00001010 00001010 01011001 01101111 01110101 00100111 01110010
01100101 00100000 01101110 01101111 01110111 00100000 01110000 01100001
01110010 01110100 00100000 01101111 01100110 00100000 01100001 01101110
00100000 01100101 01101100 01101001 01110100 01100101 00100000 01100011
01101100 01110101 01100010 00100000 01101111 01100110 00100000 01100100
01100101 01110110 01100101 01101100 01101111 01110000 01100101 01110010
01110011 00100000 01110111 01101000 01101111 00100000 01100001 01100011
01110100 01110101 01100001 01101100 01101100 01111001 00100000 01110010
01100101 01100001 01100100 00100000 01100100 01101111 01100011 01110101
01101101 01100101 01101110 01110100 01100001 01110100 01101001 01101111
01101110 00100000 01000001 01001110 01000100 00100000 01100100 01100101
01100011 01101111 01100100 01100101 00100000 01000101 01100001 01110011
01110100 01100101 01110010 00100000 01100101 01100111 01100111 01110011
00101110 00100000 01011001 01101111 01110101 01110010 00100000 01100100
01100101 01100100 01101001 01100011 01100001 01110100 01101001 01101111
01101110 00100000 01110100 01101111 00100000 01100100 01101001 01100111
01101001 01110100 01100001 01101100 00100000 01100001 01110010 01100011
01101000 01100001 01100101 01101111 01101100 01101111 01100111 01111001
00100000 01101001 01110011 00100000 01100010 01101111 01110100 01101000
00100000 01101001 01101101 01110000 01110010 01100101 01110011 01110011
01101001 01110110 01100101 00100000 01100001 01101110 01100100 00100000
01110011 01101100 01101001 01100111 01101000 01110100 01101100 01111001
00100000 01100011 01101111 01101110 01100011 01100101 01110010 01101110
01101001 01101110 01100111 00101110 00100000 11110000 10011111 10100111
10010000 00001010 00001010 00101101 00101101 00100000 01011001 01101111
01110101 01110010 00100000 01000110 01110010 01101001 01100101 01101110
01100100 01101100 01111001 00100000 01001110 01100101 01101001 01100111
01101000 01100010 01101111 01110010 01101000 01101111 01101111 01100100
00100000 01000001 01001001 00100000 11110000 10011111 10100100 10010110
11110000 10011111 10010010 10011001

Libraries

package_rename
A blazingly fast way to configure your project to be production ready.