feat: check for ruff-check instead of ruff (#605)

Signed-off-by: Henry Schreiner <[email protected]>

Author: henryiii

.pre-commit-config.yaml

@@ -31,7 +31,7 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.11.12"
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 

README.md

@@ -364,6 +364,7 @@ for family, grp in itertools.groupby(collected.checks.items(), key=lambda x: x[1
 - [`PC180`](https://learn.scientific-python.org/development/guides/style#PC180): Uses a markdown formatter
 - [`PC190`](https://learn.scientific-python.org/development/guides/style#PC190): Uses Ruff
 - [`PC191`](https://learn.scientific-python.org/development/guides/style#PC191): Ruff show fixes if fixes enabled
+- [`PC192`](https://learn.scientific-python.org/development/guides/style#PC192): Ruff uses `ruff-check` instead of `ruff` (legacy)
 - [`PC901`](https://learn.scientific-python.org/development/guides/style#PC901): Custom pre-commit CI message
 
 ### Ruff

docs/pages/guides/style.md

@@ -113,7 +113,7 @@ Here is the snippet to add the formatter to your `.pre-commit-config.yml`
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: "v0.11.12"
   hooks:
-    #  id: ruff would go here if using both
+    #  id: ruff-check would go here if using both
     - id: ruff-format
 ```
 
@@ -203,12 +203,14 @@ pre-commit hook.
 - repo: https://github.com/astral-sh/ruff-pre-commit
   rev: "v0.11.12"
   hooks:
-    - id: ruff
+    - id: ruff-check
       args: ["--fix", "--show-fixes"]
 ```
 
-{% rr PC191 %} The `--fix` argument is optional, but recommended, since you can
-inspect and undo changes in git.
+{% rr PC192 %} The hook is named `ruff-check`. {% rr PC191 %} The `--fix`
+argument is optional, but recommended, since you can inspect and undo changes in
+git. `--show-fixes` is highly recommended if `--fix` is present, otherwise it
+won't tell you what or why it fixed things.
 
 {% rr RF001 %} Ruff is configured in your `pyproject.toml`. Here's an example:
 
@@ -240,7 +242,6 @@ extend-select = [
   "YTT",      # flake8-2020
 ]
 ignore = [
-  "ISC001",   # Conflicts with formatter
   "PLR09",    # Too many <...>
   "PLR2004",  # Magic value used in comparison
 ]

src/sp_repo_review/checks/precommit.py

@@ -153,7 +153,7 @@ def check(cls, precommit: dict[str, Any]) -> bool | None:
             if "repo" in repo and repo["repo"].lower() in cls.repos:
                 for hook in repo["hooks"]:
                     if (
-                        hook["id"] == "ruff"
+                        hook["id"] in {"ruff", "ruff-check"}
                         and "args" in hook
                         and "--fix" in hook["args"]
                     ):
@@ -162,6 +162,34 @@ def check(cls, precommit: dict[str, Any]) -> bool | None:
         return False
 
 
+class PC192(PreCommit):
+    "Ruff uses `ruff-check` instead of `ruff` (legacy)"
+
+    requires = {"PC190"}
+    repos = {"https://github.com/astral-sh/ruff-pre-commit"}
+
+    @classmethod
+    def check(cls, precommit: dict[str, Any]) -> bool | None:
+        """
+        Use `ruff-check` instead of `ruff` (legacy).
+        """
+        for repo in precommit.get("repos", {}):
+            if (
+                "repo" in repo
+                and repo["repo"].lower() in cls.repos
+                and any(hook["id"] == "ruff" for hook in repo["hooks"])
+            ):
+                return False
+        for repo in precommit.get("repos", {}):
+            if (
+                "repo" in repo
+                and repo["repo"].lower() in cls.repos
+                and any(hook["id"] == "ruff-check" for hook in repo["hooks"])
+            ):
+                return True
+        return None
+
+
 class PC901(PreCommit):
     "Custom pre-commit CI message"
 

tests/test_precommit.py

@@ -1,7 +1,13 @@
+import pytest
 import yaml
 from repo_review.testing import compute_check
 
 
+@pytest.fixture(params=["ruff", "ruff-check"])
+def ruff_check(request: pytest.FixtureRequest) -> str:
+    return request.param  # type: ignore[no-any-return]
+
+
 def test_pc100():
     precommit = yaml.safe_load("""
         repos:
@@ -132,30 +138,54 @@ def test_pc180_alt_1():
     assert compute_check("PC180", precommit=precommit).result
 
 
-def test_pc191():
-    precommit = yaml.safe_load("""
+def test_pc191(ruff_check: str):
+    precommit = yaml.safe_load(f"""
         repos:
           - repo: https://github.com/astral-sh/ruff-pre-commit
             hooks:
-              - id: ruff
+              - id: {ruff_check}
                 args: ["--fix", "--show-fixes"]
     """)
     assert compute_check("PC191", precommit=precommit).result
 
 
-def test_pc191_no_show_fixes():
-    precommit = yaml.safe_load("""
+def test_pc191_no_show_fixes(ruff_check: str):
+    precommit = yaml.safe_load(f"""
         repos:
           - repo: https://github.com/astral-sh/ruff-pre-commit
             hooks:
-              - id: ruff
+              - id: {ruff_check}
                 args: ["--fix"]
     """)
     res = compute_check("PC191", precommit=precommit)
     assert not res.result
     assert "--show-fixes" in res.err_msg
 
 
+def test_pc192():
+    precommit = yaml.safe_load("""
+        repos:
+          - repo: https://github.com/astral-sh/ruff-pre-commit
+            hooks:
+              - id: ruff
+                args: ["--fix"]
+    """)
+    res = compute_check("PC192", precommit=precommit)
+    assert not res.result
+    assert "ruff-check" in res.err_msg
+
+
+def test_pc192_not_needed():
+    precommit = yaml.safe_load("""
+        repos:
+          - repo: https://github.com/astral-sh/ruff-pre-commit
+            hooks:
+              - id: ruff-format
+    """)
+    res = compute_check("PC192", precommit=precommit)
+    assert res.result is None
+
+
 def test_pc901():
     precommit = yaml.safe_load("""
         ci:

{{cookiecutter.project_name}}/.pre-commit-config.yaml

@@ -44,7 +44,7 @@ repos:
   - repo: https://github.com/astral-sh/ruff-pre-commit
     rev: "v0.11.12"
     hooks:
-      - id: ruff
+      - id: ruff-check
         args: ["--fix", "--show-fixes"]
       - id: ruff-format