@nrwl/vite:configuration

Add Vite Configuration to an application.

This is a generator for setting up Vite configuration for an existing React or Web application. It will change the build and serve targets to use the @nrwl/vite executors for serving and building the application. This generator will modify your code, so make sure to commit your changes before running it.

nx g @nrwl/vite:configuration

When running this generator, you will be prompted to provide the following:

  • The project, as the name of the project you want to generate the configuration for.
  • The uiFramework you want to use. Supported values are: react and none.

You must provide a project and a uiFramework for the generator to work.

You can read more about how this generator works, in the Vite package overview page.

Examples

Change a React app to use Vite

nx g @nrwl/vite:configuration --project=my-app --uiFramework=react

This will change the my-app project to use Vite instead of the default Webpack configuration. The changes this generator will do are described in the Vite package overview page.

Change a Web app to use Vite

nx g @nrwl/vite:configuration --project=my-app --uiFramework=none

This will change the my-app project to use Vite instead of the existing bundler configuration.

Usage

nx generate configuration ...
nx g ng-add ... #same

By default, Nx will search for configuration in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

nx g @nrwl/vite:configuration ...

Show what will be generated without writing to disk:

nx g configuration ... --dry-run

Options

includeLib

boolean
Default: false

Add a library build option and skip the server option.

newProject

boolean
Default: false

Is this a new project?

project

string

The name of the project.

uiFramework

string
Default: none
Accepted values: react, none

UI Framework to use for Vite.