@nx/vueSee schema

@nx/vue:component

Create a Vue Component for Nx.

Usage

1nx generate component ... 2
1nx g c ... #same 2

By default, Nx will search for component in the default collection provisioned in workspace.json.

You can specify the collection explicitly as follows:

1nx g @nx/vue:component ... 2

Show what will be generated without writing to disk:

1nx g component ... --dry-run 2

Examples

Generate a component one in the my-app application at my-app/src/app/one:

1nx g @nx/vue:component my-app/src/app/one --unitTestRunner=vitest 2

Options

path

Required
string

The file path to the component without the file extension (e.g. my-app/src/app/my-component/my-component generates the file my-app/src/app/my-component/my-component.vue). Relative to the current working directory.

export

e
boolean
Default: false

When true, the component is exported from the project index.ts (if it exists).

fileName

string

Create a component with this file name.

inSourceTests

boolean
Default: false

When using Vitest, separate spec files will not be generated and instead will be included within the source files. Read more on the Vitest docs site: https://vitest.dev/guide/in-source.html

js

boolean
Default: false

Generate JavaScript files rather than TypeScript files.

name

string

The component symbol name. It not provided, it defaults to the last segment of the provided path.

routing

boolean

Generate a library with routes.

skipTests

Internal
boolean
Default: false

When true, does not create spec.ts test files for the new component.

skipFormat

Internal
boolean
Default: false

Skip formatting files.