Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(core): elaborate output-style option #23521

Merged

Conversation

elevenpassin
Copy link
Contributor

@elevenpassin elevenpassin commented May 19, 2024

Current Behavior

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

Expected Behavior

add description to output-style option's potential values

Related Issue(s)

Fixes #20159

image

Copy link

vercel bot commented May 19, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
nx-dev ✅ Ready (Inspect) Visit Preview May 20, 2024 4:20pm

Copy link
Collaborator

@isaacplmann isaacplmann left a comment

Choose a reason for hiding this comment

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

Docs look good

@elevenpassin
Copy link
Contributor Author

@isaacplmann I also found an undocumented option here: compact, do you want this documented or is this supposed to be internal?

found it here: https://github.com/nrwl/nx/blob/master/packages/nx/src/tasks-runner/run-command.ts#L251-L252

@isaacplmann
Copy link
Collaborator

CI isn't passing because you need to run nx format

I'm not sure why compact is treated in a special way. @AgentEnder is more likely to have the answer for that.

@elevenpassin elevenpassin force-pushed the docs/elaborate-output-style-option branch from e3d1549 to 891e4e1 Compare May 20, 2024 16:10
@AgentEnder
Copy link
Member

I'm not certain either - I'd leave it undocumented for now :)

@AgentEnder AgentEnder merged commit e32b819 into nrwl:master May 27, 2024
6 checks passed
FrozenPandaz pushed a commit that referenced this pull request May 28, 2024
<!-- 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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation for output-style option doesn't explain choices
3 participants