Skip to content

Commit

Permalink
feat(misc): add nx package to make installing global cli easier
Browse files Browse the repository at this point in the history
  • Loading branch information
vsavkin committed Jul 29, 2020
1 parent 93140c5 commit 3cd9f4f
Show file tree
Hide file tree
Showing 89 changed files with 250 additions and 83 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ Select the preset that works best for you. You can always add plugins later.
? Default stylesheet format CSS
```

If it's your first Nx project, the command will recommend you to install `@nrwl/cli` globally, so you can invoke `nx` directly without going through yarn or npm.
If it's your first Nx project, the command will recommend you to install the `nx` package globally, so you can invoke `nx` directly without going through yarn or npm.

## Serving Application

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/api/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ can see, for each package its dependencies.
| @nrwl/react | @nrwl/cypress, @nrwl/jest, @nrwl/web | @nrwl/workspace |
| @nrwl/next | @nrwl/cypress, @nrwl/jest, @nrwl/web, @nrwl/react | @nrwl/workspace |
| @nrwl/web | @nrwl/cypress, @nrwl/jest, @nrwl/linter | @nrwl/workspace |
| @nrwl/workspace | @nrwl/cli | |
| @nrwl/workspace | nx | |

## Angular

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Print applications affected by changes
nx affected:apps
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Build applications and publishable libraries affected by changes
nx affected:build
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected-dep-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Graph dependencies affected by changes
nx affected:dep-graph
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected-e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Run e2e tests for the applications affected by changes
nx affected:e2e
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected-libs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Print libraries affected by changes
nx affected:libs
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Lint projects affected by changes
nx affected:lint
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Test projects affected by changes
nx affected:test
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/affected.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Run task for affected projects
nx affected
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ nx build <project> [options]
nx run <project>:build [options]
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/dep-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Graph dependencies within workspace
nx dep-graph
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ nx e2e <project>
nx run <project>:e2e
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/format-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Check for un-formatted files
nx format:check
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

## Options

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/format-write.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Overwrite un-formatted files
nx format:write
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

## Options

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ nx generate <collection:schematic>
nx g <schematic>
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ nx lint <project> [options]
nx run <project>:lint [options]
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Lists installed plugins, capabilities of installed plugins and other available p
nx list
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/migrate.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
nx migrate
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/print-affected.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Graph execution plan
nx print-affected
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Reports useful version numbers to copy into the Nx issue template
nx report
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

## Options

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/run-many.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Run task for multiple projects
nx run-many
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Runs an Architect target with an optional custom builder configuration defined i
nx run <target> [options]
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/serve.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ nx serve <project> [options]
nx run <project>:serve [options]
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ nx test <project> [options]
nx run <project>:test [options]
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/workspace-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Lint workspace or list of files. Note: To exclude files from this lint rule, you
nx workspace-lint
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

## Options

Expand Down
2 changes: 1 addition & 1 deletion docs/angular/cli/workspace-schematic.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Runs a workspace schematic from the tools/schematics directory
nx workspace-schematic
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

## Options

Expand Down
4 changes: 2 additions & 2 deletions docs/angular/guides/cli-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ Install the Nx CLI globally on your system using your preferred package manager:
Using npm:

```bash
npm install -g @nrwl/cli
npm install -g nx
```

Using yarn:

```bash
yarn global add @nrwl/cli
yarn global add nx
```

After that, you will have an `nx` executable you can use to run commands in your workspace.
Expand Down
4 changes: 2 additions & 2 deletions docs/angular/tutorial/01-create-application.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,13 +85,13 @@ Depending on how your dev env is set up, the command above might result in `Comm
To fix it, you can either install the `nx` cli globally by running:

```bash
npm install -g @nrwl/cli
npm install -g nx
```

or

```bash
yarn global add @nrwl/cli
yarn global add nx
```

Or you can prepend every command with `npm run`:
Expand Down
2 changes: 1 addition & 1 deletion docs/react/api/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ can see, for each package its dependencies.

| PackageName | Dependencies | PeerDependencies |
| --------------- | ------------------------------------------------- | ---------------- |
| @nrwl/workspace | @nrwl/cli | |
| @nrwl/workspace | nx | |
| @nrwl/react | @nrwl/cypress, @nrwl/jest, @nrwl/web | @nrwl/workspace |
| @nrwl/next | @nrwl/cypress, @nrwl/jest, @nrwl/web, @nrwl/react | @nrwl/workspace |
| @nrwl/web | @nrwl/cypress, @nrwl/jest, @nrwl/linter | @nrwl/workspace |
Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected-apps.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Print applications affected by changes
nx affected:apps
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected-build.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Build applications and publishable libraries affected by changes
nx affected:build
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected-dep-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Graph dependencies affected by changes
nx affected:dep-graph
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected-e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Run e2e tests for the applications affected by changes
nx affected:e2e
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected-libs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Print libraries affected by changes
nx affected:libs
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected-lint.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Lint projects affected by changes
nx affected:lint
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Test projects affected by changes
nx affected:test
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/affected.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Run task for affected projects
nx affected
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ nx build <project> [options]
nx run <project>:build [options]
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/dep-graph.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Graph dependencies within workspace
nx dep-graph
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/e2e.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ nx e2e <project>
nx run <project>:e2e
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install the `nx` package globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

### Examples

Expand Down
2 changes: 1 addition & 1 deletion docs/react/cli/format-check.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Check for un-formatted files
nx format:check
```

Install `@nrwl/cli` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.
Install `nx` globally to invoke the command directly using `nx`, or use `npm run nx` or `yarn nx`.

## Options

Expand Down
Loading

0 comments on commit 3cd9f4f

Please sign in to comment.