Add RUFF_FORMAT environment variable support
#1731
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
| @@ -93,7 +93,7 @@ pub struct Cli { | |||
| #[arg(long, value_delimiter = ',')] | |||
| pub per_file_ignores: Option<Vec<PatternPrefixPair>>, | |||
| /// Output serialization format for error messages. | |||
| #[arg(long, value_enum)] | |||
| #[arg(long, value_enum, env = "RUFF_FORMAT")] | |||
There was a problem hiding this comment.
Wow, I had no idea this existed. That is so useful.
renovate bot
added a commit
to ixm-one/pytest-cmake-presets
that referenced
this pull request
Jan 8, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [ruff](https://togithub.com/charliermarsh/ruff) | `^0.0.214` -> `^0.0.215` | [](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.215`](https://togithub.com/charliermarsh/ruff/releases/tag/v0.0.215) [Compare Source](https://togithub.com/charliermarsh/ruff/compare/v0.0.214...v0.0.215) #### What's Changed - Automatically remove duplicate dictionary keys by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#1710 - Add `ComparableExpr` hierarchy for comparing expressions by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#1721 - Respect isort:skip action comment by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#1722 - Treat failures to fix TypedDict conversions as debug logs by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#1723 - Implement `--isolated` CLI flag by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#1727 - Add more unittest assert methods to PT009 by [@​harupy](https://togithub.com/harupy) in [astral-sh/ruff#1730 - Add `RUFF_FORMAT` environment variable support by [@​messense](https://togithub.com/messense) in [astral-sh/ruff#1731 - Move RUFF_CACHE_DIR to Clap's env support by [@​charliermarsh](https://togithub.com/charliermarsh) in [astral-sh/ruff#1733 - buf-fix: flake8\_simplify SIM212 by [@​chammika-become](https://togithub.com/chammika-become) in [astral-sh/ruff#1732 - Remove `assertNotContains` by [@​harupy](https://togithub.com/harupy) in [astral-sh/ruff#1729 **Full Changelog**: astral-sh/ruff@v0.0.214...v0.0.215 </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:eyJjcmVhdGVkSW5WZXIiOiIzNC44NC4yIiwidXBkYXRlZEluVmVyIjoiMzQuODQuMiJ9--> Signed-off-by: Renovate Bot <bot@renovateapp.com> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
charliermarsh
pushed a commit
that referenced
this pull request
Apr 17, 2024
](https://renovatebot.com){kind=link}
## Summary I've added support for configuring the `ruff check` output file via the environment variable `RUFF_OUTPUT_FILE` akin to #1731. This is super useful when, e.g., generating a [GitLab code quality report](https://docs.gitlab.com/ee/ci/testing/code_quality.html#implement-a-custom-tool) while running Ruff as a pre-commit hook. Usually, `ruff check` should print its human-readable output to `stdout`, but when run through `pre-commit` _in a GitLab CI job_ it should write its output in `gitlab` format to a file. So, to override these two settings only during CI, environment variables come handy, and `RUFF_OUTPUT_FORMAT` already exists but `RUFF_OUTPUT_FILE` has been missing. A (simplified) GitLab CI job config for this scenario might look like this: ```yaml pre-commit: stage: test image: python variables: RUFF_OUTPUT_FILE: gl-code-quality-report.json RUFF_OUTPUT_FORMAT: gitlab before_script: - pip install pre-commit script: - pre-commit run --all-files --show-diff-on-failure artifacts: reports: codequality: gl-code-quality-report.json ``` ## Test Plan I tested it manually.
This pull request was closed.
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.
Resolves #1716