28 Commits

Author SHA1 Message Date
Jack Hsu
8fa7065cf1
docs(misc): update generator examples to use new directory/path positional args (#28144)
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 #
2024-09-30 13:20:10 -04:00
Craigory Coppola
a308e1dc6b
fix(core): prevent graph output from being truncated (#23446)
<!-- Please make sure you have read the submission guidelines before
posting an PR -->
<!--
https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr
-->

<!-- Please make sure that your commit message follows our format -->
<!-- Example: `fix(nx): must begin with lowercase` -->

## Current Behavior
--graph stdout and --file stdout aren't documented. When printing graph
to stdout, its possible for some output to get missed.

## Expected Behavior
Existing flags are documented, and `--print` is more discoverable. We
await stdout finishing before exiting the program.

## Related Issue(s)
<!-- Please link the issue being fixed so it gets closed when this is
merged. -->

Fixes #18689
2024-05-31 18:05:26 -04:00
Craigory Coppola
da4fb5a9a5
docs(core): add quiet flag to generate docs (#21378) 2024-02-22 15:55:23 -05:00
Emily Xiong
40cbae2fae
docs(core): add exec doc (#21046)
Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
2024-01-09 10:34:04 -05:00
Isaac Mann
afa5eb59fa
docs(core): document the @nrwl => @nx rescope (#16403)
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
2023-04-27 18:14:59 -04:00
Zachary DeRose
5e2bf07908
docs(core): fixing some references to old architect terminology (#16424)
Co-authored-by: Isaac Mann <isaacplmann@gmail.com>
2023-04-27 08:28:53 -04:00
Doni Rubiagatra
3c0b0ec3c4
docs(core): fix duplicate generate description for dryRun (#13759)
Fixes https://github.com/nrwl/nx/issues/12196
2022-12-12 13:51:48 -05:00
Benjamin Cabanes
1e5297edfc
docs(core): use shell code blocks (#12587) 2022-10-13 21:25:40 +00:00
Isaac Mann
e717660102
docs(nx-dev): diataxis restructure (#11649)
* docs(nxdev): restructure docs to diataxis style

* docs(nxdev): cleanup

* docs(nxdev): fix links

* chore(nxdev): format

* docs(nxdev): fix broken images

* docs(nxdev): fix links

* docs(nxdev): fix links

* docs(nxdev): fix links

* docs(nxdev): tweaks

* docs(nxdev): redirect rules

* docs(nxdev): fixes
2022-08-29 08:36:55 -04:00
Leosvel Pérez Espinosa
7c2f9452fa docs(core): remove invalid cli commands 2022-05-16 10:06:12 -04:00
Isaac Mann
753277ad50
docs(nxdev): customize webpack guide (#8857)
* docs(nxdev): customize webpack guide

* docs(core): add webpack-merge

* docs(core): webpack config example

Co-authored-by: Isaac Mann <isaacplmann+git@gmail.com>
2022-03-25 11:27:16 -04:00
Benjamin Cabanes
0fea1c8cca
docs(nxdev): remove flavour and versions patterns from docs (#8416) 2022-01-06 20:09:01 +00:00
ben
9827b5258c docs(nxdev): remove flavors and versions 2022-01-06 11:37:40 -05:00
Benjamin Cabanes
ea0d65b019
docs(nxdev): better api generator templates (#8109) 2021-12-10 12:18:46 -05:00
Miroslav Jonaš
878b44d997
docs(testing): add clarification for baseUrl when devServerTarget is set (#7622) 2021-11-05 15:24:36 +01:00
Jason Jean
85f92e740e
feat(misc): simplify npm scripts generated (#6764) 2021-08-20 12:07:26 -04:00
Emily Xiong
b8584a6f18
feat(react): add react fast refresh to webpack (#5612) 2021-05-18 15:47:18 -04:00
Vivek
d1b09eaabd
cleanup(misc): make code more consistent and fix typos 2021-03-23 13:03:17 -04:00
Vivek More
af27f975a4 docs(misc): improve grammar and fix typos 2021-03-15 10:27:35 -04:00
Andrew Luca
5f49a53dcc docs(testing): fix typo in cli/e2e 2021-02-11 11:06:02 -05:00
Isaac Mann
35015dd891 cleanup(docs): update terminology for docs related to nx/devkit 2020-12-06 13:52:08 -05:00
Hugh Loughrey
94c230bc4d docs(docs): update documentation on e2e watch mode
ISSUES CLOSED: 2963
2020-08-05 22:49:55 -04:00
Victor Savkin
3cd9f4fe6c feat(misc): add nx package to make installing global cli easier 2020-07-29 12:16:12 -04:00
n0p
f51e005a8c Update generate.md
Added web component app option.
Should 'next' application added also ?

I am a bit confused by Angular application option. It is the same as new Node application ?
2020-05-21 23:45:23 -04:00
Benjamin Cabanes
be77d15e6e
docs(core): examples generating library (#2872) 2020-04-20 08:11:20 -04:00
Victor Savkin
e17fcdca0f docs(core): fix links + minor changes 2020-03-30 15:38:20 -04:00
Isaac Mann
ce56206373
docs(misc): add CLI overview page and misc docs updates (#2734)
* docs(docs): remove migration articles from menu

* docs(nest): fix typo

* docs(docs): fix typo in e2e docs

* docs(docs): cli-overview

Co-authored-by: Isaac Mann <isaacplmann+git@gmail.com>
2020-03-27 06:45:19 -05:00
Victor Savkin
5ab3521fdc docs(core): clean up cli docs 2020-03-25 17:22:17 -04:00