Skip to content

Commit

Permalink
docs(core): elaborate output-style option (#23521)
Browse files Browse the repository at this point in the history 
<!-- 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
<!-- This is the behavior we have today -->

`output-style` option's potential values are not explained.

## Expected Behavior
<!-- This is the behavior we should expect with the changes in this PR
-->

add description to `output-style` option's potential values

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

Fixes #20159

![image](https://github.com/nrwl/nx/assets/5159834/15406dcf-80c3-444c-881a-268fcf9704e5)

(cherry picked from commit e32b819)
  • Loading branch information
@elevenpassin @FrozenPandaz
elevenpassin authored and FrozenPandaz committed May 27, 2024
1 parent ade0639 commit 229db9b
Show file tree
Hide file tree
Showing 7 changed files with 51 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/generated/cli/affected.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,13 @@ Choices: [dynamic, static, stream, stream-without-prefixes]

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`
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/cli/release.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,13 @@ Choices: [dynamic, static, stream, stream-without-prefixes]

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`
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/cli/run-many.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,13 @@ Choices: [dynamic, static, stream, stream-without-prefixes]

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`
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/packages/nx/documents/affected.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,13 @@ Choices: [dynamic, static, stream, stream-without-prefixes]

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`
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/packages/nx/documents/release.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,13 @@ Choices: [dynamic, static, stream, stream-without-prefixes]

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`
Expand Down
7 changes: 7 additions & 0 deletions docs/generated/packages/nx/documents/run-many.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,13 @@ Choices: [dynamic, static, stream, stream-without-prefixes]

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`
Expand Down
10 changes: 9 additions & 1 deletion packages/nx/src/command-line/yargs-utils/shared-options.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,15 @@ export function withOutputStyleOption(
]
) {
return yargs.option('output-style', {
describe: 'Defines how Nx emits outputs tasks logs',
describe: `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 |
`,
type: 'string',
choices,
});
Expand Down

0 comments on commit 229db9b

Please sign in to comment.