refactor: ♻️ rename to properties in read_json()

src/check_datapackage/check.py

@@ -1,4 +1,5 @@
 import re
+import sys
 from dataclasses import dataclass, field
 from functools import reduce
 from typing import Any, Callable, Iterator, Optional
@@ -47,6 +48,19 @@ class for more details, especially about the default values.
     issues += apply_extensions(properties, config.extensions)
     issues = exclude(issues, config.exclusions, properties)
 
+    if error and issues:
+        # TODO: Switch to using `explain()` once implemented
+        errors: list[str] = _map(
+            issues,
+            lambda issue: f"- Property `{issue.jsonpath}`: {issue.message}\n",
+        )
+        # Should hide the traceback for the user
+        sys.tracebacklimit = 0
+        raise Exception(
+            "There were some issues found in your `datapackage.json`:\n\n"
+            + "\n".join(errors)
+        )
+
     return sorted(set(issues))
 
 

src/check_datapackage/read_json.py

@@ -19,7 +19,7 @@ def read_json(path: Path) -> dict[str, Any]:
             dictionary.
     """
     try:
-        descriptor: Any = loads(path.read_text())
+        properties: dict[str, Any] = loads(path.read_text())
     except JSONDecodeError as error:
         raise JSONDecodeError(
             f"The path {path} couldn't be parsed as JSON. Is there a typo or other "
@@ -28,11 +28,11 @@ def read_json(path: Path) -> dict[str, Any]:
             pos=error.pos,
         ) from None  # To hide the original traceback
 
-    if not isinstance(descriptor, dict):
+    if not isinstance(properties, dict):  # pyright: ignore
         raise TypeError(
             f"The file {path} should parse into a Python dictionary (`dict`) "
-            f"but it converts to the type `{type(descriptor)}`. Is the file "
+            f"but it converts to the type `{type(properties)}`. Is the file "
             "missing a curly bracket `{` at the beginning or `}` at the end?"
-        )
+        ) from None  # To hide the original traceback
 
-    return descriptor
+    return properties

tests/test_check.py

@@ -1,6 +1,6 @@
 from typing import Any
 
-from pytest import mark
+from pytest import mark, raises
 
 from check_datapackage.check import check
 from check_datapackage.config import Config
@@ -272,3 +272,12 @@ def test_fail_with_bad_resource_path(path, location, type):
     assert len(issues) == 1
     assert issues[0].type == type
     assert issues[0].jsonpath == location
+
+
+def test_error_as_true():
+    properties = {
+        "name": 123,
+    }
+
+    with raises(Exception):
+        check(properties, error=True)

tools/vulture-allowlist.py

@@ -1,3 +1,4 @@
 # ruff: noqa
 # mypy: ignore-errors
-version  # unused variable (src/check_datapackage/config.py:40)
+tracebacklimit  # unused attribute (src/check_datapackage/check.py:58)
+version  # unused variable (src/check_datapackage/config.py:44)