8fa7065cf1
This PR updates examples in `.md` files (both docs and blog posts) to use positional args. Nx 20 changes the position arg to be either `directory` for apps/libs or `path` for artifacts (e.g. components). So before you'd do this: ``` nx g app myapp --directory=apps/myapp nx g lib mylib --directory=libs/mylib nx g lib mylib --directory=libs/nested/mylib nx g lib @acme/foo --directory=libs/@acme/foo --importPath=@acme/foo nx g component foo --directory=libs/ui/src/foo --pascalCaseFiles ``` Will now be simplified to ``` nx g app apps/myapp nx g lib libs/mylib nx g lib libs/nested/mylib nx g lib libs/@acme/foo # name and import path are both "@acme/foo" nx g component libs/ui/src/foo/Foo ``` For cases where `name` and `importPath` need to be changed, you can always manually specify them. ``` nx g lib libs/nested/foo # name is foo nx g lib libs/nested/foo --name=nested-foo # specify name with prefix nx g lib libs/@acme/foo --name # use "foo" as name and don't match importPath nx g lib libs/@internal/foo --importPath=@acme/foo # different importPath from name <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
66 lines
1.7 KiB
Markdown
66 lines
1.7 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`.
|
|
|
|
{% callout type="note" title="Vue Standalone Tutorial" %}
|
|
For a full tutorial experience, follow the [Vue Standalone Tutorial](/getting-started/tutorials/vue-standalone-tutorial)
|
|
{% /callout %}
|
|
|
|
### 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:
|
|
|
|
{% tabs %}
|
|
{% tab label="Nx 18+" %}
|
|
|
|
```shell {% skipRescope=true %}
|
|
nx add @nx/vue
|
|
```
|
|
|
|
This will install the correct version of `@nx/vue`.
|
|
|
|
{% /tab %}
|
|
{% tab label="Nx < 18" %}
|
|
|
|
Install the `@nx/vue` package with your package manager.
|
|
|
|
```shell {% skipRescope=true %}
|
|
npm add -D @nx/vue
|
|
```
|
|
|
|
{% /tab %}
|
|
{% /tabs %}
|
|
|
|
## 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
|
|
```
|
|
|
|
## More Documentation
|
|
|
|
- [Vue Standalone Tutorial](/getting-started/tutorials/vue-standalone-tutorial)
|