Skip to content

Commit

Permalink
docs(core): document the @nrwl => @nx rescope (#16403)
Browse files Browse the repository at this point in the history
Co-authored-by: FrozenPandaz <jasonjean1993@gmail.com>
  • Loading branch information
isaacplmann and FrozenPandaz committed Apr 27, 2023
1 parent f537a4c commit afa5eb5
Show file tree
Hide file tree
Showing 339 changed files with 2,621 additions and 2,445 deletions.
14 changes: 7 additions & 7 deletions docs/generated/cli/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,43 +24,43 @@ Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`
Generate a new Angular application:

```shell
nx generate @nrwl/angular:app myapp
nx generate @nx/angular:app myapp
```

Generate a new React application:

```shell
nx generate @nrwl/react:app myapp
nx generate @nx/react:app myapp
```

Generate a new web component application:

```shell
nx generate @nrwl/web:app myapp
nx generate @nx/web:app myapp
```

Generate a new Node application:

```shell
nx generate @nrwl/node:app myapp
nx generate @nx/node:app myapp
```

Generate a new Angular library application:

```shell
nx generate @nrwl/angular:library mylibrary
nx generate @nx/angular:library mylibrary
```

Generate a new React library application:

```shell
nx generate @nrwl/react:library mylibrary
nx generate @nx/react:library mylibrary
```

Generate a new Node library application:

```shell
nx generate @nrwl/node:library mylibrary
nx generate @nx/node:library mylibrary
```

## Options
Expand Down
4 changes: 2 additions & 2 deletions docs/generated/cli/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@ List the plugins installed in the current workspace:
nx list
```

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):
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):

```shell
nx list @nrwl/web
nx list @nx/web
```

## Options
Expand Down
18 changes: 9 additions & 9 deletions docs/generated/cli/migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
title: 'migrate - CLI command'
description:
'Creates a migrations file or runs migrations from the migrations file.
- Migrate packages and create migrations.json (e.g., nx migrate @nrwl/workspace@latest)
- Migrate packages and create migrations.json (e.g., nx migrate @nx/workspace@latest)
- Run migrations (e.g., nx migrate --run-migrations=migrations.json). Use flag --if-exists to run migrations only if the migrations file exists.'
---

# migrate

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

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

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

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:
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:

```shell
nx migrate @nrwl/workspace@9.0.0 --from="@nrwl/workspace@8.0.0,@nrwl/node@8.0.0"
nx migrate @nx/workspace@9.0.0 --from="@nx/workspace@8.0.0,@nx/node@8.0.0"
```

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

```shell
nx migrate @nrwl/workspace@9.0.0 --to="@nrwl/react@9.0.1,@nrwl/angular@9.0.1"
nx migrate @nx/workspace@9.0.0 --to="@nx/react@9.0.1,@nx/angular@9.0.1"
```

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

Type: `string`

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")
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")

### help

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

Type: `string`

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

### runMigrations

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

Type: `string`

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")
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")

### version

Expand Down
2 changes: 1 addition & 1 deletion docs/generated/cli/workspace-generator.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Preview the changes without updating files

Type: `string`

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

### help

Expand Down
16 changes: 8 additions & 8 deletions docs/generated/devkit/ngcli_adapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,12 @@ Example:

```typescript
overrideCollectionResolutionForTesting({
'@nrwl/workspace': path.join(
'@nx/workspace': path.join(
__dirname,
'../../../../workspace/generators.json'
),
'@nrwl/angular': path.join(__dirname, '../../../../angular/generators.json'),
'@nrwl/linter': path.join(__dirname, '../../../../linter/generators.json'),
'@nx/angular': path.join(__dirname, '../../../../angular/generators.json'),
'@nx/linter': path.join(__dirname, '../../../../linter/generators.json'),
});
```

Expand All @@ -91,7 +91,7 @@ overrideCollectionResolutionForTesting({

### wrapAngularDevkitSchematic

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

#### Parameters

Expand All @@ -108,10 +108,10 @@ overrideCollectionResolutionForTesting({

##### Parameters

| Name | Type |
| :----------------- | :------------------------------------------------ |
| `host` | [`Tree`](../../devkit/documents/nrwl_devkit#tree) |
| `generatorOptions` | `Object` |
| Name | Type |
| :----------------- | :---------------------------------------------- |
| `host` | [`Tree`](../../devkit/documents/nx_devkit#tree) |
| `generatorOptions` | `Object` |

##### Returns

Expand Down

1 comment on commit afa5eb5

@vercel
Copy link

@vercel vercel bot commented on afa5eb5 Apr 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-nrwl.vercel.app
nx-five.vercel.app
nx-dev-git-master-nrwl.vercel.app
nx.dev

Please sign in to comment.