Skip to content

Structure

structure

Node structure rule — the package.json/tsconfig pendant of the pyproject rule.

Ports the intent of the Python STRUCTURE_PYPROJECT completeness check to the Node ecosystem: a published package must declare the manifest fields and the strict TypeScript config the research flags as gold-standard. This is a pure file-read rule (no subprocess), so it subclasses ProjectRule directly.

NodeStructureRule

Bases: ProjectRule

Check package.json completeness + tsconfig strict mode.

Mirrors the Python PyprojectCompletenessRule: binary field-presence checks, 100 - missing * 10.

Source code in packages/axm-audit/src/axm_audit/core/rules/node/structure.py
Python
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
@register_rule("structure", framework=Framework.NODE)
class NodeStructureRule(ProjectRule):
    """Check package.json completeness + tsconfig strict mode.

    Mirrors the Python ``PyprojectCompletenessRule``: binary field-presence
    checks, ``100 - missing * 10``.
    """

    @property
    def rule_id(self) -> str:
        """Unique identifier for this rule."""
        return "STRUCTURE_PACKAGE_JSON"

    def check(self, project_path: Path) -> CheckResult:
        """Score by the count of missing manifest fields + strict tsconfig opts."""
        pkg = _load_json(project_path / "package.json")
        if pkg is None:
            return CheckResult(
                rule_id=self.rule_id,
                passed=False,
                message="package.json missing or unparsable",
                severity=Severity.ERROR,
                score=0,
                fix_hint="Create a valid package.json (npm init).",
            )
        missing = _missing_package_fields(pkg) + _missing_tsconfig(project_path)
        score = max(0, 100 - len(missing) * 10)
        passed = not missing
        return CheckResult(
            rule_id=self.rule_id,
            passed=passed,
            message=(
                "package.json + tsconfig complete"
                if passed
                else f"Missing: {', '.join(missing)}"
            ),
            severity=Severity.WARNING if not passed else Severity.INFO,
            score=score,
            details={"missing": missing},
            fix_hint=f"Add {', '.join(missing)}" if missing else None,
        )
rule_id property

Unique identifier for this rule.

check(project_path)

Score by the count of missing manifest fields + strict tsconfig opts.

Source code in packages/axm-audit/src/axm_audit/core/rules/node/structure.py
Python
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
def check(self, project_path: Path) -> CheckResult:
    """Score by the count of missing manifest fields + strict tsconfig opts."""
    pkg = _load_json(project_path / "package.json")
    if pkg is None:
        return CheckResult(
            rule_id=self.rule_id,
            passed=False,
            message="package.json missing or unparsable",
            severity=Severity.ERROR,
            score=0,
            fix_hint="Create a valid package.json (npm init).",
        )
    missing = _missing_package_fields(pkg) + _missing_tsconfig(project_path)
    score = max(0, 100 - len(missing) * 10)
    passed = not missing
    return CheckResult(
        rule_id=self.rule_id,
        passed=passed,
        message=(
            "package.json + tsconfig complete"
            if passed
            else f"Missing: {', '.join(missing)}"
        ),
        severity=Severity.WARNING if not passed else Severity.INFO,
        score=score,
        details={"missing": missing},
        fix_hint=f"Add {', '.join(missing)}" if missing else None,
    )