plugins_cmd_listing.py 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150
  1. """Read-only presentation: ``hermes plugins list``, ``show`` and ``compat``.
  2. Sibling of :mod:`hermes_cli.plugins_cmd` (the facade re-exports the names other modules use and is
  3. imported late here, never at module level).
  4. """
  5. from __future__ import annotations
  6. import json
  7. from pathlib import Path
  8. from typing import Any
  9. def _pc():
  10. """The facade, read at call time: tests patch ``plugins_cmd.<name>`` and sibling calls must see it."""
  11. from hermes_cli import plugins_cmd
  12. return plugins_cmd
  13. def _filter_plugin_entries(entries: list, args: Any, enabled: set, disabled: set) -> list:
  14. """Apply ``hermes plugins list`` CLI filters."""
  15. filtered = entries
  16. if getattr(args, "no_bundled", False) or getattr(args, "user", False):
  17. filtered = [entry for entry in filtered if entry[3] != "bundled"]
  18. if getattr(args, "enabled", False):
  19. active = _pc()._category_active_names()
  20. filtered = [entry for entry in filtered if _entry_status(entry, enabled, disabled, active) == "enabled"]
  21. return filtered
  22. def _entry_status(entry: tuple, enabled: set, disabled: set, active: set) -> str:
  23. """``_plugin_status`` for one ``_discover_all_plugins`` row."""
  24. name, _version, _description, source, dir_path, key = entry
  25. return _pc()._plugin_status(name, enabled, disabled, key, source=source, dir_path=dir_path, active=active)
  26. _STATUS_MARKUP = {"disabled": "[red]disabled[/red]", "enabled": "[green]enabled[/green]"}
  27. def cmd_list(args: Any | None = None) -> None:
  28. """List all plugins (bundled + user) with enabled/disabled state."""
  29. console = _pc()._console()
  30. entries = _pc()._discover_all_plugins()
  31. if not entries:
  32. console.print("[dim]No plugins installed.[/dim]")
  33. console.print("[dim]Install with:[/dim] hermes plugins install owner/repo")
  34. return
  35. enabled = _pc()._get_enabled_set()
  36. disabled = _pc()._get_disabled_set()
  37. entries = _filter_plugin_entries(entries, args, enabled, disabled)
  38. from hermes_cli import plugins_cmd_catalog as catalog
  39. # Source shows catalog provenance (``catalog:<tier>@<sha8>``) or a ``--ref`` pin
  40. # (``git pinned@<sha8>``) so a team can eyeball that everyone runs the same commit.
  41. pins = _pc()._read_install_metadata()
  42. # One kill-list resolution for the whole listing: resolving per row costs a live-catalog
  43. # fetch per installed plugin when the catalog host is slow or unreachable.
  44. removed_entries = catalog.resolved_removed_entries()
  45. active = _pc()._category_active_names()
  46. rows = [
  47. (name, _pc()._plugin_status(name, enabled, disabled, key=key, source=source, dir_path=_dir, active=active),
  48. str(version), description,
  49. catalog.catalog_annotation(_dir) or _pc()._pin_annotation(name, pins) or source,
  50. catalog.removed_annotation(name, _dir, removed_entries))
  51. for name, version, description, source, _dir, key in entries
  52. ]
  53. if getattr(args, "json", False):
  54. keys = ("name", "status", "version", "description", "source", "removed")
  55. print(json.dumps([dict(zip(keys, row)) for row in rows], indent=2))
  56. return
  57. if getattr(args, "plain", False):
  58. for name, status, version, _description, source, _removed in rows:
  59. print(f"{status:12} {source:8} {version:8} {name}")
  60. return
  61. if not entries:
  62. console.print("[dim]No plugins matched the selected filters.[/dim]")
  63. return
  64. table = _pc()._table(
  65. (("Name", "bold"), ("Status", None), ("Version", "dim"), ("Description", None), ("Source", "dim")),
  66. title="Plugins", show_lines=False)
  67. # provenance class per user-installed dir (bundled entries show '-')
  68. from hermes_cli.plugins_provenance import plugins_provenance
  69. prov_classes = {
  70. p.name: p.klass.value for p in plugins_provenance(_pc()._plugins_dir())
  71. }
  72. removed_lines = []
  73. for name, status_name, version, description, source, removed in rows:
  74. klass = prov_classes.get(name)
  75. status = _STATUS_MARKUP.get(status_name, "[yellow]not enabled[/yellow]")
  76. if removed:
  77. name = f"[red]{name} ✗[/red]"
  78. removed_lines.append(f"[red]✗ {name}[/red] was removed from the plugin catalog: {removed}")
  79. table.add_row(name, status, version, description, source)
  80. # class line rides the Source column for user plugins
  81. if source in {"user", "git"}:
  82. if klass and klass != "git":
  83. table.add_row(
  84. "", "", "", f"[dim]provenance: {klass}[/dim]", ""
  85. )
  86. console.print()
  87. console.print(table)
  88. for line in removed_lines:
  89. console.print(line)
  90. console.print()
  91. console.print("[dim]Compact view:[/dim] hermes plugins list --plain --no-bundled")
  92. console.print("[dim]Interactive toggle:[/dim] hermes plugins")
  93. console.print("[dim]Enable/disable:[/dim] hermes plugins enable/disable <name>")
  94. console.print("[dim]Plugins are opt-in by default — only 'enabled' plugins load.[/dim]")
  95. def cmd_show(name: str) -> None:
  96. """Show details for a single plugin, including declared emits/listens."""
  97. console = _pc()._console()
  98. match = _pc()._find_plugin_entry(name)
  99. if match is None:
  100. console.print(f"[red]Plugin '{name}' not found.[/red]")
  101. _pc()._fail(console, "[dim]List installed plugins:[/dim] hermes plugins list")
  102. pname, version, description, source, dir_path, key = match
  103. manifest = _pc()._read_manifest(Path(dir_path)) if dir_path else {}
  104. emits = manifest.get("emits") or []
  105. listens = manifest.get("listens") or []
  106. status = _pc()._plugin_status(pname, _pc()._get_enabled_set(), _pc()._get_disabled_set(), key=key)
  107. console.print()
  108. console.print(f"[bold]{pname}[/bold]" + (f" [dim]v{version}[/dim]" if version else ""))
  109. if description:
  110. console.print(description)
  111. console.print(f"[dim]Status:[/dim] {status}")
  112. console.print(f"[dim]Source:[/dim] {source}")
  113. console.print(f"[dim]Key:[/dim] {key}")
  114. if dir_path and source != "bundled":
  115. from hermes_cli.plugin_isolation import ISOLATION_HOST, isolation_mode
  116. from hermes_cli.plugin_isolation_audit import audit_plugin_dir
  117. audit = audit_plugin_dir(Path(dir_path), manifest)
  118. runs_in = ("plugin host" if isolation_mode() == ISOLATION_HOST and audit.host_ready
  119. else "refused (plugins.isolation: host)" if isolation_mode() == ISOLATION_HOST
  120. else "Hermes process")
  121. console.print(f"[dim]Runs in:[/dim] {runs_in} [dim]— {audit.summary()}[/dim]")
  122. from hermes_cli.plugin_provider_requests import requires_auth_notice
  123. if notice := requires_auth_notice(manifest):
  124. console.print(f"[dim]Sign-in:[/dim] {notice}")
  125. console.print("[dim]Emits:[/dim] " + (", ".join(emits) if emits else "[dim](none)[/dim]"))
  126. console.print("[dim]Listens:[/dim] " + (", ".join(listens) if listens else "[dim](none)[/dim]"))
  127. console.print()