feat: add more pre-commit ci checks (#695)

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

Author: henryiii

.pre-commit-config.yaml

@@ -1,5 +1,5 @@
 ci:
-  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autoupdate_commit_msg: "chore(deps): update pre-commit hooks"
   autofix_commit_msg: "style: pre-commit fixes"
   autoupdate_schedule: "quarterly"
 

README.md

@@ -384,7 +384,9 @@ for family, grp in itertools.groupby(collected.checks.items(), key=lambda x: x[1
 - [`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
+- [`PC901`](https://learn.scientific-python.org/development/guides/style#PC901): Custom pre-commit CI update message
+- [`PC902`](https://learn.scientific-python.org/development/guides/style#PC902): Custom pre-commit CI autofix message
+- [`PC903`](https://learn.scientific-python.org/development/guides/style#PC903): Specified pre-commit CI schedule
 
 ### Ruff
 - [`RF001`](https://learn.scientific-python.org/development/guides/style#RF001): Has Ruff config

docs/pages/guides/style.md

@@ -96,13 +96,18 @@ docker), you cannot enable a `--manual` flag, so extra checks will not run, and
 jobs should not download packages (use `additional-dependencies:` to add what
 you need).
 
-{% rr PC901 %} You can customize the pre-commit message with:
+{% rr PC901 %} {% rr PC902 %} {% rr PC903 %} You can customize the pre-commit
+message with:
 
 ```yaml
 ci:
-  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autoupdate_commit_msg: "chore(deps): update pre-commit hooks"
+  autofix_commit_msg: "style: pre-commit fixes"
+  autoupdate_schedule: "monthly"
 ```
 
+The frequencies can be "weekly" (the default), "monthly", and "quarterly".
+
 ## Format
 
 {% rr PC110 %} [Black](https://black.readthedocs.io/en/latest/) is a popular

src/sp_repo_review/checks/precommit.py

@@ -195,7 +195,7 @@ def check(cls, precommit: dict[str, Any]) -> bool | None:
 
 
 class PC901(PreCommit):
-    "Custom pre-commit CI message"
+    "Custom pre-commit CI update message"
 
     @staticmethod
     def check(precommit: dict[str, Any]) -> bool:
@@ -204,12 +204,46 @@ def check(precommit: dict[str, Any]) -> bool:
 
         ```yaml
         ci:
-          autoupdate_commit_msg: 'chore: update pre-commit hooks'
+          autoupdate_commit_msg: 'chore(deps): update pre-commit hooks'
         ```
         """
 
         return "autoupdate_commit_msg" in precommit.get("ci", {})
 
 
+class PC902(PreCommit):
+    "Custom pre-commit CI autofix message"
+
+    @staticmethod
+    def check(precommit: dict[str, Any]) -> bool:
+        """
+        Should have something like this in `.pre-commit-config.yaml`:
+
+        ```yaml
+        ci:
+          autofix_commit_msg: "style: pre-commit fixes"
+        ```
+        """
+
+        return "autofix_commit_msg" in precommit.get("ci", {})
+
+
+class PC903(PreCommit):
+    "Specified pre-commit CI schedule"
+
+    @staticmethod
+    def check(precommit: dict[str, Any]) -> bool:
+        """
+        Should set some schedule: `weekly` (default), `monthly`, or `quarterly`.
+
+        ```yaml
+        ci:
+          autoupdate_schedule: "monthly"
+        ```
+        """
+
+        return "autoupdate_schedule" in precommit.get("ci", {})
+
+
 def repo_review_checks() -> dict[str, PreCommit]:
     return {p.__name__: p() for p in PreCommit.__subclasses__()}

tests/test_precommit.py

@@ -248,3 +248,38 @@ def test_pc901_no_msg():
     res = compute_check("PC901", precommit=precommit)
     assert not res.result
     assert "autoupdate_commit_msg" in res.err_msg
+
+
+def test_pc902():
+    precommit = yaml.safe_load("""
+        ci:
+          autofix_commit_msg: 'style: pre-commit fixes'
+    """)
+    assert compute_check("PC902", precommit=precommit).result
+
+
+def test_pc902_no_msg():
+    precommit = yaml.safe_load("""
+    repos:
+    """)
+    res = compute_check("PC902", precommit=precommit)
+    assert not res.result
+    assert "autofix_commit_msg" in res.err_msg
+
+
+def test_pc903():
+    precommit = yaml.safe_load("""
+        ci:
+          autoupdate_schedule: "monthly"
+
+    """)
+    assert compute_check("PC903", precommit=precommit).result
+
+
+def test_pc903_no_msg():
+    precommit = yaml.safe_load("""
+    repos:
+    """)
+    res = compute_check("PC903", precommit=precommit)
+    assert not res.result
+    assert "autoupdate_schedule" in res.err_msg

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

@@ -1,6 +1,7 @@
 ci:
-  autoupdate_commit_msg: "chore: update pre-commit hooks"
+  autoupdate_commit_msg: "chore(deps): update pre-commit hooks"
   autofix_commit_msg: "style: pre-commit fixes"
+  autoupdate_schedule: "monthly"
 
 exclude: ^.cruft.json|.copier-answers.yml$