Skip to content

Commit afa5eb5

Browse files
docs(core): document the @nrwl => @nx rescope (#16403)
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
1 parent f537a4c commit afa5eb5

File tree

339 files changed

+2621
-2445
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

339 files changed

+2621
-2445
lines changed

docs/generated/cli/generate.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,43 +24,43 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
2424
Generate a new Angular application:
2525

2626
```shell
27-
nx generate @nrwl/angular:app myapp
27+
nx generate @nx/angular:app myapp
2828
```
2929

3030
Generate a new React application:
3131

3232
```shell
33-
nx generate @nrwl/react:app myapp
33+
nx generate @nx/react:app myapp
3434
```
3535

3636
Generate a new web component application:
3737

3838
```shell
39-
nx generate @nrwl/web:app myapp
39+
nx generate @nx/web:app myapp
4040
```
4141

4242
Generate a new Node application:
4343

4444
```shell
45-
nx generate @nrwl/node:app myapp
45+
nx generate @nx/node:app myapp
4646
```
4747

4848
Generate a new Angular library application:
4949

5050
```shell
51-
nx generate @nrwl/angular:library mylibrary
51+
nx generate @nx/angular:library mylibrary
5252
```
5353

5454
Generate a new React library application:
5555

5656
```shell
57-
nx generate @nrwl/react:library mylibrary
57+
nx generate @nx/react:library mylibrary
5858
```
5959

6060
Generate a new Node library application:
6161

6262
```shell
63-
nx generate @nrwl/node:library mylibrary
63+
nx generate @nx/node:library mylibrary
6464
```
6565

6666
## Options

docs/generated/cli/list.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,10 @@ List the plugins installed in the current workspace:
2323
nx list
2424
```
2525

26-
List the generators and executors available in the `@nrwl/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
26+
List the generators and executors available in the `@nx/web` plugin if it is installed (If the plugin is not installed `nx` will show advice on how to add it to your workspace):
2727

2828
```shell
29-
nx list @nrwl/web
29+
nx list @nx/web
3030
```
3131

3232
## Options

docs/generated/cli/migrate.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
title: 'migrate - CLI command'
33
description:
44
'Creates a migrations file or runs migrations from the migrations file.
5-
- Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)
5+
- Migrate packages and create migrations.json (e.g., nx migrate @nx/workspace@latest)
66
- Run migrations (e.g., nx migrate --run-migrations=migrations.json). Use flag --if-exists to run migrations only if the migrations file exists.'
77
---
88

99
# migrate
1010

1111
Creates a migrations file or runs migrations from the migrations file.
1212

13-
- Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)
13+
- Migrate packages and create migrations.json (e.g., nx migrate @nx/workspace@latest)
1414
- Run migrations (e.g., nx migrate --run-migrations=migrations.json). Use flag --if-exists to run migrations only if the migrations file exists.
1515

1616
## Usage
@@ -35,16 +35,16 @@ Update all Nx plugins to "9.0.0". This will generate migrations.json:
3535
nx migrate 9.0.0
3636
```
3737

38-
Update @nrwl/workspace and generate the list of migrations starting with version 8.0.0 of @nrwl/workspace and @nrwl/node, regardless of what is installed locally:
38+
Update @nx/workspace and generate the list of migrations starting with version 8.0.0 of @nx/workspace and @nx/node, regardless of what is installed locally:
3939

4040
```shell
41-
nx migrate @nrwl/workspace@9.0.0 --from="@nrwl/workspace@8.0.0,@nrwl/node@8.0.0"
41+
nx migrate @nx/workspace@9.0.0 --from="@nx/workspace@8.0.0,@nx/node@8.0.0"
4242
```
4343

44-
Update @nrwl/workspace to "9.0.0". If it tries to update @nrwl/react or @nrwl/angular, use version "9.0.1":
44+
Update @nx/workspace to "9.0.0". If it tries to update @nx/react or @nx/angular, use version "9.0.1":
4545

4646
```shell
47-
nx migrate @nrwl/workspace@9.0.0 --to="@nrwl/react@9.0.1,@nrwl/angular@9.0.1"
47+
nx migrate @nx/workspace@9.0.0 --to="@nx/react@9.0.1,@nx/angular@9.0.1"
4848
```
4949

5050
Update another-package to "12.0.0". This will update other packages and will generate migrations.json file:
@@ -107,7 +107,7 @@ Exclude migrations that should have been applied on previous updates. To be used
107107

108108
Type: `string`
109109

110-
Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nrwl/react@12.0.0,@nrwl/js@12.0.0")
110+
Use the provided versions for packages instead of the ones installed in node_modules (e.g., --from="@nx/react@12.0.0,@nx/js@12.0.0")
111111

112112
### help
113113

@@ -135,7 +135,7 @@ Enable prompts to confirm whether to collect optional package updates and migrat
135135

136136
Type: `string`
137137

138-
The target package and version (e.g, @nrwl/workspace@13.0.0)
138+
The target package and version (e.g, @nx/workspace@13.0.0)
139139

140140
### runMigrations
141141

@@ -147,7 +147,7 @@ Execute migrations from a file (when the file isn't provided, execute migrations
147147

148148
Type: `string`
149149

150-
Use the provided versions for packages instead of the ones calculated by the migrator (e.g., --to="@nrwl/react@12.0.0,@nrwl/js@12.0.0")
150+
Use the provided versions for packages instead of the ones calculated by the migrator (e.g., --to="@nx/react@12.0.0,@nx/js@12.0.0")
151151

152152
### version
153153

docs/generated/cli/workspace-generator.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Preview the changes without updating files
3131

3232
Type: `string`
3333

34-
Name of the generator (e.g., @nrwl/js:library, library)
34+
Name of the generator (e.g., @nx/js:library, library)
3535

3636
### help
3737

docs/generated/devkit/ngcli_adapter.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,12 @@ Example:
6868

6969
```typescript
7070
overrideCollectionResolutionForTesting({
71-
'@nrwl/workspace': path.join(
71+
'@nx/workspace': path.join(
7272
__dirname,
7373
'../../../../workspace/generators.json'
7474
),
75-
'@nrwl/angular': path.join(__dirname, '../../../../angular/generators.json'),
76-
'@nrwl/linter': path.join(__dirname, '../../../../linter/generators.json'),
75+
'@nx/angular': path.join(__dirname, '../../../../angular/generators.json'),
76+
'@nx/linter': path.join(__dirname, '../../../../linter/generators.json'),
7777
});
7878
```
7979

@@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({
9191

9292
### wrapAngularDevkitSchematic
9393

94-
**wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../devkit/documents/nrwl_devkit#tree), `generatorOptions`: { `[k: string]`: `any`; }) => `Promise`<`any`\>
94+
**wrapAngularDevkitSchematic**(`collectionName`, `generatorName`): (`host`: [`Tree`](../../devkit/documents/nx_devkit#tree), `generatorOptions`: { `[k: string]`: `any`; }) => `Promise`<`any`\>
9595

9696
#### Parameters
9797

@@ -108,10 +108,10 @@ overrideCollectionResolutionForTesting({
108108

109109
##### Parameters
110110

111-
| Name | Type |
112-
| :----------------- | :------------------------------------------------ |
113-
| `host` | [`Tree`](../../devkit/documents/nrwl_devkit#tree) |
114-
| `generatorOptions` | `Object` |
111+
| Name | Type |
112+
| :----------------- | :---------------------------------------------- |
113+
| `host` | [`Tree`](../../devkit/documents/nx_devkit#tree) |
114+
| `generatorOptions` | `Object` |
115115

116116
##### Returns
117117

0 commit comments

Comments
 (0)