Skip to content

Quality check

quality_check

Quality-check hook for protocol pre-hook injection.

QualityCheckHook

Run audit categories and report violations as hook metadata.

Source code in packages/axm-audit/src/axm_audit/hooks/quality_check.py
Python
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
class QualityCheckHook:
    """Run audit categories and report violations as hook metadata."""

    def execute(
        self,
        context: dict[str, Any],
        **params: Any,
    ) -> HookResult:
        """Run audit on a project directory.

        Args:
            context: Hook context with ``working_dir``.
            **params: Optional ``categories`` list.

        Returns:
            HookResult with ``has_violations``, ``violations``, ``summary``.
            Each violation is expanded from inner error lists when available
            (``errors`` for type checks, ``issues`` for lint checks).
            Checks without inner lists produce a single fallback violation.
        """
        working_dir = params.get("working_dir") or context.get("working_dir", ".")
        project_path = Path(working_dir)

        if not project_path.is_dir():
            return HookResult.ok(has_violations=False, violations=[], summary="clean")

        categories: list[str] = params.get("categories", _DEFAULT_CATEGORIES)

        results: list[AuditResult] = []
        for category in categories:
            try:
                result = audit_project(project_path, category=category)
                results.append(result)
            except (OSError, RuntimeError, ValueError):
                logger.warning(
                    "audit_project failed for category=%s", category, exc_info=True
                )

        if not results:
            return HookResult.ok(has_violations=False, violations=[], summary="clean")

        all_checks = []
        for r in results:
            all_checks.extend(r.checks)

        merged = AuditResult.model_construct(checks=all_checks)
        agent_output = format_agent(merged)

        failed_items = agent_output.get("failed", [])
        violations: list[dict[str, Any]] = []
        for item in failed_items:
            rule_id = item.get("rule_id", "")
            details = item.get("details") or {}
            inner = details.get("errors", details.get("issues"))
            if inner is not None:
                for entry in inner:
                    violations.append(
                        {
                            "file": entry.get("file", ""),
                            "line": entry.get("line", 0),
                            "message": entry.get("message", ""),
                            "code": entry.get("code", ""),
                            "rule_id": rule_id,
                        }
                    )
            else:
                violations.append(
                    {
                        "file": "",
                        "line": 0,
                        "message": item.get("message", ""),
                        "code": rule_id,
                        "rule_id": rule_id,
                    }
                )

        has_violations = len(violations) > 0
        summary = f"{len(violations)} violation(s)" if has_violations else "clean"

        return HookResult.ok(
            has_violations=has_violations,
            violations=violations,
            summary=summary,
        )
execute(context, **params)

Run audit on a project directory.

Parameters:

Name Type Description Default
context dict[str, Any]

Hook context with working_dir.

 required
**params Any

Optional categories list.

 {}

Returns:

Type Description
HookResult

HookResult with has_violations, violations, summary.
HookResult

Each violation is expanded from inner error lists when available
HookResult

(errors for type checks, issues for lint checks).
HookResult

Checks without inner lists produce a single fallback violation.
Source code in packages/axm-audit/src/axm_audit/hooks/quality_check.py
Python
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
def execute(
    self,
    context: dict[str, Any],
    **params: Any,
) -> HookResult:
    """Run audit on a project directory.

    Args:
        context: Hook context with ``working_dir``.
        **params: Optional ``categories`` list.

    Returns:
        HookResult with ``has_violations``, ``violations``, ``summary``.
        Each violation is expanded from inner error lists when available
        (``errors`` for type checks, ``issues`` for lint checks).
        Checks without inner lists produce a single fallback violation.
    """
    working_dir = params.get("working_dir") or context.get("working_dir", ".")
    project_path = Path(working_dir)

    if not project_path.is_dir():
        return HookResult.ok(has_violations=False, violations=[], summary="clean")

    categories: list[str] = params.get("categories", _DEFAULT_CATEGORIES)

    results: list[AuditResult] = []
    for category in categories:
        try:
            result = audit_project(project_path, category=category)
            results.append(result)
        except (OSError, RuntimeError, ValueError):
            logger.warning(
                "audit_project failed for category=%s", category, exc_info=True
            )

    if not results:
        return HookResult.ok(has_violations=False, violations=[], summary="clean")

    all_checks = []
    for r in results:
        all_checks.extend(r.checks)

    merged = AuditResult.model_construct(checks=all_checks)
    agent_output = format_agent(merged)

    failed_items = agent_output.get("failed", [])
    violations: list[dict[str, Any]] = []
    for item in failed_items:
        rule_id = item.get("rule_id", "")
        details = item.get("details") or {}
        inner = details.get("errors", details.get("issues"))
        if inner is not None:
            for entry in inner:
                violations.append(
                    {
                        "file": entry.get("file", ""),
                        "line": entry.get("line", 0),
                        "message": entry.get("message", ""),
                        "code": entry.get("code", ""),
                        "rule_id": rule_id,
                    }
                )
        else:
            violations.append(
                {
                    "file": "",
                    "line": 0,
                    "message": item.get("message", ""),
                    "code": rule_id,
                    "rule_id": rule_id,
                }
            )

    has_violations = len(violations) > 0
    summary = f"{len(violations)} violation(s)" if has_violations else "clean"

    return HookResult.ok(
        has_violations=has_violations,
        violations=violations,
        summary=summary,
    )