-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
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
- Loading branch information
1 parent
1e7cd7e
commit a308e1d
Showing
20 changed files
with
532 additions
and
157 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,44 +1,163 @@ | ||
--- | ||
title: 'run - CLI command' | ||
description: 'Runs a target defined for your project. Target definitions can be found in the `scripts` property of the project `package.json`, or in the `targets` property of the project `project.json` file.' | ||
description: 'Run a target for a project | ||
(e.g., nx run myapp:serve:production). | ||
You can also use the infix notation to run a target: | ||
(e.g., nx serve myapp --configuration=production) | ||
You can skip the use of Nx cache by using the --skip-nx-cache option.' | ||
--- | ||
|
||
# run | ||
|
||
Runs a target defined for your project. Target definitions can be found in the `scripts` property of the project `package.json`, or in the `targets` property of the project `project.json` file. | ||
Run a target for a project | ||
(e.g., nx run myapp:serve:production). | ||
|
||
You can also use the infix notation to run a target: | ||
(e.g., nx serve myapp --configuration=production) | ||
|
||
You can skip the use of Nx cache by using the --skip-nx-cache option. | ||
|
||
## Usage | ||
|
||
```shell | ||
nx run <target> [options] | ||
nx run [project][:target][:configuration] [_..] | ||
``` | ||
|
||
Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpx nx`. | ||
Install `nx` globally to invoke the command directly using `nx`, or use `npx nx`, `yarn nx`, or `pnpm nx`. | ||
|
||
### Examples | ||
|
||
Run the `build` target for the `myapp` : | ||
Run the target build for the myapp project: | ||
|
||
```shell | ||
nx run myapp:build | ||
``` | ||
|
||
Run the target build for the myapp project, with production configuration: | ||
|
||
```shell | ||
nx run myapp:build:production | ||
``` | ||
|
||
Preview the task graph that Nx would run inside a webview: | ||
|
||
```shell | ||
nx run myapp:build --graph | ||
``` | ||
|
||
Save the task graph to a file: | ||
|
||
```shell | ||
nx run myapp:build --graph=output.json | ||
``` | ||
|
||
Print the task graph to the console: | ||
|
||
```shell | ||
nx run myapp:build | ||
nx run myapp:build --graph=stdout | ||
``` | ||
|
||
Run the `build` target for the `myapp` project with a `production` configuration: | ||
Run's a target named build:test for the myapp project. Note the quotes around the target name to prevent "test" from being considered a configuration: | ||
|
||
```shell | ||
nx run myapp:build:production | ||
nx run myapp:"build:test" | ||
``` | ||
|
||
## Options | ||
|
||
### configuration (-c) | ||
### batch | ||
|
||
Type: `boolean` | ||
|
||
Default: `false` | ||
|
||
Run task(s) in batches for executors which support batches | ||
|
||
### configuration | ||
|
||
Type: `string` | ||
|
||
This is the configuration to use when performing tasks on projects | ||
|
||
### exclude | ||
|
||
Type: `string` | ||
|
||
Exclude certain projects from being processed | ||
|
||
### graph | ||
|
||
A named builder configuration, defined in the "configurations" section of the workspace configuration file. The builder uses the named configuration to run the given target. | ||
Type: `string` | ||
|
||
### help | ||
Show the task graph of the command. Pass a file path to save the graph data instead of viewing it in the browser. Pass "stdout" to print the results to the terminal. | ||
|
||
Show help | ||
### nxBail | ||
|
||
Type: `boolean` | ||
|
||
Default: `false` | ||
|
||
Stop command execution after the first failed task | ||
|
||
### nxIgnoreCycles | ||
|
||
Type: `boolean` | ||
|
||
Default: `false` | ||
|
||
Ignore cycles in the task graph | ||
|
||
### output-style | ||
|
||
Type: `string` | ||
|
||
Choices: [dynamic, static, stream, stream-without-prefixes, compact] | ||
|
||
Defines how Nx emits outputs tasks logs | ||
|
||
| option | description | | ||
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| dynamic | use dynamic output life cycle, previous content is overwritten or modified as new outputs are added, display minimal logs by default, always show errors. This output format is recommended on your local development environments. | | ||
| static | uses static output life cycle, no previous content is rewritten or modified as new outputs are added. This output format is recommened for CI environments. | | ||
| stream | nx by default logs output to an internal output stream, enable this option to stream logs to stdout / stderr | | ||
| stream-without-prefixes | nx prefixes the project name the target is running on, use this option remove the project name prefix from output | | ||
|
||
### parallel | ||
|
||
Type: `string` | ||
|
||
Max number of parallel processes [default is 3] | ||
|
||
### project | ||
|
||
Type: `string` | ||
|
||
Target project | ||
|
||
### runner | ||
|
||
Type: `string` | ||
|
||
This is the name of the tasks runner configured in nx.json | ||
|
||
### skipNxCache | ||
|
||
Type: `boolean` | ||
|
||
Default: `false` | ||
|
||
Rerun the tasks even when the results are available in the cache | ||
|
||
### verbose | ||
|
||
Type: `boolean` | ||
|
||
Prints additional information about the commands (e.g., stack traces) | ||
|
||
### version | ||
|
||
Type: `boolean` | ||
|
||
Show version number |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.