flutter_flavorizr 1.0.7

A flutter utility to easily create flavors in your flutter application

Flutter Flavorizr

A flutter utility to easily create flavors in your flutter application

Getting Started

Let's start by setting up our environment in order to run Flutter Flavorizr

Prerequisites

Side note: this tool works better on a new and clean Flutter project. Since some processors reference some existing files and a specific base structure, it could be possible that running Flutter Flavorizr over an existing project could throw errors.

Before running Flutter Flavorizr, you must install the following software:

• Ruby
• Gem
• Xcodeproj (through RubyGems)

These prerequisites are needed to manipulate the iOS project and schemes. If you are interested in flavorizing Android only, you can skip this step. Keep in mind that you will have to use a custom instructions set with Android and Flutter processors only, otherwise an error will occur.

Installation

This package is intended to support development of Dart projects. In general, put it under dev_dependencies, in your pubspec.yaml:

dev_dependencies:
  flutter_flavorizr: ^1.0.7

You can install packages from the command line:

pub get

Create your flavors

Once all of the prerequisites have been installed and you have added flutter_flavorizr as a dev dependency, you have to edit your pubspec.yaml and define the flavors.

Example

Add a new key named flavorizr and define two sub-items: app and flavors. Under the flavors array you can define the name of the flavors, in our example apple and banana. For each flavor you have to specify the app name, the applicationId and the bundleId.

flavorizr:
  app:
    android:
      flavorDimensions: "flavor-type"
    ios:

  flavors:
    apple:
      app:
        name: "Apple App"

      android:
        applicationId: "com.example.apple"

      ios:
        bundleId: "com.example.apple"

    banana:
      app:
        name: "Banana App"

      android:
        applicationId: "com.example.banana"
      ios:
        bundleId: "com.example.banana"

Available fields

flavorizr

key	type	default	required	description
app	Object		true	An object describing the general capabilities of an app
flavors	Array		true	An array of items. Each of them describes a flavor configuration
instructions	Array		false	An array of instructions to customize the flavorizr process
assetsUrl	String	https://github.com/AngeloAvv/flutter_flavorizr/releases/download/v1.0.7/assets.zip	false	A string containing the URL of the zip assets file. The default points to the current release
ide	String		false	The IDE in which the app is being developed. Currently only vscode or idea

Available instructions

value	category	description
assets:download	Miscellaneous	Downloads the assets zip from the network
assets:extract	Miscellaneous	Extracts the downloaded zip in the project .tmp directory
assets:clean	Miscellaneous	Removes the assets from the project directory
android:buildGradle	Android	Adds the flavors to the Android build.gradle file
android:androidManifest	Android	Changes the reference of the app name in the AndroidManifest.xml
android:dummyAssets	Android	Generates some default icons for your custom flavors
flutter:flavors	Flutter	Creates the flutter flavor configuration file
flutter:app	Flutter	Creates the app.dart entry
flutter:pages	Flutter	Creates a set of default pages for the app
flutter:targets	Flutter	Creates a set of targets for each flavor instance
ios:xcconfig	iOS	Creates a set of xcconfig files for each flavor and build configuration
ios:buildTargets	iOS	Creates a set of build targets for each flavor and build configuration
ios:schema	iOS	Creates a set of schemas for each flavor
ios:dummyAssets	iOS	Generates some default icons for your custom flavors
ios:plist	iOS	Updates the info.plist file
ios:launchScreen	iOS	Creates a set of launchscreens for each flavor
ide:config	IDE	Generates debugging configurations for each flavor of your IDE

android (under app)

key	type	default	required	description
flavorDimensions	String	"flavor-type"	false	The value of the flavorDimensions in the android build.gradle file

app (under flavorname)

key	type	default	required	description
name	String		true	The name of the App

android (under flavorname)

key	type	default	required	description
applicationId	String		true	The applicationId of the Android App
generateDummyAssets	bool	true	false	True if you want to generate dummy assets (icon set, strings, etc)

ios (under flavorname)

key	type	default	required	description
bundleId	String		true	The bundleId of the iOS App
generateDummyAssets	bool	true	false	True if you want to generate dummy assets (xcassets, etc)

Usage

When you finished defining the flavorizr configuration, you can proceed by running the script with:

flutter pub run flutter_flavorizr

You can also run flutter_flavorizr with a custom set of processors by appending the -p (or --processors) param followed by the processor names separated by comma:

flutter pub run flutter_flavorizr -p <processor_1>,<processor_2>

Example

flutter pub run flutter_flavorizr -p assets:download
flutter pub run flutter_flavorizr -p assets:download,assets:extract

Run your flavors

Once the process has generated the flavors, you can run them by typing

flutter run --flavor <flavorName> -t lib/main-<flavorName>.dart

Example

flutter run --flavor apple -t lib/main-apple.dart
flutter run --flavor banana -t lib/main-banana.dart

Customize your app

Flutter_flavorizr creates different dart files in the lib folder. In the flavors.dart file we have the F class which contains all of our customizations.

class F {
  static Flavor appFlavor;

  static String get title {
    switch (appFlavor) {
      case Flavor.APPLE:
        return 'Apple App';
      case Flavor.BANANA:
        return 'Banana App';
      default:
        return 'title';
    }
  }

}

The process creates a simple title customization: a switch which checks the current appFlavor (defined in our app starting point) and returns the correct value. Here you can write whatever you want, you can create your custom app color palette, differentiate the URL action of a button, and so on.

If you are wondering how to use these getters, you can find an example under the pages folder: in the my_home_page.dart file, the page shown after the launch of the app, we can see a clear reference on the title getter defined in the F class.

Further developments

• Let the user define its custom set of available instructions.
• Create Firebase processors.
• Use a groovy parser to better manipulate the build.gradle file

Please feel free to submit new issues if you encounter some problems with it.

License

Flutter Flavorizr is available under the MIT license. See the LICENSE file for more info.