pcd-cli 0.2.1__tar.gz → 0.2.2__tar.gz

{pcd_cli-0.2.1 → pcd_cli-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pcd-cli
-Version: 0.2.1
+Version: 0.2.2
 Summary: Fast project navigator for Bash, Zsh and Fish
 License-Expression: MIT
 License-File: LICENSE
@@ -69,7 +69,7 @@ COMMANDS
     pcd roots                    List scan roots
     pcd refresh                  Rescan roots and rebuild the project cache
 
-    pcd list                     List all known projects
+    pcd list [options]           List and filter known projects
     pcd config path              Print the configuration file path
     pcd config show              Print the effective configuration
     pcd config edit              Edit the user configuration
@@ -85,6 +85,8 @@ COMMANDS
 
 * Projects inside registered roots are discovered automatically.
 * You can register multiple scan roots.
+* Filter `pcd list` with `--manual`, `--discovered`, or `--missing`.
+* Use `pcd list --json` for machine-readable output.
 * Set `editor = "nvim"` in the configuration to choose an editor for `pcd config edit`.
 
 

{pcd_cli-0.2.1 → pcd_cli-0.2.2}/README.txt

@@ -45,7 +45,7 @@ COMMANDS
     pcd roots                    List scan roots
     pcd refresh                  Rescan roots and rebuild the project cache
 
-    pcd list                     List all known projects
+    pcd list [options]           List and filter known projects
     pcd config path              Print the configuration file path
     pcd config show              Print the effective configuration
     pcd config edit              Edit the user configuration
@@ -61,6 +61,8 @@ COMMANDS
 
 * Projects inside registered roots are discovered automatically.
 * You can register multiple scan roots.
+* Filter `pcd list` with `--manual`, `--discovered`, or `--missing`.
+* Use `pcd list --json` for machine-readable output.
 * Set `editor = "nvim"` in the configuration to choose an editor for `pcd config edit`.
 
 

{pcd_cli-0.2.1 → pcd_cli-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pcd-cli"
-version = "0.2.1"
+version = "0.2.2"
 description = "Fast project navigator for Bash, Zsh and Fish"
 readme = { file = "README.txt", content-type = "text/plain" }
 license = "MIT"

{pcd_cli-0.2.1 → pcd_cli-0.2.2}/src/pcd_cli/cli/__init__.py

@@ -6,7 +6,8 @@ from pcd_cli.cli.config import (
     show_config,
     validate_config,
 )
-from pcd_cli.cli.projects import add, init, list_projects, project, refresh, remove, roots, uninit
+from pcd_cli.cli.projects import add, list_projects, project, remove
+from pcd_cli.cli.roots import init, refresh, roots, uninit
 from pcd_cli.cli.shell import (
     install_shell,
     print_shell_integration,

{pcd_cli-0.2.1 → pcd_cli-0.2.2}/src/pcd_cli/cli/app.py

@@ -8,6 +8,7 @@ import click
 from pcd_cli.catalog import ProjectCatalog
 from pcd_cli.cli.config import config_commands
 from pcd_cli.cli.projects import project_commands
+from pcd_cli.cli.roots import root_commands
 from pcd_cli.cli.shell import shell_commands, shell_init
 from pcd_cli.config import InvalidConfigError
 from pcd_cli.models import ExitCode
@@ -83,11 +84,14 @@ def cli(ctx: click.Context, project_name: str | None) -> None:
     navigate_to_project(catalog, project_name, exact_only=True)
 
 
-for command in project_commands:
+for command in (
+    *project_commands,
+    *root_commands,
+    config_commands,
+    shell_commands,
+    shell_init,
+):
     cli.add_command(command)
-cli.add_command(config_commands)
-cli.add_command(shell_commands)
-cli.add_command(shell_init)
 
 
 def main() -> None:

{pcd_cli-0.2.1 → pcd_cli-0.2.2}/src/pcd_cli/cli/config.py

@@ -40,8 +40,8 @@ def edit_config(catalog: ProjectCatalog) -> None:
         editor = catalog.config.load().editor
     except InvalidConfigError:
         editor = None
-    else:
-        editor = editor or os.environ.get("VISUAL") or os.environ.get("EDITOR")
+
+    editor = editor or os.environ.get("VISUAL") or os.environ.get("EDITOR")
 
     if editor is None:
         raise click.UsageError("Set $VISUAL or $EDITOR before running `pcd config edit`")

{pcd_cli-0.2.1 → pcd_cli-0.2.2}/src/pcd_cli/cli/projects.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 
+import json
+from enum import StrEnum
 from pathlib import Path
 from typing import assert_never, ClassVar, Literal, NamedTuple, TYPE_CHECKING
 
@@ -15,14 +17,18 @@ if TYPE_CHECKING:
     from pcd_cli.catalog import ProjectCatalog
 
 type ProjectSourceLabel = Literal["manual", "scanned"]
-type ProjectStatusLabel = Literal["available", "missing"]
+
+
+class ProjectStatus(StrEnum):
+    AVAILABLE = "available"
+    MISSING = "missing"
 
 
 class ProjectListRow(NamedTuple):
     name: str
     path: str
     source: ProjectSourceLabel
-    status: ProjectStatusLabel
+    status: ProjectStatus
 
     @classmethod
     def from_project(cls, project: Project) -> ProjectListRow:
@@ -44,11 +50,11 @@ class ProjectListRow(NamedTuple):
                 assert_never(source)
 
     @staticmethod
-    def _status_label(path: Path) -> ProjectStatusLabel:
+    def _status_label(path: Path) -> ProjectStatus:
         if path.is_dir():
-            return "available"
+            return ProjectStatus.AVAILABLE
         else:
-            return "missing"
+            return ProjectStatus.MISSING
 
 
 class ProjectListTable:
@@ -59,6 +65,12 @@ class ProjectListTable:
     def __init__(self, projects: Sequence[Project]) -> None:
         self._rows = tuple(ProjectListRow.from_project(project) for project in projects)
 
+    @classmethod
+    def from_rows(cls, rows: Sequence[ProjectListRow]) -> ProjectListTable:
+        table = cls(())
+        table._rows = tuple(rows)
+        return table
+
     def render(self) -> str:
         if self._rows:
             return self._render_table()
@@ -87,37 +99,6 @@ def project(catalog: ProjectCatalog, query: str) -> None:
     navigate_to_project(catalog, query)
 
 
-@click.command()
-@click.pass_obj
-def init(catalog: ProjectCatalog) -> None:
-    """Register the current directory as a scan root."""
-    current = Path.cwd()
-    parent = catalog.find_parent_root(current)
-    added = catalog.add_scan_root(current)
-
-    if not added:
-        click.echo(f"Already a root: {format_path(current)}")
-        return
-
-    if parent is not None:
-        click.echo(f"Note: root is inside {format_path(parent)}", err=True)
-
-    click.echo(f"Added root: {format_path(current)}")
-
-
-@click.command()
-@click.pass_obj
-def uninit(catalog: ProjectCatalog) -> None:
-    """Remove the current directory from scan roots."""
-    current = Path.cwd()
-    if catalog.remove_scan_root(current):
-        click.echo(f"Removed root: {format_path(current)}")
-        return
-
-    click.echo("Current directory is not a pcd root.", err=True)
-    raise click.exceptions.Exit(ExitCode.ERROR)
-
-
 @click.command()
 @click.argument("path", type=click.Path(path_type=Path, file_okay=False), required=False)
 @click.option("--name", help="Custom name for a manual project.")
@@ -187,26 +168,50 @@ def remove(catalog: ProjectCatalog, query: str) -> None:
 
 
 @click.command("list")
+@click.option("--manual", is_flag=True, help="Show manually registered projects.")
+@click.option("--discovered", is_flag=True, help="Show automatically discovered projects.")
+@click.option("--missing", is_flag=True, help="Show projects whose directories are missing.")
+@click.option("--json", "as_json", is_flag=True, help="Print projects as JSON.")
 @click.pass_obj
-def list_projects(catalog: ProjectCatalog) -> None:
-    """List all known projects."""
-    table = ProjectListTable(catalog.projects())
-    click.echo(table.render())
-
-
-@click.command()
-@click.pass_obj
-def roots(catalog: ProjectCatalog) -> None:
-    """List registered scan roots."""
-    for root in catalog.config.load().roots:
-        click.echo(format_path(root))
-
+def list_projects(
+    catalog: ProjectCatalog,
+    manual: bool,
+    discovered: bool,
+    missing: bool,
+    as_json: bool,
+) -> None:
+    """List and filter known projects."""
+    entries: list[tuple[Project, ProjectListRow]] = []
+    for project in catalog.projects():
+        source_matches = (
+            not (manual or discovered)
+            or (manual and project.source is ProjectSource.MANUAL)
+            or (discovered and project.source is ProjectSource.DISCOVERED)
+        )
+        if not source_matches:
+            continue
+
+        row = ProjectListRow.from_project(project)
+        if missing and row.status is not ProjectStatus.MISSING:
+            continue
+
+        entries.append((project, row))
+
+    if as_json:
+        items = [
+            {
+                "name": project.name,
+                "path": str(project.display_path),
+                "source": project.source.value,
+                "status": row.status,
+            }
+            for project, row in entries
+        ]
+        click.echo(json.dumps(items, indent=2))
+        return
 
-@click.command()
-@click.pass_obj
-def refresh(catalog: ProjectCatalog) -> None:
-    """Rescan roots and rebuild the project cache."""
-    click.echo(f"Found {len(catalog.refresh())} projects.")
+    table = ProjectListTable.from_rows(tuple(row for _, row in entries))
+    click.echo(table.render())
 
 
-project_commands = (project, init, uninit, add, remove, list_projects, roots, refresh)
+project_commands = (project, add, remove, list_projects)

pcd_cli-0.2.2/src/pcd_cli/cli/roots.py

@@ -0,0 +1,113 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import ClassVar, Literal, NamedTuple, TYPE_CHECKING
+
+import click
+
+from pcd_cli.filesystem import canonical_path, format_path
+from pcd_cli.models import ExitCode, ProjectSource
+
+if TYPE_CHECKING:
+    from collections.abc import Sequence
+
+    from pcd_cli.catalog import ProjectCatalog
+    from pcd_cli.models import Project
+
+type RootStatusLabel = Literal["available", "missing"]
+
+
+class RootListRow(NamedTuple):
+    path: str
+    projects: str
+    status: RootStatusLabel
+
+    @classmethod
+    def from_root(cls, root: Path, projects: Sequence[Project]) -> RootListRow:
+        resolved_root = canonical_path(root)
+        project_count = sum(
+            project.path.is_relative_to(resolved_root)
+            for project in projects
+            if project.source is ProjectSource.DISCOVERED
+        )
+
+        return cls(
+            path=format_path(root),
+            projects=str(project_count),
+            status="available" if root.is_dir() else "missing",
+        )
+
+
+class RootListTable:
+    HEADERS: ClassVar[tuple[str, str, str]] = ("PATH", "PROJECTS", "STATUS")
+
+    _rows: tuple[RootListRow, ...]
+
+    def __init__(self, roots: Sequence[Path], projects: Sequence[Project]) -> None:
+        self._rows = tuple(RootListRow.from_root(root, projects) for root in roots)
+
+    def render(self) -> str:
+        if not self._rows:
+            return "No roots found."
+
+        table = (self.HEADERS, *self._rows)
+        columns = zip(*table, strict=True)
+        widths = tuple(max(len(value) for value in column) for column in columns)
+
+        return "\n".join(self._render_row(row, widths) for row in table)
+
+    @staticmethod
+    def _render_row(row: tuple[str, ...], widths: tuple[int, ...]) -> str:
+        return "  ".join(
+            value.ljust(width) for value, width in zip(row, widths, strict=True)
+        ).rstrip()
+
+
+@click.command()
+@click.pass_obj
+def init(catalog: ProjectCatalog) -> None:
+    """Register the current directory as a scan root."""
+    current = Path.cwd()
+    parent = catalog.find_parent_root(current)
+    added = catalog.add_scan_root(current)
+
+    if not added:
+        click.echo(f"Already a root: {format_path(current)}")
+        return
+
+    if parent is not None:
+        click.echo(f"Note: root is inside {format_path(parent)}", err=True)
+
+    click.echo(f"Added root: {format_path(current)}")
+
+
+@click.command()
+@click.pass_obj
+def uninit(catalog: ProjectCatalog) -> None:
+    """Remove the current directory from scan roots."""
+    current = Path.cwd()
+    if catalog.remove_scan_root(current):
+        click.echo(f"Removed root: {format_path(current)}")
+        return
+
+    click.echo("Current directory is not a pcd root.", err=True)
+    raise click.exceptions.Exit(ExitCode.ERROR)
+
+
+@click.command()
+@click.pass_obj
+def roots(catalog: ProjectCatalog) -> None:
+    """List registered scan roots with project counts and status."""
+    settings = catalog.config.load()
+    table = RootListTable(settings.roots, catalog.projects())
+    click.echo(table.render())
+
+
+@click.command()
+@click.pass_obj
+def refresh(catalog: ProjectCatalog) -> None:
+    """Rescan roots and rebuild the project cache."""
+    click.echo(f"Found {len(catalog.refresh())} projects.")
+
+
+root_commands = (init, uninit, roots, refresh)