nx/packages/vue/docs/component-examples.md
Jack Hsu 8fa7065cf1
docs(misc): update generator examples to use new directory/path positional args (#28144)
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 #
2024-09-30 13:20:10 -04:00

1.2 KiB

title description
Vue and Nuxt component generator examples This page contains examples for the @nx/vue:component generator.

This generator will help you generate components for your Vue or your Nuxt projects.

Examples

Create a new component for your Vue app

nx g @nx/vue:component my-app/src/app/my-cmp

Create a new component for your Nuxt app

As recommended in the Nuxt documentation, place your components into the components directory of your app. Nuxt automatically imports any components in this directory.

Running the following will create a new component in the my-app/src/components directory:

nx g @nx/nuxt:component my-app/src/components/my-cmp

Create a new page for your Nuxt app

As stated in the Nuxt documentation, Nuxt provides a file-based routing to create routes within your web application. Place your pages into the pages directory of your app.

Running the following will create a new component (page) in the my-app/src/pages directory:

nx g @nx/nuxt:component my-app/src/pages/my-page