@nx/react-native - Generators

The @nx/react-native plugin provides various generators to help you create and configure react-native projects within your Nx workspace. Below is a complete reference for all available generators and their options.

For an overview of the plugin and setup instructions, see the @nx/react-native introduction.

application

Create a React Application for Nx.

Usage:

nx generate @nx/react-native:application [options]

Aliases: app

Arguments:

nx generate @nx/react-native:application <directory> [options]

Options

Option	Type	Description	Default
--bundler	string	The bundler to use.	"vite"
--displayName	string	The display name to show in the application. Defaults to name.
--e2eTestRunner	string	Adds the specified e2e test runner.	"none"
--enableTypedLinting	boolean	Whether to enable typed linting. For flat configs, this configures the recommended parserOptions.projectService and tsconfigRootDir. For legacy .eslintrc configs, this configures parserOptions.project. We do not enable this by default for lint performance reasons.	false
--install	boolean	Runs pod install for native modules before building iOS app.	true
--js	boolean	Generate JavaScript files rather than TypeScript files	false
--linter	string	The tool to use for running lint checks.	"none"
--name	string	The name of the application.
--setParserOptionsProject	boolean	Deprecated alias for enableTypedLinting.	false
--skipFormat	boolean	Skip formatting files	false
--skipPackageJson	boolean	Do not add dependencies to package.json.	false
--tags	string	Add tags to the application (used for linting).
--unitTestRunner	string	Test runner to use for unit tests	"none"
--useProjectJson	boolean	Use a project.json configuration file instead of inlining the Nx configuration in the package.json file.

component

Create a React native Component for Nx.

Usage:

nx generate @nx/react-native:component [options]

Aliases: c

Arguments:

nx generate @nx/react-native:component <path> [options]

Options

Option	Type	Description	Default
--classComponent	boolean	Use class components instead of functional component.	false
--export	boolean	When true, the component is exported from the project index.ts (if it exists).	false
--name	string	The component symbol name. Defaults to the last segment of the file path.
--skipFormat	boolean	Skip formatting files.	false
--skipTests	boolean	When true, does not create spec.ts test files for the new component.	false

convert-to-inferred

Convert existing React Native project(s) using @nx/react-native:* executors to use @nx/react-native/plugin. Defaults to migrating all projects. Pass ‘—project’ to migrate only one target.

Usage:

nx generate @nx/react-native:convert-to-inferred [options]

Options

Option	Type	Description	Default
--project	string	The project to convert from using the @nx/react-native:* executors to use @nx/react-native/plugin.
--skipFormat	boolean	Whether to format files at the end of the migration.	false

library

Create a React Native Library for Nx.

Usage:

nx generate @nx/react-native:library [options]

Aliases: lib

Arguments:

nx generate @nx/react-native:library <directory> [options]

Options

Option	Type	Description	Default
--buildable	boolean	Generate a buildable library.	false
--enableTypedLinting	boolean	Whether to enable typed linting. For flat configs, this configures the recommended parserOptions.projectService and tsconfigRootDir. For legacy .eslintrc configs, this configures parserOptions.project. We do not enable this by default for lint performance reasons.	false
--importPath	string	The library name used to import it, like @myorg/my-awesome-lib.
--js	boolean	Generate JavaScript files rather than TypeScript files.	false
--linter	string	The tool to use for running lint checks.	"none"
--name	string	Library name.
--publishable	boolean	Create a publishable library.
--setParserOptionsProject	boolean	Deprecated alias for enableTypedLinting.	false
--skipFormat	boolean	Skip formatting files.	false
--skipPackageJson	boolean	Do not add dependencies to package.json.	false
--skipTsConfig	boolean	Do not update tsconfig.json for development experience.	false
--strict	boolean	Whether to enable tsconfig strict mode or not.	true
--tags	string	Add tags to the library (used for linting).
--unitTestRunner	string	Test runner to use for unit tests.	"none"
--useProjectJson	boolean	Use a project.json configuration file instead of inlining the Nx configuration in the package.json file.

web-configuration

Setup web configuration to React Native apps using react-native-web.

Usage:

nx generate @nx/react-native:web-configuration [options]

Arguments:

nx generate @nx/react-native:web-configuration <project> [options]

Options

Option	Type	Description	Default
--bundler	string [required]	The bundler to use.	"vite"
--skipFormat	boolean	Skip formatting files.	false
--skipPackageJson	boolean	Do not add dependencies to package.json.	false

Getting Help

You can get help for any generator by adding the --help flag:

nx generate @nx/react-native:<generator> --help