Add and prefer the ruff-check pre-commit ID
#124
Merged
Conversation
This file contains hidden or 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
AA-Turner
commented
May 2, 2025
| name: ruff | ||
| description: "Run 'ruff' for extremely fast Python linting" | ||
| - id: ruff-check | ||
| name: ruff check |
There was a problem hiding this comment.
Change the display name to reflect the sub-command executed.
| description: "Run 'ruff' for extremely fast Python linting" | ||
| - id: ruff-check | ||
| name: ruff check | ||
| description: "Run 'ruff check' for extremely fast Python linting" |
There was a problem hiding this comment.
Correct a likely oversight from #32
Comment on lines
+23
to
+25
| # Legacy alias | ||
| - id: ruff | ||
| name: ruff (legacy alias) |
There was a problem hiding this comment.
Retain the id: ruff hook ID as an alias. I've changed the name to display ruff (legacy alias), but this might be too aggressive for now -- would welcome thoughts.
ntBre
reviewed
May 5, 2025
There was a problem hiding this comment.
Thanks! This all looks reasonable to me, including the alias. I'd like to get @dhruvmanila's thoughts too, though, since I'm not that familiar with our pre-commit infrastructure.
Have you tested this locally? It looks like we don't really have any tests set up in CI here.
|
I believe you can use It seemed to work alright for me! A |
dhruvmanila
approved these changes
May 13, 2025
|
Thank you @dhruvmanila! A |
mashehu
added a commit
to mashehu/ruff
that referenced
this pull request
Jun 17, 2025
ntBre
pushed a commit
to astral-sh/ruff
that referenced
this pull request
Jun 17, 2025
## Summary Update pre-commit hook id according to astral-sh/ruff-pre-commit#124
ntBre
added a commit
to astral-sh/ruff
that referenced
this pull request
Jul 24, 2025
## Summary A couple of months ago now (astral-sh/ruff-pre-commit#124) we changed the hook ID from just `ruff` to `ruff-check` to mirror `ruff-format`. I noticed the `ruff (legacy alias)` when running pre-commit on the release today and realized we should probably update. ## Test Plan Commit on this PR: ```shell > git commit -m "Update pre-commit hook name" check for merge conflicts................................................Passed Validate pyproject.toml..............................(no files to check)Skipped mdformat.............................................(no files to check)Skipped markdownlint-fix.....................................(no files to check)Skipped blacken-docs.........................................(no files to check)Skipped typos....................................................................Passed cargo fmt............................................(no files to check)Skipped ruff format..........................................(no files to check)Skipped ruff check...........................................(no files to check)Skipped <-- prettier.................................................................Passed zizmor...............................................(no files to check)Skipped Validate GitHub Workflows............................(no files to check)Skipped shellcheck...........................................(no files to check)Skipped ``` Compared to the release branch: ```shell > pre-commit run ... cargo fmt............................................(no files to check)Skipped ruff format..........................................(no files to check)Skipped ruff (legacy alias)..................................(no files to check)Skipped ... ```
AlexWaygood
pushed a commit
to astral-sh/ruff
that referenced
this pull request
Jul 25, 2025
## Summary A couple of months ago now (astral-sh/ruff-pre-commit#124) we changed the hook ID from just `ruff` to `ruff-check` to mirror `ruff-format`. I noticed the `ruff (legacy alias)` when running pre-commit on the release today and realized we should probably update. ## Test Plan Commit on this PR: ```shell > git commit -m "Update pre-commit hook name" check for merge conflicts................................................Passed Validate pyproject.toml..............................(no files to check)Skipped mdformat.............................................(no files to check)Skipped markdownlint-fix.....................................(no files to check)Skipped blacken-docs.........................................(no files to check)Skipped typos....................................................................Passed cargo fmt............................................(no files to check)Skipped ruff format..........................................(no files to check)Skipped ruff check...........................................(no files to check)Skipped <-- prettier.................................................................Passed zizmor...............................................(no files to check)Skipped Validate GitHub Workflows............................(no files to check)Skipped shellcheck...........................................(no files to check)Skipped ``` Compared to the release branch: ```shell > pre-commit run ... cargo fmt............................................(no files to check)Skipped ruff format..........................................(no files to check)Skipped ruff (legacy alias)..................................(no files to check)Skipped ... ```
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
Towards #123. Introduces the
ruff-checkpre-commit hook ID, updates documentation to prefer it, but retains theruffID for compatibility.cc @dhruvmanila @zanieb
A