Workspace

workspace

Workspace-specific checks — only relevant for workspace roots.

check_matrix_packages(project)

Check CI workflow uses --package for per-member testing.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_matrix_packages(project: Path) -> CheckResult:
    """Check CI workflow uses --package for per-member testing."""
    ci_path = project / ".github" / "workflows" / "ci.yml"
    if not ci_path.exists():
        return CheckResult(
            name="workspace.matrix_packages",
            category="workspace",
            passed=False,
            weight=2,
            message="CI workflow not found",
            details=["Expected .github/workflows/ci.yml"],
            fix="Create CI workflow with per-package test matrix.",
        )

    content = ci_path.read_text()
    if "--package" not in content:
        return CheckResult(
            name="workspace.matrix_packages",
            category="workspace",
            passed=False,
            weight=2,
            message="No --package strategy in CI",
            details=["CI should use --package for per-member testing"],
            fix="Add --package flag to test/lint jobs in CI matrix.",
        )

    return CheckResult(
        name="workspace.matrix_packages",
        category="workspace",
        passed=True,
        weight=2,
        message="CI uses --package strategy",
        details=[],
        fix="",
    )

check_members_consistent(project)

Check each member has pyproject.toml, src/, and tests/.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_members_consistent(project: Path) -> CheckResult:
    """Check each member has pyproject.toml, src/, and tests/."""
    member_dirs = _resolve_member_dirs(project)
    if not member_dirs:
        return CheckResult(
            name="workspace.members_consistent",
            category="workspace",
            passed=True,
            weight=2,
            message="No members yet (workspace configured)",
            details=[],
            fix="",
        )

    issues: list[str] = []
    for member in member_dirs:
        missing: list[str] = []
        if not (member / "pyproject.toml").exists():
            missing.append("pyproject.toml")
        if not (member / "src").is_dir():
            missing.append("src/")
        if not (member / "tests").is_dir():
            missing.append("tests/")
        if missing:
            issues.append(f"{member.name}: missing {', '.join(missing)}")

    if issues:
        return CheckResult(
            name="workspace.members_consistent",
            category="workspace",
            passed=False,
            weight=2,
            message=f"{len(issues)} inconsistent member(s)",
            details=issues,
            fix="Ensure each member has pyproject.toml, src/, and tests/.",
        )

    return CheckResult(
        name="workspace.members_consistent",
        category="workspace",
        passed=True,
        weight=2,
        message=f"{len(member_dirs)} member(s) consistent",
        details=[],
        fix="",
    )

check_monorepo_plugin(project)

Check root mkdocs.yml uses the monorepo plugin.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_monorepo_plugin(project: Path) -> CheckResult:
    """Check root mkdocs.yml uses the monorepo plugin."""
    mkdocs_path = project / "mkdocs.yml"
    if not mkdocs_path.exists():
        return CheckResult(
            name="workspace.monorepo_plugin",
            category="workspace",
            passed=False,
            weight=2,
            message="mkdocs.yml not found at workspace root",
            details=["Workspace docs need mkdocs-monorepo-plugin"],
            fix="Create mkdocs.yml with monorepo plugin.",
        )

    content = mkdocs_path.read_text()
    if "monorepo" not in content:
        return CheckResult(
            name="workspace.monorepo_plugin",
            category="workspace",
            passed=False,
            weight=2,
            message="monorepo plugin not configured",
            details=["mkdocs.yml exists but missing monorepo plugin"],
            fix="Add 'monorepo' to plugins list in mkdocs.yml.",
        )

    return CheckResult(
        name="workspace.monorepo_plugin",
        category="workspace",
        passed=True,
        weight=2,
        message="monorepo plugin configured",
        details=[],
        fix="",
    )

check_packages_layout(project)

