Skip to content

Format

format

Node format rule — the Prettier pendant of :class:FormattingRule.

Ports the intent of QUALITY_FORMAT (consistent formatting) to Prettier via prettier --check. Prettier exits 1 and lists each unformatted file when the project is not fully formatted. Same rule_id and 100 - files * 5 scoring as the Python format rule.

NodeFormatRule

Bases: NodeToolRule

Run prettier --check and score by the unformatted-file count.

Lives in the lint category to mirror the Python FormattingRule. Scoring: 100 - files * 5, min 0.

Source code in packages/axm-audit/src/axm_audit/core/rules/node/format.py
Python
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
@register_rule("lint", framework=Framework.NODE)
class NodeFormatRule(NodeToolRule):
    """Run ``prettier --check`` and score by the unformatted-file count.

    Lives in the ``lint`` category to mirror the Python ``FormattingRule``.
    Scoring: ``100 - files * 5``, min 0.
    """

    binary = "prettier"
    install_hint = "Install Prettier: npm install -D prettier"

    @property
    def rule_id(self) -> str:
        """Unique identifier for this rule (shared with the Python format rule)."""
        return "QUALITY_FORMAT"

    @property
    def args(self) -> list[str]:
        """Check formatting across the project without writing changes."""
        return ["--check", "."]

    @property
    def findings_returncodes(self) -> frozenset[int]:
        """Prettier exits 1 when files are unformatted — that is a finding."""
        return frozenset({1})

    def parse(self, result: subprocess.CompletedProcess[str]) -> object:
        """Prettier reports unformatted files on stderr — combine both streams."""
        return f"{result.stdout}\n{result.stderr}"

    def score_output(self, parsed: object, project_path: Path) -> CheckResult:
        """Score by the count of unformatted files (parsed is combined output)."""
        output = parsed if isinstance(parsed, str) else ""
        file_count = _count_unformatted(output)
        score = max(0, 100 - file_count * 5)
        passed = score >= PASS_THRESHOLD
        return CheckResult(
            rule_id=self.rule_id,
            passed=passed,
            message=f"Format score: {score}/100 ({file_count} unformatted)",
            severity=Severity.WARNING if not passed else Severity.INFO,
            score=score,
            details={"unformatted_count": file_count},
            fix_hint="Run: npx prettier --write ." if file_count > 0 else None,
        )
args property

Check formatting across the project without writing changes.

findings_returncodes property

Prettier exits 1 when files are unformatted — that is a finding.

rule_id property

Unique identifier for this rule (shared with the Python format rule).

parse(result)

Prettier reports unformatted files on stderr — combine both streams.

Source code in packages/axm-audit/src/axm_audit/core/rules/node/format.py
Python
70
71
72
def parse(self, result: subprocess.CompletedProcess[str]) -> object:
    """Prettier reports unformatted files on stderr — combine both streams."""
    return f"{result.stdout}\n{result.stderr}"
score_output(parsed, project_path)

Score by the count of unformatted files (parsed is combined output).

Source code in packages/axm-audit/src/axm_audit/core/rules/node/format.py
Python
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
def score_output(self, parsed: object, project_path: Path) -> CheckResult:
    """Score by the count of unformatted files (parsed is combined output)."""
    output = parsed if isinstance(parsed, str) else ""
    file_count = _count_unformatted(output)
    score = max(0, 100 - file_count * 5)
    passed = score >= PASS_THRESHOLD
    return CheckResult(
        rule_id=self.rule_id,
        passed=passed,
        message=f"Format score: {score}/100 ({file_count} unformatted)",
        severity=Severity.WARNING if not passed else Severity.INFO,
        score=score,
        details={"unformatted_count": file_count},
        fix_hint="Run: npx prettier --write ." if file_count > 0 else None,
    )