Change --fix-only exit semantics to mirror --fix
#4146
Merged
Conversation
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
charliermarsh
added
breaking
PR Check ResultsEcosystem✅ ecosystem check detected no changes. BenchmarkLinuxWindows |
MichaReiser
reviewed
Apr 29, 2023
crates/ruff_cli/src/lib.rs
Outdated
Comment on lines
283
to
296
| if cli.diff { | ||
| if !diagnostics.fixed.is_empty() { | ||
| return Ok(ExitStatus::Failure); | ||
| } | ||
| } else if cli.exit_non_zero_on_fix { | ||
| if !diagnostics.fixed.is_empty() || !diagnostics.messages.is_empty() { | ||
| return Ok(ExitStatus::Failure); | ||
| } else if fix_only { | ||
| if cli.exit_non_zero_on_fix { | ||
| if !diagnostics.fixed.is_empty() { | ||
| return Ok(ExitStatus::Failure); | ||
| } | ||
| } else { | ||
| return Ok(ExitStatus::Success); | ||
| } | ||
| } else { |
There was a problem hiding this comment.
I'm a bit confused. Isn't diff --fix and fix_only --fix-only? If so, shouldn't the cli.diff and fix_only branches be identical?
There was a problem hiding this comment.
No, those aren't the same. --fix, --fix-only, and --diff are all different options.
crates/ruff_cli/src/lib.rs
Outdated
Comment on lines
292
to
295
| } else { | ||
| return Ok(ExitStatus::Success); | ||
| } |
There was a problem hiding this comment.
Nit: Safe to fallthrough.
Suggested change
| } else { | |
| return Ok(ExitStatus::Success); | |
| } | |
| } |
MichaReiser
approved these changes
May 2, 2023
|
Nit: It may be helpful to add some documentation explaining why/when we exit with a negative exit code for each option. |
charliermarsh
force-pushed
the
charlie/fix-only
branch
from
12366ac
to
42e8d9c
Compare
renovate bot
added a commit
to ixm-one/pytest-cmake-presets
that referenced
this pull request
May 5, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://togithub.com/charliermarsh/ruff) | `^0.0.264` -> `^0.0.265` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.265`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.265) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.264...v0.0.265) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Breaking Changes - Change `--fix-only` exit semantics to mirror `--fix` by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#4146 ##### Rules - \[flake8-pyi] PYI020 by [@​arya-k](https://togithub.com/arya-k) in [astral-sh/ruff#4211 - Update B027 to support autofixing by [@​aacunningham](https://togithub.com/aacunningham) in [astral-sh/ruff#4178 - \[`flake8-pyi`] Implement `PYI042` and `PYI043` by [@​arya-k](https://togithub.com/arya-k) in [astral-sh/ruff#4214 - \[`pylint`] Implement import-self (`W0406`) by [@​chanman3388](https://togithub.com/chanman3388) in [astral-sh/ruff#4154 - Warn on PEP 604 syntax not in an annotation, but don't autofix by [@​wookie184](https://togithub.com/wookie184) in [astral-sh/ruff#4170 ##### Bug Fixes - Fix panic in pydocstyle D214 when docstring indentation is empty by [@​madkinsz](https://togithub.com/madkinsz) in [astral-sh/ruff#4216 - Render tabs as 4 spaces in diagnostics by [@​MichaReiser](https://togithub.com/MichaReiser) in [astral-sh/ruff#4132 - Fix era panic caused by out of bound edition by [@​leiserfg](https://togithub.com/leiserfg) in [astral-sh/ruff#4206 - End of statement insertion should occur after newline by [@​dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#4215 - Ignore **debuggerskip** in unused variable checks by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#4229 ##### CLI - Show settings path in `--show-settings` output by [@​dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#4199 ##### Documentation - Allow linking to individual rules by [@​calumy](https://togithub.com/calumy) in [astral-sh/ruff#4158 #### New Contributors - [@​wookie184](https://togithub.com/wookie184) made their first contribution in [astral-sh/ruff#4170 - [@​arya-k](https://togithub.com/arya-k) made their first contribution in [astral-sh/ruff#4211 **Full Changelog**: astral-sh/ruff@v0.0.264...v0.0.265 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/ixm-one/pytest-cmake-presets). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS43MS40IiwidXBkYXRlZEluVmVyIjoiMzUuNzEuNCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
renovate bot
added a commit
to allenporter/flux-local
that referenced
this pull request
May 7, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://togithub.com/charliermarsh/ruff) | `==0.0.264` -> `==0.0.265` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.265`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.265) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.264...v0.0.265) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Breaking Changes - Change `--fix-only` exit semantics to mirror `--fix` by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#4146 ##### Rules - \[flake8-pyi] PYI020 by [@​arya-k](https://togithub.com/arya-k) in [astral-sh/ruff#4211 - Update B027 to support autofixing by [@​aacunningham](https://togithub.com/aacunningham) in [astral-sh/ruff#4178 - \[`flake8-pyi`] Implement `PYI042` and `PYI043` by [@​arya-k](https://togithub.com/arya-k) in [astral-sh/ruff#4214 - \[`pylint`] Implement import-self (`W0406`) by [@​chanman3388](https://togithub.com/chanman3388) in [astral-sh/ruff#4154 - Warn on PEP 604 syntax not in an annotation, but don't autofix by [@​wookie184](https://togithub.com/wookie184) in [astral-sh/ruff#4170 ##### Bug Fixes - Fix panic in pydocstyle D214 when docstring indentation is empty by [@​madkinsz](https://togithub.com/madkinsz) in [astral-sh/ruff#4216 - Render tabs as 4 spaces in diagnostics by [@​MichaReiser](https://togithub.com/MichaReiser) in [astral-sh/ruff#4132 - Fix era panic caused by out of bound edition by [@​leiserfg](https://togithub.com/leiserfg) in [astral-sh/ruff#4206 - End of statement insertion should occur after newline by [@​dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#4215 - Ignore **debuggerskip** in unused variable checks by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#4229 ##### CLI - Show settings path in `--show-settings` output by [@​dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#4199 ##### Documentation - Allow linking to individual rules by [@​calumy](https://togithub.com/calumy) in [astral-sh/ruff#4158 #### New Contributors - [@​wookie184](https://togithub.com/wookie184) made their first contribution in [astral-sh/ruff#4170 - [@​arya-k](https://togithub.com/arya-k) made their first contribution in [astral-sh/ruff#4211 **Full Changelog**: astral-sh/ruff@v0.0.264...v0.0.265 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/flux-local). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS43MS40IiwidXBkYXRlZEluVmVyIjoiMzUuNzEuNCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
renovate bot
added a commit
to allenporter/pyrainbird
that referenced
this pull request
May 7, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://togithub.com/charliermarsh/ruff) | `==0.0.264` -> `==0.0.265` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charliermarsh/ruff</summary> ### [`v0.0.265`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.265) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.264...v0.0.265) <!-- Release notes generated using configuration in .github/release.yml at main --> #### What's Changed ##### Breaking Changes - Change `--fix-only` exit semantics to mirror `--fix` by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#4146 ##### Rules - \[flake8-pyi] PYI020 by [@​arya-k](https://togithub.com/arya-k) in [astral-sh/ruff#4211 - Update B027 to support autofixing by [@​aacunningham](https://togithub.com/aacunningham) in [astral-sh/ruff#4178 - \[`flake8-pyi`] Implement `PYI042` and `PYI043` by [@​arya-k](https://togithub.com/arya-k) in [astral-sh/ruff#4214 - \[`pylint`] Implement import-self (`W0406`) by [@​chanman3388](https://togithub.com/chanman3388) in [astral-sh/ruff#4154 - Warn on PEP 604 syntax not in an annotation, but don't autofix by [@​wookie184](https://togithub.com/wookie184) in [astral-sh/ruff#4170 ##### Bug Fixes - Fix panic in pydocstyle D214 when docstring indentation is empty by [@​madkinsz](https://togithub.com/madkinsz) in [astral-sh/ruff#4216 - Render tabs as 4 spaces in diagnostics by [@​MichaReiser](https://togithub.com/MichaReiser) in [astral-sh/ruff#4132 - Fix era panic caused by out of bound edition by [@​leiserfg](https://togithub.com/leiserfg) in [astral-sh/ruff#4206 - End of statement insertion should occur after newline by [@​dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#4215 - Ignore **debuggerskip** in unused variable checks by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#4229 ##### CLI - Show settings path in `--show-settings` output by [@​dhruvmanila](https://togithub.com/dhruvmanila) in [astral-sh/ruff#4199 ##### Documentation - Allow linking to individual rules by [@​calumy](https://togithub.com/calumy) in [astral-sh/ruff#4158 #### New Contributors - [@​wookie184](https://togithub.com/wookie184) made their first contribution in [astral-sh/ruff#4170 - [@​arya-k](https://togithub.com/arya-k) made their first contribution in [astral-sh/ruff#4211 **Full Changelog**: astral-sh/ruff@v0.0.264...v0.0.265 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://app.renovatebot.com/dashboard#github/allenporter/pyrainbird). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS43MS40IiwidXBkYXRlZEluVmVyIjoiMzUuNzEuNCIsInRhcmdldEJyYW5jaCI6Im1haW4ifQ==--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
After this change, running
ruff --fix-onlywill exit with status code 0 unless the program hits an internal error, whileruff --fix-only --exit-non-zero-on-fixwill exit with status code 1 if at least one diagnostic is fixed. This effectively mirrorsruff --fix, taking into account that non-fixable diagnostics are ignored. Previously, the--exit-non-zero-on-fixflag had no effect when combined with--fix-only.Closes #4092.