Install & Compatibility
Where this runs
tested against v? · npm install
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
muslnode 18–223 runs
build_error
glibcnode 18–223 runs
build_error
Code
Verified usage
Verified import paths — ran on the pinned version, not inferred.
appGenerator
✓ import { appGenerator } from 'nx-vue3-vite'
✗ import { appGenerator } from 'nx-vue3-vite/src/generators/app'
Main generator function for creating a Vue3+Vite application.
componentGenerator
✓ import { componentGenerator } from 'nx-vue3-vite'
✗ const componentGenerator = require('nx-vue3-vite').componentGenerator
ESM-only; CommonJS require() will not work (package is ESM).
libraryGenerator
✓ import { libraryGenerator } from 'nx-vue3-vite'
Generates a Vue3+Vite library.
Creates a new Nx workspace with empty preset, installs the plugin, generates a Vue3+Vite app named 'my-app' with Vitest, then serves it.
npx create-nx-workspace@latest my-workspace --preset empty
cd my-workspace
npm install nx-vue3-vite --save-dev
nx g nx-vue3-vite:app my-app --title 'My App' --test vitest
nx serve my-app
Debug
Known issues
breakingCypress executor may fail to detect test failures in certain configurations.fixUpgrade to v0.23.9 or later.
affects: >=0.23.7 <0.23.9
deprecatedGlobal path aliases via root tsconfig.base.json may be deprecated in future; local alias is the default.fixUse --alias local to avoid depending on root tsconfig.
affects: >=0.0.0
gotchaThe index.html file must remain in the project root; moving it breaks Vite's entry point detection.fixKeep index.html in the root directory; do not move it to src/.
affects: >=0.0.0
breakingBreaking changes when upgrading Nx major versions (e.g., 17 to 18, 18 to 20).fixCheck Nx migration guide and update nx-vue3-vite to a version compatible with your Nx version.
affects: >=0.0.0
Errors
Common errors & fixes
Cannot find module 'nx-vue3-vite' or its corresponding type declarations.
Package not installed or type declarations not generated.
fixRun npm install nx-vue3-vite --save-dev and ensure tsconfig.json includes 'node_modules' in typeRoots.
Error: This generator requires Nx version >= 18.0.0
Using an older Nx version incompatible with the plugin.
fixUpgrade your Nx workspace to v18 or newer.
Error: Cypress e2e tests fail with 'Module not found' for @cypress/vite-dev-server
Missing peer dependency @cypress/vite-dev-server.
fixInstall the missing peer: npm install @cypress/vite-dev-server --save-dev
Audit
Dependencies
viterequiredpeer dependency, required for dev server and build
@vitejs/plugin-vuerequiredpeer dependency, used in vite.config.ts
@nx/devkitrequiredpeer dependency, core Nx plugin framework
cypressoptionalpeer dependency for e2e test runner
@cypress/vite-dev-serveroptionalpeer dependency for Cypress+Vite integration