Skip to content

Tsconfig

tsconfig

tsconfig.json gold-standard checks — the Node pendant of mypy config.

A node/TS project must ship a tsconfig.json with strict mode on (the research's gold-standard baseline, equivalent to the Python mypy-strict check).

check_tsconfig_exists(project)

Check: tsconfig.json exists and is parsable.

Source code in packages/axm-init/src/axm_init/checks/node/tsconfig.py
Python
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def check_tsconfig_exists(project: Path) -> CheckResult:
    """Check: ``tsconfig.json`` exists and is parsable."""
    if _load_tsconfig(project) is None:
        return CheckResult(
            name="tsconfig.tsconfig_exists",
            category="tsconfig",
            passed=False,
            weight=3,
            message="tsconfig.json missing or unparsable",
            details=[],
            fix="Add a tsconfig.json with strict mode enabled.",
        )
    return CheckResult(
        name="tsconfig.tsconfig_exists",
        category="tsconfig",
        passed=True,
        weight=3,
        message="tsconfig.json found",
        details=[],
        fix="",
    )

check_tsconfig_strict(project)

Check: tsconfig.json enables compilerOptions.strict.

Source code in packages/axm-init/src/axm_init/checks/node/tsconfig.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
def check_tsconfig_strict(project: Path) -> CheckResult:
    """Check: ``tsconfig.json`` enables ``compilerOptions.strict``."""
    data = _load_tsconfig(project)
    if data is None:
        return CheckResult(
            name="tsconfig.tsconfig_strict",
            category="tsconfig",
            passed=False,
            weight=3,
            message="tsconfig.json missing — cannot verify strict mode",
            details=[],
            fix="Add tsconfig.json with compilerOptions.strict = true.",
        )
    options = data.get("compilerOptions")
    opts = options if isinstance(options, dict) else {}
    if opts.get("strict") is not True:
        return CheckResult(
            name="tsconfig.tsconfig_strict",
            category="tsconfig",
            passed=False,
            weight=3,
            message="tsconfig strict mode is not enabled",
            details=["compilerOptions.strict must be true"],
            fix="Set compilerOptions.strict = true in tsconfig.json.",
        )
    return CheckResult(
        name="tsconfig.tsconfig_strict",
        category="tsconfig",
        passed=True,
        weight=3,
        message="tsconfig strict mode enabled",
        details=[],
        fix="",
    )