@nx/vite:init

Initialize Vite in the workspace.

This is a generator will initialize Vite.js in your workspace. It will install all the necessary dependencies. You can read more about how this generator works, in the Vite package overview page.

string

You don't need to use this generator on its own.

This generator will be called automatically when you are either converting an existing React or Web app to use Vite, using the @nx/vite:configuration generator, or when you are creating a new React or Web app using the @nx/react:app or @nx/web:app generators, if you choose vite as the bundler.

If you need to for some reason, you can use it on its own like this:

nx g @nx/vite:init

Nx 15 and lower use @nrwl/ instead of @nx/

Examples

Install all the necessary dependencies for Vite and the React plugin

nx g @nx/vite:init --uiFramework=react

Nx 15 and lower use @nrwl/ instead of @nx/

Install all the necessary dependencies for Vite

nx g @nx/vite:init --uiFramework=none

Nx 15 and lower use @nrwl/ instead of @nx/

Usage

nx generate init ...

nx g ng-add ... #same

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

You can specify the collection explicitly as follows:

nx g @nx/vite:init ...

Nx 15 and lower use @nrwl/ instead of @nx/

Show what will be generated without writing to disk:

nx g init ... --dry-run

Options

compiler

string

Default: babel

Accepted values: babel, swc

Compiler to use for Vite when UI Framework is React.

includeLib

boolean

Default: false

Add dependencies needed to build libraries.

uiFramework

string

Default: react

Accepted values: react, none

UI Framework to use for Vite.