Skip to content

config

repo_scaffold.add_package.config

Project-type detection and configuration for add-package.

Detects whether the target directory is a Rust cargo workspace or a uv workspace by inspecting Cargo.toml / pyproject.toml, and collects the resolved configuration into an AddPackageConfig dataclass.

AddPackageConfig dataclass 

AddPackageConfig(
    project_path: Path, name: str, project_type: ProjectType
)

Resolved configuration for one add-package invocation.

ProjectType

Bases: Enum

Supported workspace project types.

detect_project_type 

detect_project_type(project_path: Path) -> ProjectType

Detect the workspace type from manifest files.

Resolution order
  1. Cargo.toml with a [workspace] section → RUST_WORKSPACE
  2. pyproject.toml with a [tool.uv.workspace] section → UV_WORKSPACE
  3. pnpm-workspace.yaml → PNPM_WORKSPACE
  4. None of the above → raise click.ClickException
PARAMETER DESCRIPTION
project_path

Root directory of the workspace project.

TYPE: Path

RETURNS DESCRIPTION
ProjectType

The detected ProjectType.
RAISES DESCRIPTION
ClickException

When no recognised workspace manifest is found.
Source code in repo_scaffold/add_package/config.py 
35
36
37
38
39
40
41
42
43
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
def detect_project_type(project_path: Path) -> ProjectType:
    """Detect the workspace type from manifest files.

    Resolution order:
      1. ``Cargo.toml`` with a ``[workspace]`` section → ``RUST_WORKSPACE``
      2. ``pyproject.toml`` with a ``[tool.uv.workspace]`` section → ``UV_WORKSPACE``
      3. ``pnpm-workspace.yaml`` → ``PNPM_WORKSPACE``
      4. None of the above → raise ``click.ClickException``

    Args:
        project_path: Root directory of the workspace project.

    Returns:
        The detected ``ProjectType``.

    Raises:
        click.ClickException: When no recognised workspace manifest is found.
    """
    project_path = project_path.resolve()

    cargo_toml = project_path / "Cargo.toml"
    if cargo_toml.is_file():
        with cargo_toml.open("rb") as f:
            data = tomllib.load(f)
        if "workspace" in data:
            return ProjectType.RUST_WORKSPACE

    pyproject_toml = project_path / "pyproject.toml"
    if pyproject_toml.is_file():
        with pyproject_toml.open("rb") as f:
            data = tomllib.load(f)
        if "uv" in data.get("tool", {}) and "workspace" in data["tool"]["uv"]:
            return ProjectType.UV_WORKSPACE

    pnpm_workspace = project_path / "pnpm-workspace.yaml"
    if pnpm_workspace.is_file():
        return ProjectType.PNPM_WORKSPACE

    raise click.ClickException(
        "No workspace detected. Expected a Cargo.toml with [workspace], "
        "a pyproject.toml with [tool.uv.workspace], or a pnpm-workspace.yaml."
    )