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 #
105 lines
1.7 KiB
Markdown
105 lines
1.7 KiB
Markdown
---
|
|
title: 'generate - CLI command'
|
|
description: 'Runs a generator that creates and/or modifies files based on a generator from a collection.'
|
|
---
|
|
|
|
# generate
|
|
|
|
Runs a generator that creates and/or modifies files based on a generator from a collection.
|
|
|
|
## Usage
|
|
|
|
```shell
|
|
nx generate <collection:generator>
|
|
```
|
|
|
|
```shell
|
|
nx g <generator>
|
|
```
|
|
|
|
Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`.
|
|
|
|
### Examples
|
|
|
|
Generate a new Angular application:
|
|
|
|
```shell
|
|
nx generate @nx/angular:app apps/myapp
|
|
```
|
|
|
|
Generate a new React application:
|
|
|
|
```shell
|
|
nx generate @nx/react:app apps/myapp
|
|
```
|
|
|
|
Generate a new web component application:
|
|
|
|
```shell
|
|
nx generate @nx/web:app apps/myapp
|
|
```
|
|
|
|
Generate a new Node application:
|
|
|
|
```shell
|
|
nx generate @nx/node:app apps/myapp
|
|
```
|
|
|
|
Generate a new Angular library application:
|
|
|
|
```shell
|
|
nx generate @nx/angular:library libs/mylibrary
|
|
```
|
|
|
|
Generate a new React library application:
|
|
|
|
```shell
|
|
nx generate @nx/react:library libs/mylibrary
|
|
```
|
|
|
|
Generate a new Node library application:
|
|
|
|
```shell
|
|
nx generate @nx/node:library libs/mylibrary
|
|
```
|
|
|
|
## Options
|
|
|
|
### defaults
|
|
|
|
Default: `false`
|
|
|
|
When true, disables interactive input prompts for options with a default.
|
|
|
|
### dryRun
|
|
|
|
Default: `false`
|
|
|
|
When true, preview the changes without updating files.
|
|
|
|
### force
|
|
|
|
Default: `false`
|
|
|
|
When true, forces overwriting of existing files.
|
|
|
|
### interactive
|
|
|
|
Default: `true`
|
|
|
|
When false, disables interactive input prompts.
|
|
|
|
### help
|
|
|
|
Show help and display available generators in the default collection.
|
|
|
|
### quiet
|
|
|
|
Default: `false`
|
|
|
|
When true, disables Nx specific logging related to running the generator or its outputs.
|
|
|
|
### version
|
|
|
|
Show version number
|