diff --git a/packages/create-nx-workspace/bin/create-nx-workspace.ts b/packages/create-nx-workspace/bin/create-nx-workspace.ts index dcc8ac0677..71459008c3 100644 --- a/packages/create-nx-workspace/bin/create-nx-workspace.ts +++ b/packages/create-nx-workspace/bin/create-nx-workspace.ts @@ -410,11 +410,10 @@ async function determineStack( name: `react`, message: `React: Configures a React application with your framework of choice.`, }, - // TODO(v17): Enable when @nx/vue is released. - // { - // name: `vue`, - // message: `Vue: Configures a Vue application with modern tooling.`, - // }, + { + name: `vue`, + message: `Vue: Configures a Vue application with modern tooling.`, + }, { name: `angular`, message: `Angular: Configures a Angular application with modern tooling.`, diff --git a/packages/vue/docs/application-examples.md b/packages/vue/docs/application-examples.md new file mode 100644 index 0000000000..beaeae51a9 --- /dev/null +++ b/packages/vue/docs/application-examples.md @@ -0,0 +1,47 @@ +## Examples + +{% tabs %} +{% tab label="Simple Application" %} + +Create an application named `my-app`: + +```shell +nx g @nx/vue:application my-app +``` + +{% /tab %} + +{% tab label="Application using Vite as bundler" %} + +Create an application named `my-app`: + +```shell +nx g @nx/vue:app my-app +``` + +{% /tab %} + +{% tab label="Specify directory and style extension" %} + +Create an application named `my-app` in the `my-dir` directory and use `scss` for styles: + +{% 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=my-dir`. See the [workspace layout documentation](/reference/nx-json#workspace-layout) for more details. +{% /callout %} + +```shell +nx g @nx/vue:app my-app --directory=apps/my-dir/my-app --style=scss +``` + +{% /tab %} + +{% tab label="Add tags" %} + +Add tags to the application (used for linting). + +```shell +nx g @nx/vue:app my-app --tags=scope:admin,type:ui +``` + +{% /tab %} +{% /tabs %} diff --git a/packages/vue/package.json b/packages/vue/package.json index c76961e9f0..14adaf42e9 100644 --- a/packages/vue/package.json +++ b/packages/vue/package.json @@ -1,7 +1,7 @@ { "name": "@nx/vue", "version": "0.0.1", - "private": true, + "private": false, "description": "The Vue plugin for Nx contains executors and generators for managing Vue applications and libraries within an Nx workspace. It provides:\n\n\n- Integration with libraries such as Jest, Cypress, and Storybook.\n\n- Generators for applications, libraries, and more.\n\n- Library build support for publishing packages to npm or other registries.\n\n- Utilities for automatic workspace refactoring.", "repository": { "type": "git", diff --git a/scripts/documentation/package-schemas/package-metadata.ts b/scripts/documentation/package-schemas/package-metadata.ts index a28acb98e3..10e5a498b9 100644 --- a/scripts/documentation/package-schemas/package-metadata.ts +++ b/scripts/documentation/package-schemas/package-metadata.ts @@ -120,6 +120,10 @@ export function findPackageMetadataList( return sync(`${packagesDir}/*`, { ignore: [`${packagesDir}/cli`] }) .map((folderPath: string): PackageData => { const folderName = folderPath.substring(packagesDir.length + 1); + + // TODO(v17): Remove this once @nx/vue is published + if (folderName === 'vue') return null; + const relativeFolderPath = folderPath.replace(absoluteRoot, ''); const packageJson = readJsonSync( join(folderPath, 'package.json'),