766d1b32e0
This PR removes installation instructions for Nx < 18 since it has fallen out of support window. Users can always `npm install <plugin>` as usual if they are on an unsupported Nx version, but the docs will assume `nx add` moving forward. The changes are on the plugin overview page: https://nx-dev-git-docs-remove-nx-pre-18-install-nrwl.vercel.app/nx-api
43 lines
1.2 KiB
Markdown
43 lines
1.2 KiB
Markdown
---
|
|
title: Overview of the Nx Vue Plugin
|
|
description: The Nx Plugin for Vue contains generators for managing Vue applications and libraries within an Nx workspace. This page also explains how to configure Vue on your Nx workspace.
|
|
---
|
|
|
|
The Nx plugin for [Vue](https://vuejs.org/).
|
|
|
|
## Setting Up @nx/vue
|
|
|
|
### Generating a new Workspace
|
|
|
|
To create a new workspace with Vue, run `npx create-nx-workspace@latest --preset=vue`.
|
|
|
|
### Installation
|
|
|
|
{% callout type="note" title="Keep Nx Package Versions In Sync" %}
|
|
Make sure to install the `@nx/vue` 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](/recipes/tips-n-tricks/keep-nx-versions-in-sync).
|
|
{% /callout %}
|
|
|
|
In any Nx workspace, you can install `@nx/vue` by running the following command:
|
|
|
|
```shell {% skipRescope=true %}
|
|
nx add @nx/vue
|
|
```
|
|
|
|
This will install the correct version of `@nx/vue`.
|
|
|
|
## Using the @nx/vue Plugin
|
|
|
|
### Generate a new project using Vue
|
|
|
|
To generate a Vue application, run the following:
|
|
|
|
```shell
|
|
nx g @nx/vue:app apps/my-app
|
|
```
|
|
|
|
To generate a Vue library, run the following:
|
|
|
|
```shell
|
|
nx g @nx/vue:lib libs/my-lib
|
|
```
|