Check that workspace members live under a packages/ subdir.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_packages_layout(project: Path) -> CheckResult:
    """Check that workspace members live under a packages/ subdir."""
    member_dirs = _resolve_member_dirs(project)
    if not member_dirs:
        return CheckResult(
            name="workspace.packages_layout",
            category="workspace",
            passed=True,
            weight=3,
            message="No members yet (workspace configured)",
            details=[],
            fix="",
        )

    bad = [d.name for d in member_dirs if "packages" not in d.parts]
    if bad:
        return CheckResult(
            name="workspace.packages_layout",
            category="workspace",
            passed=False,
            weight=3,
            message=f"{len(bad)} member(s) outside packages/",
            details=[f"Outside packages/: {', '.join(bad)}"],
            fix="Move workspace members under packages/ subdirectory.",
        )

    return CheckResult(
        name="workspace.packages_layout",
        category="workspace",
        passed=True,
        weight=3,
        message=f"{len(member_dirs)} member(s) in packages/",
        details=[],
        fix="",
    )

check_pytest_importmode(project)

Check root pytest has import_mode = 'importlib'.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_pytest_importmode(project: Path) -> CheckResult:
    """Check root pytest has import_mode = 'importlib'."""
    data = _load_toml(project)
    if data is None:
        return CheckResult(
            name="workspace.pytest_importmode",
            category="workspace",
            passed=False,
            weight=2,
            message="No pyproject.toml at root",
            details=[],
            fix="Create pyproject.toml with [tool.pytest.ini_options].",
        )

    pytest_cfg = _get_pytest_config(data)
    import_mode = pytest_cfg.get("import_mode", pytest_cfg.get("importmode", ""))

    if import_mode == "importlib":
        return CheckResult(
            name="workspace.pytest_importmode",
            category="workspace",
            passed=True,
            weight=2,
            message="import_mode = 'importlib' set",
            details=[],
            fix="",
        )

    return CheckResult(
        name="workspace.pytest_importmode",
        category="workspace",
        passed=False,
        weight=2,
        message="import_mode not set to 'importlib'",
        details=[f"Current value: '{import_mode}'" if import_mode else "Key missing"],
        fix='Add import_mode = "importlib" to [tool.pytest.ini_options].',
    )

check_pytest_testpaths(project)

Check root testpaths includes paths for workspace members.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_pytest_testpaths(project: Path) -> CheckResult:
    """Check root testpaths includes paths for workspace members."""
    data = _load_toml(project)
    if data is None:
        return CheckResult(
            name="workspace.pytest_testpaths",
            category="workspace",
            passed=False,
            weight=2,
            message="No pyproject.toml at root",
            details=[],
            fix="Create pyproject.toml with [tool.pytest.ini_options].",
        )

    pytest_cfg = _get_pytest_config(data)
    testpaths = pytest_cfg.get("testpaths", [])

    if not testpaths:
        return CheckResult(
            name="workspace.pytest_testpaths",
            category="workspace",
            passed=False,
            weight=2,
            message="No testpaths configured",
            details=["Expected testpaths listing member test directories"],
            fix='Add testpaths = ["packages/*/tests"] to [tool.pytest.ini_options].',
        )

    # Check that at least one path references packages/*/tests or similar
    has_member_paths = any("packages" in tp and "tests" in tp for tp in testpaths)
    if has_member_paths:
        return CheckResult(
            name="workspace.pytest_testpaths",
            category="workspace",
            passed=True,
            weight=2,
            message=f"testpaths configured ({len(testpaths)} path(s))",
            details=[],
            fix="",
        )

    return CheckResult(
        name="workspace.pytest_testpaths",
        category="workspace",
        passed=False,
        weight=2,
        message="testpaths does not reference member test directories",
        details=[f"Current: {testpaths}"],
        fix='Add "packages/*/tests" to testpaths in [tool.pytest.ini_options].',
    )

check_quality_workflow(project)

