Add json output

Author: mnesarco

src/freecad/addons/static_analyzer/check_package.py

@@ -112,7 +112,7 @@ def _check_icon(package, name: str, issues: list[Issue], repo: Path) -> None:
             Issue(
                 name,
                 icon.sourceline,
-                f"""Missing icon file '{file!s}'""",
+                f"""Missing icon file '{icon.text}'""",
             )
         )
     else:
@@ -121,15 +121,15 @@ def _check_icon(package, name: str, issues: list[Issue], repo: Path) -> None:
                 Issue(
                     name,
                     icon.sourceline,
-                    f"""Icon file '{file!s}' is too big (>{max_icon_size_kb}kB)""",
+                    f"""Icon file '{icon.text}' is too big (>{max_icon_size_kb}kB)""",
                 )
             )
         if file.suffix.lower() not in (".svg", ".svgz"):
             issues.append(
                 Issue(
                     name,
                     icon.sourceline,
-                    f"""Icon file '{file!s}' is not scalable (svg)""",
+                    f"""Icon file '{icon.text}' is not scalable (svg)""",
                 )
             )
 

src/freecad/addons/static_analyzer/format.py

@@ -8,12 +8,32 @@
 
 from __future__ import annotations
 
+import json
+from collections import defaultdict
+from dataclasses import fields, is_dataclass
 from datetime import datetime, timezone
+from itertools import groupby
 
 from . import template
 from .models import Analysis
 
 
+def serialize(data: object) -> object:
+    if is_dataclass(data):
+        return {f.name: serialize(getattr(data, f.name)) for f in fields(data)}
+    match data:
+        case str() | int() | float():
+            return data
+        case list() | tuple():
+            return [serialize(v) for v in data]
+        case dict() | defaultdict():
+            return {k: serialize(v) for k, v in data.items()}
+        case datetime():
+            return data.isoformat()
+        case _:
+            return str(data)
+
+
 def report(reports: list[Analysis]) -> str:
     """Assemble the final standalone HTML page."""
 
@@ -39,3 +59,15 @@ def report(reports: list[Analysis]) -> str:
     }
 
     return template.page_html.render(data)
+
+
+def report_json(reports: list[Analysis]) -> str:
+    """Dump report data as json"""
+    reports.sort(key=lambda x: x.name)
+    data = {
+        "date": datetime.strftime(datetime.now(timezone.utc), "%Y-%m-%d"),
+        "addons": {
+            name: list(items) for name, items in groupby(reports, lambda r: r.name)
+        },
+    }
+    return json.dumps(serialize(data), indent=2)

src/freecad/addons/static_analyzer/pipeline.py

@@ -8,8 +8,8 @@
 
 from __future__ import annotations
 
-from datetime import datetime, timezone
 import re
+from datetime import datetime, timezone
 from pathlib import Path
 from threading import Thread
 
@@ -20,9 +20,9 @@
 from .check_package import check_package
 from .check_rules import check_rules
 from .check_stats import check_stats
+from .config import Config
 from .extract_deps import repo_requirements
 from .models import Analysis, Issue
-from .config import Config
 
 
 def search_files(base: Path, name: str, *, regex: bool = False) -> list[Path]:
@@ -37,11 +37,7 @@ def search_files(base: Path, name: str, *, regex: bool = False) -> list[Path]:
 
     pattern = re.compile(name, re.IGNORECASE)
 
-    return [
-        p
-        for p in base.rglob("*")
-        if pattern.fullmatch(str(p.relative_to(base)))
-    ]
+    return [p for p in base.rglob("*") if pattern.fullmatch(str(p.relative_to(base)))]
 
 
 def check_file_present(
@@ -122,3 +118,4 @@ def start():
     date = datetime.strftime(datetime.now(timezone.utc), "%Y-%m-%d")
     reports.sort(key=lambda x: (-x.score, -x.stats.downloads_30d, x.name))
     (output_dir / f"report-{date}.html").write_text(fmt.report(reports))
+    (output_dir / f"report-{date}.json").write_text(fmt.report_json(reports))