Skip to content

Workspace

workspace

Node monorepo (workspace) gold-standard checks.

Ports the intent of the Python checks.workspace (uv workspace) to the node ecosystem: npm/pnpm/yarn workspaces. These checks only fire when the project is actually a workspace root (a workspaces field or pnpm-workspace.yaml); on a single-package project they pass as not-applicable, mirroring how the Python workspace checks skip outside a workspace context.

check_packages_layout(project)

Check: a workspace root has a packages/ directory with members.

Source code in packages/axm-init/src/axm_init/checks/node/workspace.py
Python
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
def check_packages_layout(project: Path) -> CheckResult:
    """Check: a workspace root has a ``packages/`` directory with members."""
    if not _is_workspace_root(project):
        return _ok("workspace.packages_layout", 2, "Not a workspace (n/a)")
    packages = project / "packages"
    if packages.is_dir() and any(
        (child / "package.json").is_file()
        for child in packages.iterdir()
        if child.is_dir()
    ):
        return _ok("workspace.packages_layout", 2, "packages/* layout present")
    return CheckResult(
        name="workspace.packages_layout",
        category="workspace",
        passed=False,
        weight=2,
        message="No packages/* members found",
        details=["A workspace root should hold its members under packages/"],
        fix="Place workspace members under packages/<name>/ with a package.json.",
    )

check_workspaces_declared(project)

Check: a workspace root declares its members (workspaces / pnpm-workspace).

Not applicable (auto-pass) on a single-package project.

Source code in packages/axm-init/src/axm_init/checks/node/workspace.py
Python
57
58
59
60
61
62
63
64
def check_workspaces_declared(project: Path) -> CheckResult:
    """Check: a workspace root declares its members (workspaces / pnpm-workspace).

    Not applicable (auto-pass) on a single-package project.
    """
    if not _is_workspace_root(project):
        return _ok("workspace.workspaces_declared", 3, "Not a workspace (n/a)")
    return _ok("workspace.workspaces_declared", 3, "Workspace members declared")

check_workspaces_versions_consistent(project)

Check: every workspace member declares a version (release readiness).

Not applicable (auto-pass) outside a workspace. Flags members whose package.json omits version — the node analog of the Python requires_python_compat cross-member consistency check.

Source code in packages/axm-init/src/axm_init/checks/node/workspace.py
Python
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
def check_workspaces_versions_consistent(project: Path) -> CheckResult:
    """Check: every workspace member declares a version (release readiness).

    Not applicable (auto-pass) outside a workspace. Flags members whose
    ``package.json`` omits ``version`` — the node analog of the Python
    ``requires_python_compat`` cross-member consistency check.
    """
    if not _is_workspace_root(project):
        return _ok("workspace.versions_consistent", 2, "Not a workspace (n/a)")
    missing: list[str] = []
    for member in _member_dirs(project):
        try:
            data = json.loads((member / "package.json").read_text(encoding="utf-8"))
        except (OSError, json.JSONDecodeError):
            data = {}
        if not (isinstance(data, dict) and data.get("version")):
            missing.append(member.name)
    if missing:
        return CheckResult(
            name="workspace.versions_consistent",
            category="workspace",
            passed=False,
            weight=2,
            message=f"{len(missing)} member(s) without a version",
            details=[f"Missing version: {', '.join(missing)}"],
            fix="Add a `version` field to each member's package.json.",
        )
    return _ok("workspace.versions_consistent", 2, "All members versioned")