Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dhruvmanila merged 1 commit into from
May 13, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 16 additions & 4 deletions .pre-commit-hooks.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
- id: ruff
name: ruff
description: "Run 'ruff' for extremely fast Python linting"
- id: ruff-check
name: ruff check
Copy link
Contributor Author

@AA-Turner AA-Turner May 2, 2025

Choose a reason for hiding this comment

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

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

description: "Run 'ruff check' for extremely fast Python linting"
Copy link
Contributor Author

@AA-Turner AA-Turner May 2, 2025

Choose a reason for hiding this comment

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

Correct a likely oversight from #32

entry: ruff check --force-exclude
language: python
types_or: [python, pyi, jupyter]
Expand All @@ -10,7 +10,7 @@
minimum_pre_commit_version: "2.9.2"

- id: ruff-format
name: ruff-format
name: ruff format
description: "Run 'ruff format' for extremely fast Python formatting"
entry: ruff format --force-exclude
language: python
Expand All @@ -19,3 +19,15 @@
require_serial: true
additional_dependencies: []
minimum_pre_commit_version: "2.9.2"

# Legacy alias
- id: ruff
name: ruff (legacy alias)
Comment on lines +23 to +25
Copy link
Contributor Author

@AA-Turner AA-Turner May 2, 2025

Choose a reason for hiding this comment

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

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.

description: "Run 'ruff check' for extremely fast Python linting"
entry: ruff check --force-exclude
language: python
types_or: [python, pyi, jupyter]
args: []
require_serial: true
additional_dependencies: []
minimum_pre_commit_version: "2.9.2"
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ repos:
rev: v0.11.8
hooks:
# Run the linter.
- id: ruff
- id: ruff-check
# Run the formatter.
- id: ruff-format
```
Expand All @@ -37,7 +37,7 @@ repos:
rev: v0.11.8
hooks:
# Run the linter.
- id: ruff
- id: ruff-check
args: [ --fix ]
# Run the formatter.
- id: ruff-format
Expand All @@ -52,7 +52,7 @@ repos:
rev: v0.11.8
hooks:
# Run the linter.
- id: ruff
- id: ruff-check
types_or: [ python, pyi ]
args: [ --fix ]
# Run the formatter.
Expand Down