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 #
46 lines
1.3 KiB
Markdown
46 lines
1.3 KiB
Markdown
## Examples
|
|
|
|
{% tabs %}
|
|
{% tab label="Simple Library" %}
|
|
|
|
Creates the `my-ui-lib` library with an `ui` tag:
|
|
|
|
```bash
|
|
nx g @nx/angular:library libs/my-ui-lib --tags=ui
|
|
```
|
|
|
|
{% /tab %}
|
|
|
|
{% tab label="Publishable Library" %}
|
|
|
|
Creates the `my-lib` library that can be built producing an output following the Angular Package Format (APF) to be distributed as an NPM package:
|
|
|
|
```bash
|
|
nx g @nx/angular:library libs/my-lib --publishable --import-path=@my-org/my-lib
|
|
```
|
|
|
|
{% /tab %}
|
|
|
|
{% tab label="Buildable Library" %}
|
|
|
|
Creates the `my-lib` library with support for incremental builds:
|
|
|
|
```bash
|
|
nx g @nx/angular:library libs/my-lib --buildable
|
|
```
|
|
|
|
{% /tab %}
|
|
|
|
{% tab label="Nested Folder & Import"%}
|
|
Creates the `my-lib` library in the `nested` directory and sets the import path to `@myorg/nested/my-lib`:
|
|
|
|
{% 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](/deprecated/as-provided-vs-derived) for more details.
|
|
{% /callout %}
|
|
|
|
```bash
|
|
nx g @nx/angular:library libs/nested/my-lib --importPath=@myorg/nested/my-lib
|
|
```
|
|
|
|
{% /tab %}
|