Add and prefer the `ruff-check` pre-commit ID #124

AA-Turner · 2025-05-02T20:59:11Z

Summary

Towards #123. Introduces the ruff-check pre-commit hook ID, updates documentation to prefer it, but retains the ruff ID for compatibility.

cc @dhruvmanila @zanieb

A

AA-Turner · 2025-05-02T21:00:05Z

.pre-commit-hooks.yaml

-  name: ruff
-  description: "Run 'ruff' for extremely fast Python linting"
+- id: ruff-check
+  name: ruff check


Change the display name to reflect the sub-command executed.

AA-Turner · 2025-05-02T21:02:36Z

.pre-commit-hooks.yaml

-  description: "Run 'ruff' for extremely fast Python linting"
+- id: ruff-check
+  name: ruff check
+  description: "Run 'ruff check' for extremely fast Python linting"


Correct a likely oversight from #32

AA-Turner · 2025-05-02T21:03:52Z

.pre-commit-hooks.yaml

+# Legacy alias
+- id: ruff
+  name: ruff (legacy alias)


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

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.

AA-Turner · 2025-05-05T13:48:47Z

I believe you can use pre-commit try-repo to test this PR on your local computer.

It seemed to work alright for me!

A

dhruvmanila

Thanks, this looks good. Sorry, it slipped from my notification somehow.

AA-Turner · 2025-05-13T13:57:53Z

Thank you @dhruvmanila!

A

see astral-sh/ruff-pre-commit#124

## Summary Update pre-commit hook id according to astral-sh/ruff-pre-commit#124

## 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 ... ```

Align with the preferred ruff-pre-commit hook name: astral-sh/ruff-pre-commit#124

The ruff pre-commit hook has been updated to the ruff-check hook, as the former is now just an alias for the latter. The GitHub pull request, astral-sh/ruff-pre-commit#124, discusses these changes.

The ruff pre-commit hook has been updated to the ruff-check hook, as the former is now just an alias for the latter. The GitHub pull request, astral-sh/ruff-pre-commit#124, discusses these changes. The spacing underneath the 5th step in the README.md has changed due to Prettier's pre-commit hook formatting it.

The ruff pre-commit hook has been updated to the ruff-check hook, as the former is now just an alias for the latter. The GitHub pull request, astral-sh/ruff-pre-commit#124, discusses these changes. The spacing underneath many lines within the code.md and infrastructure.md Markdown files has changed due to Prettier's pre-commit hook formatting them. Also, many link texts have changed to satisfy markdownlint's new MD059 rule (link text should be descriptive). The use_keywords_order_plays.yml playbook has changed to resolve ansible-lint name[unique] violations. Many role variables have been changed to resolve ansible-lint var-naming[no-role-prefix] violations. Passing the line number for tasks and plays (via 'data') as an argument to the create_matcherror method has changed due to how this attribute is to be accessed in relation to future versions of the ansible-core package (>= 2.19). This conclusion has come from reading ansible/ansible-lint#4554 and ansible/ansible-lint#4564. A version_changed attribute has been added to all rules to suppress a warning now generated from ansible-lint that complains when this attribute is missing. This behavior was introduced as of this commit: ansible/ansible-lint#4431. The value for this attribute models the one in the pyproject.toml file, in that it is not intended to hold much significance. This is primarily because I see little value in updating this attribute over time for internal rules. The _get_leaf_items method's type hint has changed from the union type 'list[Any] | dict[Any, Any]' to 'list[Any] | Mapping[Any, Any]' because the parent class type of ansiblelint.utils.Task has changed to be Mapping[str, Any]. The AnsibleUnicodeItems type alias now uses the 'type' keyword instead of TypeAlias, as this was recommended per ruff's non-pep695-type-alias rule.

Refs astral-sh/ruff-pre-commit#124

The ruff pre-commit hook has been updated to the ruff-check hook, as the former is now just an alias for the latter. The GitHub pull request, astral-sh/ruff-pre-commit#124, discusses these changes. The spacing underneath many lines within the code.md and infrastructure.md Markdown files has changed due to Prettier's pre-commit hook formatting them. Also, many link texts have changed to satisfy markdownlint's new MD059 rule (link text should be descriptive). The use_keywords_order_plays.yml playbook has changed to resolve ansible-lint name[unique] violations. Many role variables have been changed to resolve ansible-lint var-naming[no-role-prefix] violations. Passing the line number for tasks and plays (via 'data') as an argument to the create_matcherror method has changed due to how this attribute is to be accessed in relation to future versions of the ansible-core package (>= 2.19). This conclusion has come from reading ansible/ansible-lint#4554 and ansible/ansible-lint#4564. A version_changed attribute has been added to all rules to suppress a warning now generated from ansible-lint that complains when this attribute is missing. This behavior was introduced as of this commit: ansible/ansible-lint#4431. The value for this attribute models the one in the pyproject.toml file, in that it is not intended to hold much significance. This is primarily because I see little value in updating this attribute over time for internal rules. The _get_leaf_items method's type hint has changed from the union type 'list[Any] | dict[Any, Any]' to 'list[Any] | Mapping[Any, Any]' because the parent class type of ansiblelint.utils.Task has changed to be Mapping[str, Any]. The AnsibleUnicodeItems type alias now uses the 'type' keyword instead of TypeAlias, as this was recommended per ruff's non-pep695-type-alias rule.

Refs: astral-sh/ruff-pre-commit#124 Signed-off-by: Mike Fiedler <miketheman@gmail.com>

