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 #
2.7 KiB
| title | description |
|---|---|
| Nuxt application generator examples | This page contains examples for the @nx/nuxt:app generator. |
Your new Nuxt application will be generated with the following directory structure, following the suggested directory structure for Nuxt applications:
my-nuxt-app
├── nuxt.config.ts
├── project.json
├── src
│ ├── app.vue
│ ├── assets
│ │ └── css
│ │ └── styles.css
│ ├── components
│ │ └── NxWelcome.vue
│ ├── pages
│ │ ├── about.vue
│ │ └── index.vue
│ ├── public
│ │ └── favicon.ico
│ └── server
│ ├── api
│ │ └── greet.ts
│ └── tsconfig.json
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.spec.json
└── vitest.config.ts
Your new app will contain the following:
- Two pages (home and about) under
pages - A component (
NxWelcome) undercomponents - A
greetAPI endpoint that returns a JSON response under/api/greet - Configuration for
vitest - Your app's entrypoint (
app.vue) will contain the navigation links to the home and about pages, and thenuxt-pagecomponent to display the contents of your pages.
Examples
{% tabs %} {% tab label="Create app in a directory" %}
{% callout type="note" title="Directory Flag Behavior Changes" %}
The command below uses the as-provided directory flag behavior, which is the default in Nx 16.8.0. If you're on an earlier version of Nx or using the derived option, use --directory=nested. See the as-provided vs. derived documentation for more details.
{% /callout %}
nx g @nx/nuxt:app =apps/nested/myapp
{% /tab %}
{% tab label="Create app with vitest configured" %}
nx g @nx/nuxt:app apps/nested/myapp --unitTestRunner=vitest
{% /tab %}
{% tab label="Use plain JavaScript (not TypeScript)" %}
nx g @nx/nuxt:app apps/myapp --js
{% /tab %} {% /tabs %}
Generate pages and components
You can use the the @nx/vue:component generator to generate new pages and components for your application. You can read more on the @nx/vue:component generator documentation page, but here are some examples:
{% tabs %} {% tab label="New page" %}
nx g @nx/nuxt:component my-app/src/pages/my-page
{% /tab %}
{% tab label="New component" %}
nx g @nx/nuxt:component my-app/src/components/my-cmp
{% /tab %} {% /tabs %}