feat: add schema and validate-pyproject support (#130)

Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>

Author: henryiii

.pre-commit-config.yaml

@@ -8,7 +8,7 @@ repos:
     hooks:
       - id: black-jupyter
 
-  - repo: https://github.com/asottile/blacken-docs
+  - repo: https://github.com/adamchainz/blacken-docs
     rev: 1.16.0
     hooks:
       - id: blacken-docs

docs/api/repo_review.resources.rst

@@ -0,0 +1,7 @@
+repo\_review.resources package
+==============================
+
+.. automodule:: repo_review.resources
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/api/repo_review.rst

@@ -6,6 +6,14 @@ repo\_review package
    :undoc-members:
    :show-inheritance:
 
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   repo_review.resources
+
 Submodules
 ----------
 
@@ -56,3 +64,11 @@ repo\_review.processor module
    :members:
    :undoc-members:
    :show-inheritance:
+
+repo\_review.schema module
+--------------------------
+
+.. automodule:: repo_review.schema
+   :members:
+   :undoc-members:
+   :show-inheritance:

pyproject.toml

@@ -44,7 +44,8 @@ cli = [
 ]
 test = [
   "pytest >=7",
-  "sp-repo-review",
+  "sp-repo-review >=2023.8.3",
+  "validate-pyproject >=0.14",
 ]
 dev = [
   "repo-review[test,cli]",
@@ -75,6 +76,9 @@ repo-review = "repo_review.__main__:main"
 pyproject = "repo_review.fixtures:pyproject"
 list_all = "repo_review.fixtures:list_all"
 
+[project.entry-points."validate_pyproject.tool_schema"]
+repo-review = "repo_review.schema:get_schema"
+
 
 [tool.hatch]
 version.source = "vcs"

src/repo_review/resources/__init__.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+import importlib.resources
+
+__all__ = ["resources"]
+
+
+resources = importlib.resources.files(__name__)

src/repo_review/resources/repo-review.schema.json

@@ -0,0 +1,24 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema",
+  "$id": "https://github.com/scientific-python/repo-review/blob/main/src/repo_review/resources/repo-review.schema.json",
+  "description": "Repo-review's settings.",
+  "type": "object",
+  "additionalProperties": false,
+  "properties": {
+    "select": {
+      "$ref": "#/$defs/checks"
+    },
+    "ignore": {
+      "$ref": "#/$defs/checks"
+    }
+  },
+  "$defs": {
+    "checks": {
+      "type": "array",
+      "items": {
+        "type": "string",
+        "pattern": "^[A-Z]+[0-9]*$"
+      }
+    }
+  }
+}

src/repo_review/schema.py

@@ -0,0 +1,24 @@
+"""
+This accesses the schema for repo-review's tool section.
+"""
+
+from __future__ import annotations
+
+import json
+from typing import Any
+
+from .resources import resources
+
+__all__ = ["get_schema"]
+
+
+def __dir__() -> list[str]:
+    return __all__
+
+
+def get_schema(tool_name: str = "repo-review") -> dict[str, Any]:
+    "Get the stored complete schema for repo-review settings."
+    assert tool_name == "repo-review", "Only repo-review is supported."
+
+    with resources.joinpath("repo-review.schema.json").open(encoding="utf-8") as f:
+        return json.load(f)  # type: ignore[no-any-return]

tests/test_package.py

@@ -1,11 +1,11 @@
 from __future__ import annotations
 
+import textwrap
 from pathlib import Path
 
 import pytest
 
 import repo_review as m
-from repo_review.ghpath import GHPath
 from repo_review.processor import process
 
 DIR = Path(__file__).parent.resolve()
@@ -15,15 +15,33 @@ def test_version():
     assert m.__version__
 
 
-@pytest.mark.skip(reason="Can be rate limited")
-def test_pyodide():
-    pytest.importorskip("sp_repo_review")
-    package = GHPath(repo="scientific-python/repo-review", branch="main")
-    results = process(package)
-    assert results
-
-
 def test_local():
+    pytest.importorskip("sp_repo_review")
+    pytest.importorskip("validate_pyproject")
     package = DIR.parent
     results = process(package)
-    assert results
+    assert "hatchling.build" in results.families["general"]["description"]
+    assert "BSD License" in results.families["general"]["description"]
+    assert "[tool.repo-review]" in results.families["validate-pyproject"]["description"]
+    for result in results.results:
+        if result.name in {"PC111"}:  # TODO: update after next sp-repo-review release
+            continue
+        assert result.result
+
+
+def test_broken_validate_pyproject(tmp_path: Path) -> None:
+    pytest.importorskip("validate_pyproject")
+    tmp_path.joinpath("pyproject.toml").write_text(
+        textwrap.dedent(
+            """\
+                [tool.repo-review]
+                ignore = ["a2"]
+            """
+        )
+    )
+
+    results = process(tmp_path)
+
+    (result,) = (r for r in results.results if r.name == "VPP001")
+    assert "must match pattern" in result.err_msg
+    assert not result.result