Skip to content

Comments

Stabilize --output-format in --watch mode#22908

Merged
ntBre merged 1 commit intobrent/0.15.0from
brent/stabilize-watch-output-format
Jan 29, 2026
Merged

Stabilize --output-format in --watch mode#22908
ntBre merged 1 commit intobrent/0.15.0from
brent/stabilize-watch-output-format

Conversation

@ntBre
Copy link
Contributor

@ntBre ntBre commented Jan 28, 2026

Summary

This PR stabilizes the changes from #21097 and closes #19552. Note that this has
two effects:

  • the default output format in --watch mode becomes full instead of concise
  • the --output-format flag will now be respected

So the default output is now more verbose, but the old stable behavior can be
retained by passing --output-format=concise (or any other supported format)
instead.

Test Plan

Manual testing. I think we tried to set up automated tests in an earlier PR but
decided they were too complex.

I really should have cropped these, but I'll just collapse them instead:

Screenshots

Current output, no --output-format

image

Current output, --output-format=json

The same as above, the flag has no effect

image

PR branch output, no --output-format

Default format is now full rather than concise

image

PR branch output, --output-format=json

JSON output, the flag works

image

@ntBre ntBre changed the title Stabilize --output-format in watch mode Stabilize --output-format in --watch mode Jan 28, 2026
@ntBre ntBre added the cli Related to the command-line interface label Jan 28, 2026
@ntBre ntBre added this to the v0.15 milestone Jan 28, 2026
@ntBre ntBre requested review from amyreese and dylwil3 January 28, 2026 14:50
@astral-sh-bot
Copy link

astral-sh-bot bot commented Jan 28, 2026

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Copy link
Member

@amyreese amyreese left a comment

Choose a reason for hiding this comment

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

Also includes the docker/readme changes.

Summary
--

This PR stabilizes the changes from #21097 and closes #19552. Note that this has
two effects:

- the default output format in `watch` mode becomes `full` instead of `concise`
- the `--output-format` flag will now be respected

So the default output is now more verbose, but the old stable behavior can be
retained by passing `--output-format=concise` (or any other supported format)
instead.

Test Plan
--

Manual testing. I think we tried to set up automated tests in an earlier PR but
decided they were too complex.
@ntBre ntBre force-pushed the brent/stabilize-watch-output-format branch from 5926ba4 to f3cd3a3 Compare January 28, 2026 17:45
@ntBre ntBre merged commit 03c672c into brent/0.15.0 Jan 29, 2026
41 checks passed
@ntBre ntBre deleted the brent/stabilize-watch-output-format branch January 29, 2026 14:03
@ntBre ntBre mentioned this pull request Jan 29, 2026
3 tasks
ntBre added a commit that referenced this pull request Jan 29, 2026
Summary
--

I forgot to include this in #22908, but I think it's okay just to land this on
`main` instead of the release branch because the warning isn't actually visible
to users anyway, as reported in #19552. We're stabilizing `--output-format`
actually being used with `--watch`, so we can just delete this warning.

Fixes #19552
ntBre added a commit that referenced this pull request Jan 29, 2026
Summary
--

I forgot to include this in #22908, but I think it's okay just to land
this on
`main` instead of the release branch because the warning isn't actually
visible
to users anyway, as reported in #19552. We're stabilizing
`--output-format`
actually being used with `--watch`, so we can just delete this warning.

Fixes #19552
ntBre added a commit that referenced this pull request Feb 3, 2026
Summary
--

This PR stabilizes the changes from #21097 and closes #19552. Note that
this has
two effects:

- the default output format in `--watch` mode becomes `full` instead of
`concise`
- the `--output-format` flag will now be respected

So the default output is now more verbose, but the old stable behavior
can be
retained by passing `--output-format=concise` (or any other supported
format)
instead.

Test Plan
--

Manual testing. I think we tried to set up automated tests in an earlier
PR but
decided they were too complex.

I really should have cropped these, but I'll just collapse them instead:

<details><summary>Screenshots</summary>
<p>

### Current output, no `--output-format`

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/a758daa8-534e-4dab-9cff-858321cede61"
/>

### Current output, `--output-format=json`

The same as above, the flag has no effect

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/e5b0743a-6bd5-4dec-83e0-de24e44567ca"
/>

### PR branch output, no `--output-format`

Default format is now `full` rather than `concise`

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/cf51947d-52e3-4420-83e7-73530557c324"
/>

### PR branch output, `--output-format=json`

JSON output, the flag works

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/e7127c5a-88ad-4b2a-80b4-193b63b631ee"
/>

</p>
</details>
ntBre added a commit that referenced this pull request Feb 3, 2026
Summary
--

This PR stabilizes the changes from #21097 and closes #19552. Note that
this has
two effects:

- the default output format in `--watch` mode becomes `full` instead of
`concise`
- the `--output-format` flag will now be respected

So the default output is now more verbose, but the old stable behavior
can be
retained by passing `--output-format=concise` (or any other supported
format)
instead.

Test Plan
--

Manual testing. I think we tried to set up automated tests in an earlier
PR but
decided they were too complex.

I really should have cropped these, but I'll just collapse them instead:

<details><summary>Screenshots</summary>
<p>

### Current output, no `--output-format`

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/a758daa8-534e-4dab-9cff-858321cede61"
/>

### Current output, `--output-format=json`

The same as above, the flag has no effect

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/e5b0743a-6bd5-4dec-83e0-de24e44567ca"
/>

### PR branch output, no `--output-format`

Default format is now `full` rather than `concise`

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/cf51947d-52e3-4420-83e7-73530557c324"
/>

### PR branch output, `--output-format=json`

JSON output, the flag works

<img width="783" height="514" alt="image"
src="https://github.com/user-attachments/assets/e7127c5a-88ad-4b2a-80b4-193b63b631ee"
/>

</p>
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cli Related to the command-line interface

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Check Watch does not show output format error message from clearing too late

3 participants