@nxrocks/nx-flutter v9.0.1

nx-flutter

Nx Plugin adding first class support for Flutter in your Nx workspace

Contents

• Features
• Setup
• Generators
• Executors
• Compatibility with Nx

Features

Here is a list of some of the coolest features of the plugin:

• ✅ Generation of Flutter applications/packages/modules/plugins based on Flutter cli API
• ✅ Building, packaging, testing, etc your Flutter projects

• ✅ Integration with Nx's dependency graph (through nx dep-graph or nx affected:dep-graph): this allows you to visualize the dependencies of any Flutter projects inside your workspace, just like Nx natively does it for JS/TS-based projects!

  Example of running the nx dep-graph command on a workspace with 2 Flutter projects inside

• ...

Setup

You can now use our own create-nx-flutter CLI to easily create a Nx workspace, that comes with this plugin pre-installed!

Simply run:

# npm
npx create-nx-flutter@latest
# or
# yarn
yarn create nx-flutter

and you are good to go‧o‧o‧o! 🚀

More information here: create-nx-flutter

Otherwise, this is the traditional way of setting things up:

1. Creating the Nx workspace

This plugin relies on flutter's command-line to do its job. So, you must have flutter installed on your system. If not, head to flutter.dev/docs/get-started/install and follow installation instructions for your OS.

Then, if you have not already, create an Nx workspace with the following:

# npm
npx create-nx-workspace@latest

# yarn
yarn create nx-workspace@latest

2. Installing the Plugin

Then you need to install the plugin in order to generate Flutter applications later on.

# npm
npm install @nxrocks/nx-flutter --save-dev

# yarn
yarn add @nxrocks/nx-flutter --dev

Generators

This plugin is composed of 1 main generator:

• project generator

Generating Projects (project generator)

Simply run the project generator with the following command:

nx g @nxrocks/nx-flutter:project <app-folder>

you can also use the following aliases to call the generator: prj, new, or create

You will be prompted for entering the most commonly customized generation options (like application's package, description, template, etc).

To skip the interactive prompt, or if you want to customize all non-prompted options, you can pass them along directly when running the command, as such:

nx g @nxrocks/nx-flutter:project <app-folder> --optionName1 optionValue1 ... --optionNameN optionValueN

Generation Options

Here the list of available generation options :

Executors

Once your app is generated, you can now use executors to manage it.

Here the list of available executors1:

1 : Actual executors in your workspace.json will depend on the type of flutter project (template), target platforms that you choose to generate.

Each executor is based on an original project-level flutter command. The name is just kebab-cased to match executors' naming conventions. Besides, the arguments accepted by each executor, are the same as the original flutter command they are based upon, encapsulated under a generic --args='...' option.

For example:

$ flutter gen-l10n --header "/// my header"

becomes 👉🏾

$ nx gen-l10n your-flutterapp --args='--header="/// my header"'

Note that the original flutter command name (gen-l10n) has been camelcased for creating its nx-flutter equivalent (gen-l10n)

Note that the arguments of the original flutter command are wrapped under --args='...' option in the nx-flutter equivalent

Compatibility with Nx

Every Nx plugin relies on the underlying Nx Workspace/DevKit it runs on. This table provides the compatibility matrix between major versions of Nx workspace and this plugin.

License

Copyright (c) 2020-present Tine Kondo. Licensed under the MIT License (MIT)