The Nx plugin for Nuxt.
Setting up a new Nx workspace with @nx/nuxt
You can create a new workspace that uses Nuxt with one of the following commands:
- Generate a new monorepo with a Nuxt app
❯
npx create-nx-workspace@latest --preset=nuxt
Installation
Keep Nx Package Versions In SyncMake sure to install the @nx/nuxt version that matches the version of nx in your repository. If the version numbers get out of sync, you can encounter some difficult to debug errors. You can fix Nx version mismatches with this recipe.
In any Nx workspace, you can install @nx/nuxt by running the following command:
❯
nx add @nx/nuxt
This will install the correct version of @nx/nuxt.
How @nx/nuxt Infers Tasks
The @nx/nuxt plugin will create a task for any project that has an Nuxt configuration file present. Any of the following files will be recognized as an Nuxt configuration file:
nuxt.config.jsnuxt.config.tsnuxt.config.mjsnuxt.config.mtsnuxt.config.cjsnuxt.config.cts
View Inferred Tasks
To view inferred tasks for a project, open the project details view in Nx Console or run nx show project my-project --web in the command line.
@nx/nuxt Configuration
The @nx/nuxt/plugin is configured in the plugins array in nx.json.
1{
2 "plugins": [
3 {
4 "plugin": "@nx/nuxt/plugin",
5 "options": {
6 "buildTargetName": "build",
7 "testTargetName": "test",
8 "serveTargetName": "serve"
9 }
10 }
11 ]
12}
13The buildTargetName, testTargetName and serveTargetName options control the names of the inferred Nuxt tasks. The default names are build, test and serve.
Using Nuxt
Generate a new Nuxt app
❯
nx g @nx/nuxt:app my-app
Deploy a Nuxt app
Once you are ready to deploy your Nuxt application, you have absolute freedom to choose any hosting provider that fits your needs.
We have detailed how to deploy your Nuxt application to Vercel in a separate guide.