Check .github/workflows/axm-quality.yml exists with per-package audit.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_quality_workflow(project: Path) -> CheckResult:
    """Check .github/workflows/axm-quality.yml exists with per-package audit."""
    quality_path = project / ".github" / "workflows" / "axm-quality.yml"
    if not quality_path.exists():
        return CheckResult(
            name="workspace.quality_workflow",
            category="workspace",
            passed=False,
            weight=2,
            message="axm-quality.yml not found",
            details=["Expected .github/workflows/axm-quality.yml"],
            fix="Create axm-quality.yml with per-package audit + coverage.",
        )

    content = quality_path.read_text()
    # Verify it has per-package audit and coverage
    has_audit = "axm-audit" in content or "audit" in content.lower()
    has_coverage = "coverage" in content.lower()

    if has_audit and has_coverage:
        return CheckResult(
            name="workspace.quality_workflow",
            category="workspace",
            passed=True,
            weight=2,
            message="axm-quality.yml configured with audit + coverage",
            details=[],
            fix="",
        )

    missing = []
    if not has_audit:
        missing.append("audit")
    if not has_coverage:
        missing.append("coverage")

    return CheckResult(
        name="workspace.quality_workflow",
        category="workspace",
        passed=False,
        weight=2,
        message=f"axm-quality.yml missing: {', '.join(missing)}",
        details=[f"Workflow exists but missing: {', '.join(missing)}"],
        fix="Add per-package audit + coverage to axm-quality.yml.",
    )

check_requires_python_compat(project)

Check requires-python compatibility across members.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_requires_python_compat(project: Path) -> CheckResult:
    """Check requires-python compatibility across members."""
    member_dirs = _resolve_member_dirs(project)
    if not member_dirs:
        return CheckResult(
            name="workspace.requires_python_compat",
            category="workspace",
            passed=True,
            weight=1,
            message="No members to check",
            details=[],
            fix="",
        )

    specs: dict[str, str] = {}
    for member in member_dirs:
        data = _load_toml(member)
        if data is None:
            continue
        req = data.get("project", {}).get("requires-python")
        if isinstance(req, str):
            specs[member.name] = req

    if not specs:
        return CheckResult(
            name="workspace.requires_python_compat",
            category="workspace",
            passed=True,
            weight=1,
            message="No requires-python found in members",
            details=[],
            fix="",
        )

    unique = set(specs.values())
    if len(unique) == 1:
        return CheckResult(
            name="workspace.requires_python_compat",
            category="workspace",
            passed=True,
            weight=1,
            message=f"All members: {next(iter(unique))}",
            details=[],
            fix="",
        )

    detail_lines = [f"  {name}: {spec}" for name, spec in sorted(specs.items())]
    return CheckResult(
        name="workspace.requires_python_compat",
        category="workspace",
        passed=False,
        weight=1,
        message=f"{len(unique)} different requires-python values",
        details=detail_lines,
        fix="Align requires-python across workspace members.",
    )

check_root_name_collision(project)

Check that root project name does not collide with any member name.

Source code in packages/axm-init/src/axm_init/checks/workspace.py

def check_root_name_collision(project: Path) -> CheckResult:
    """Check that root project name does not collide with any member name."""
    data = _load_toml(project)
    if data is None:
        return CheckResult(
            name="workspace.root_name_collision",
            category="workspace",
            passed=True,
            weight=3,
            message="No pyproject.toml at root",
            details=[],
            fix="",
        )

    root_name = data.get("project", {}).get("name", "")
    member_names = _get_member_names(project)
    if not member_names:
        return CheckResult(
            name="workspace.root_name_collision",
            category="workspace",
            passed=True,
            weight=3,
            message="No members yet",
            details=[],
            fix="",
        )

    collisions = [m for m in member_names if m.casefold() == root_name.casefold()]
    if collisions:
        return CheckResult(
            name="workspace.root_name_collision",
            category="workspace",
            passed=False,
            weight=3,
            message=f"Root name '{root_name}' collides with member(s)",
            details=[
                f"Collision: root='{root_name}', member='{c}'" for c in collisions
            ],
            fix="Rename root project or member to avoid name collision.",
        )

    return CheckResult(
        name="workspace.root_name_collision",
        category="workspace",
        passed=True,
        weight=3,
        message=(
            f"Root '{root_name}' does not collide with {len(member_names)} member(s)"
        ),
        details=[],
        fix="",
    )