The ruff pre-commit hook has been updated to the ruff-check hook, as the former is now just an alias for the latter. The GitHub pull request, astral-sh/ruff-pre-commit#124, discusses these changes. The spacing underneath the 5th step in the README.md has changed due to Prettier's pre-commit hook formatting it.

Add and prefer the ruff-check pre-commit ID

b72e270

AA-Turner commented May 2, 2025

View reviewed changes

zanieb requested review from dhruvmanila and ntBre May 2, 2025 21:05

ntBre reviewed May 5, 2025

View reviewed changes

AA-Turner mentioned this pull request May 13, 2025

Friendlier names for the hooks #123

Closed

dhruvmanila approved these changes May 13, 2025

View reviewed changes

dhruvmanila merged commit 39f54b7 into astral-sh:main May 13, 2025

AA-Turner deleted the id-ruff-check branch May 13, 2025 13:57

radarhere mentioned this pull request Jun 3, 2025

Update ruff pre-commit ID python-pillow/Pillow#8994

Merged

RobPasMue mentioned this pull request Jun 4, 2025

docs: deprecating a library ansys/pyansys-dev-guide#606

Merged

mashehu added a commit to mashehu/ruff that referenced this pull request Jun 17, 2025

use updated pre-commit id

cfbc8cc

see astral-sh/ruff-pre-commit#124

mashehu mentioned this pull request Jun 17, 2025

Use updated pre-commit id astral-sh/ruff#18718

Merged

ntBre pushed a commit to astral-sh/ruff that referenced this pull request Jun 17, 2025

Use updated pre-commit id (#18718)

a2cd6df

## Summary Update pre-commit hook id according to astral-sh/ruff-pre-commit#124

diazona mentioned this pull request Jul 10, 2025

Update ruff pre-commit hook ID diazona/setuptools-pyproject-migration#198

Merged

eth2353 mentioned this pull request Jul 16, 2025

Update ruff pre-commit hook id serenita-org/vero#175

Merged

ntBre mentioned this pull request Jul 24, 2025

Update pre-commit hook name astral-sh/ruff#19530

Merged

ssbarnea mentioned this pull request Jul 26, 2025

Add unified hook for running format and check in a single step #127

Closed

DimitriPapadopoulos added a commit to DimitriPapadopoulos/parsec-cloud that referenced this pull request Aug 8, 2025

Update hook name: ruff → ruff-check

7ee6bdd

Align with the preferred ruff-pre-commit hook name: astral-sh/ruff-pre-commit#124

DimitriPapadopoulos mentioned this pull request Aug 8, 2025

Update hook name: ruff → ruff-check Scille/parsec-cloud#10900

Merged

github-merge-queue bot pushed a commit to Scille/parsec-cloud that referenced this pull request Aug 15, 2025

Update hook name: ruff → ruff-check

385084f

Align with the preferred ruff-pre-commit hook name: astral-sh/ruff-pre-commit#124

github-merge-queue bot pushed a commit to Scille/parsec-cloud that referenced this pull request Aug 18, 2025

Update hook name: ruff → ruff-check

f054a62

Align with the preferred ruff-pre-commit hook name: astral-sh/ruff-pre-commit#124

scop added a commit to scop/bash-completion that referenced this pull request Oct 13, 2025

chore(pre-commit): use current preferred ruff-check hook name

c254189

Refs astral-sh/ruff-pre-commit#124

scop mentioned this pull request Oct 13, 2025

chore(pre-commit): use current preferred ruff-check hook name scop/bash-completion#1465

Merged

scop added a commit to scop/bash-completion that referenced this pull request Oct 16, 2025

chore(pre-commit): use current preferred ruff-check hook name

7b36495

Refs astral-sh/ruff-pre-commit#124

miketheman added a commit to miketheman/stave that referenced this pull request Oct 25, 2025

chore: use current ruff checker

351c33c

Refs: astral-sh/ruff-pre-commit#124 Signed-off-by: Mike Fiedler <miketheman@gmail.com>

miketheman mentioned this pull request Oct 25, 2025

chore: use current ruff checker davidmreed/stave#133

Merged

ulgens mentioned this pull request Nov 1, 2025

fix: Remove the legacy Ruff lint hook ID from the .pre-commit-config.yaml file and update it ulgens/django-blasphemy#801

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add and prefer the `ruff-check` pre-commit ID #124

Add and prefer the `ruff-check` pre-commit ID #124

Uh oh!

AA-Turner commented May 2, 2025

Uh oh!

AA-Turner May 2, 2025

Uh oh!

AA-Turner May 2, 2025

Uh oh!

AA-Turner May 2, 2025

Uh oh!

ntBre left a comment

Uh oh!

AA-Turner commented May 5, 2025

Uh oh!

dhruvmanila left a comment

Uh oh!

AA-Turner commented May 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add and prefer the ruff-check pre-commit ID #124

Add and prefer the ruff-check pre-commit ID #124

Uh oh!

Conversation

AA-Turner commented May 2, 2025

Summary

Uh oh!

AA-Turner May 2, 2025

Choose a reason for hiding this comment

Uh oh!

AA-Turner May 2, 2025

Choose a reason for hiding this comment

Uh oh!

AA-Turner May 2, 2025

Choose a reason for hiding this comment

Uh oh!

ntBre left a comment

Choose a reason for hiding this comment

Uh oh!

AA-Turner commented May 5, 2025

Uh oh!

dhruvmanila left a comment

Choose a reason for hiding this comment

Uh oh!

AA-Turner commented May 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Add and prefer the `ruff-check` pre-commit ID #124

Add and prefer the `ruff-check` pre-commit ID #124