witan-code 0.3.0__tar.gz → 0.4.0__tar.gz

{witan_code-0.3.0 → witan_code-0.4.0}/CHANGELOG.md

@@ -6,6 +6,22 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/) (pre-1.0:
 a MINOR bump may include breaking changes).
 
+## [0.4.0] - 2026-07-16
+
+### Added
+
+- **`witan-code --output-format`**: `repos`, `symbols`, and `stitch` can now
+  render their table data as `json`, `toml`, or `yaml` in addition to the
+  default Rich table output. The same option is honored when mounted as
+  `witan --output-format … code …`.
+
+### Changed
+
+- Adopted the shared `witan-core` package for the CLI scaffolding
+  (`make_app`/`report_install`/`resolve_author` + agent-name constants),
+  replacing the previously duplicated copies. No user-facing behavior change.
+  Now depends on `witan-core[cli]>=0.2,<1`.
+
 ## [0.3.0] - 2026-07-10
 
 ### Added

{witan_code-0.3.0 → witan_code-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: witan-code
-Version: 0.3.0
+Version: 0.4.0
 Summary: witan-code — tree-sitter code graph + cross-repo bridge (mounts under `witan code`)
 Project-URL: Homepage, https://github.com/mitodl/agent-kit/tree/main/mcp/servers/witan-code
 Project-URL: Repository, https://github.com/mitodl/agent-kit
@@ -15,6 +15,7 @@ Requires-Dist: cyclopts<5,>=4
 Requires-Dist: fastmcp<4,>=3.4.2
 Requires-Dist: pyyaml<7,>=6
 Requires-Dist: rich>=13
+Requires-Dist: tomli-w<2,>=1
 Requires-Dist: tree-sitter-bash<0.26,>=0.25
 Requires-Dist: tree-sitter-go<0.26,>=0.25
 Requires-Dist: tree-sitter-hcl<1.3,>=1.2
@@ -23,6 +24,7 @@ Requires-Dist: tree-sitter-sql<0.4,>=0.3
 Requires-Dist: tree-sitter-typescript<0.24,>=0.23
 Requires-Dist: tree-sitter-yaml<0.8,>=0.7
 Requires-Dist: tree-sitter<0.26,>=0.25
+Requires-Dist: witan-core[cli]<1,>=0.2
 Description-Content-Type: text/markdown
 
 # witan-code
@@ -87,6 +89,22 @@ machine's local code index.
 - [CLI reference](https://github.com/mitodl/agent-kit/blob/main/mcp/servers/witan-code/docs/CLI_REFERENCE.md) — every `witan-code` command with
   its full flag table and an example invocation.
 
+## CLI structured output
+
+`witan-code` table-producing commands can emit machine-readable output instead
+of Rich tables:
+
+```bash
+witan-code --output-format json repos
+witan-code --output-format yaml symbols --role exported
+witan --output-format toml code stitch --unresolved
+```
+
+Supported formats are `txt` (default), `json`, `toml`, and `yaml`. The same
+setting is available through `WITAN_OUTPUT_FORMAT`. It currently applies to
+`repos`, `symbols`, and `stitch`; free-text commands such as `index` and hook
+commands keep their existing output.
+
 ## Cross-repo context bridge (Layer 2.5)
 
 The per-repo graph stops at a repo boundary, but service-oriented architectures
@@ -283,11 +301,12 @@ witan's). Run `witan-code setup` on its own for a witan-code-only install, or
 when witan-code isn't importable from witan's environment. See
 [Hooks](#hooks) and [Skill](#skill).
 
-This downloads the omnigraph release pinned by `_OMNIGRAPH_VERSION` in
-[`witan_code/setup.py`](./witan_code/setup.py) — the same pin `witan`'s own
-`setup.py` uses, kept in lockstep by Renovate (see the repo-root
-`renovate.json`'s `omnigraph-version` customManager, which bumps both files
-in one PR). There is no build-time bundling of the binary into the wheel —
+This downloads the omnigraph release pinned by `_OMNIGRAPH_VERSION` in the
+shared installer
+[`witan_core.omnigraph_install`](../../../packages/witan-core/witan_core/omnigraph_install.py)
+— the same pin `witan` uses (both import it from `witan-core`), bumped by
+Renovate (see the repo-root `renovate.json`'s `omnigraph-version`
+customManager). There is no build-time bundling of the binary into the wheel —
 `witan-code setup` (or `witan setup`) is the only source of the binary, and
 re-running it is how you pick up a version bump.
 

{witan_code-0.3.0 → witan_code-0.4.0}/README.md

@@ -60,6 +60,22 @@ machine's local code index.
 - [CLI reference](https://github.com/mitodl/agent-kit/blob/main/mcp/servers/witan-code/docs/CLI_REFERENCE.md) — every `witan-code` command with
   its full flag table and an example invocation.
 
+## CLI structured output
+
+`witan-code` table-producing commands can emit machine-readable output instead
+of Rich tables:
+
+```bash
+witan-code --output-format json repos
+witan-code --output-format yaml symbols --role exported
+witan --output-format toml code stitch --unresolved
+```
+
+Supported formats are `txt` (default), `json`, `toml`, and `yaml`. The same
+setting is available through `WITAN_OUTPUT_FORMAT`. It currently applies to
+`repos`, `symbols`, and `stitch`; free-text commands such as `index` and hook
+commands keep their existing output.
+
 ## Cross-repo context bridge (Layer 2.5)
 
 The per-repo graph stops at a repo boundary, but service-oriented architectures
@@ -256,11 +272,12 @@ witan's). Run `witan-code setup` on its own for a witan-code-only install, or
 when witan-code isn't importable from witan's environment. See
 [Hooks](#hooks) and [Skill](#skill).
 
-This downloads the omnigraph release pinned by `_OMNIGRAPH_VERSION` in
-[`witan_code/setup.py`](./witan_code/setup.py) — the same pin `witan`'s own
-`setup.py` uses, kept in lockstep by Renovate (see the repo-root
-`renovate.json`'s `omnigraph-version` customManager, which bumps both files
-in one PR). There is no build-time bundling of the binary into the wheel —
+This downloads the omnigraph release pinned by `_OMNIGRAPH_VERSION` in the
+shared installer
+[`witan_core.omnigraph_install`](../../../packages/witan-core/witan_core/omnigraph_install.py)
+— the same pin `witan` uses (both import it from `witan-core`), bumped by
+Renovate (see the repo-root `renovate.json`'s `omnigraph-version`
+customManager). There is no build-time bundling of the binary into the wheel —
 `witan-code setup` (or `witan setup`) is the only source of the binary, and
 re-running it is how you pick up a version bump.
 

{witan_code-0.3.0 → witan_code-0.4.0}/docs/CLI_REFERENCE.md

@@ -7,7 +7,13 @@ the `witan` umbrella package. Run `witan-code --help` or `witan-code
 <command> --help` for the live version of this table — it is generated from
 the same docstrings.
 
-Global flags: `--help` / `-h`, `--version`.
+Global flags: `--help` / `-h`, `--version`, `--output-format txt|json|toml|yaml`.
+
+`--output-format` controls table-producing commands (`repos`, `symbols`, and
+`stitch`) and is also available as `WITAN_OUTPUT_FORMAT`. The default `txt`
+renders the existing Rich tables; `json`, `toml`, and `yaml` emit a wrapper
+object with `title` and `rows` for machine parsing. The same option works when
+mounted under the umbrella CLI, e.g. `witan --output-format json code repos`.
 
 Boolean flags follow cyclopts' `--flag`/`--no-flag` convention; both forms are
 always available even where only `--flag` is shown below.

{witan_code-0.3.0 → witan_code-0.4.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "witan-code"
-version = "0.3.0"
+version = "0.4.0"
 description = "witan-code — tree-sitter code graph + cross-repo bridge (mounts under `witan code`)"
 readme = "README.md"
 license = "BSD-3-Clause"
@@ -11,6 +11,7 @@ classifiers = [
 ]
 dependencies = [
     "agent-config-kit>=0.4,<1",
+    "witan-core[cli]>=0.2,<1",
     "fastmcp>=3.4.2,<4",
     "cyclopts>=4,<5",
     # Pinned to 0.25.x: tree-sitter 0.26.0 has a use-after-free in its pyo3 Node
@@ -35,6 +36,7 @@ dependencies = [
     "tree-sitter-hcl>=1.2,<1.3",
     "tree-sitter-go>=0.25,<0.26",
     "pyyaml>=6,<7",
+    "tomli-w>=1,<2",
     "rich>=13",
 ]
 
@@ -57,6 +59,7 @@ build-backend = "hatchling.build"
 # has actually landed on PyPI. Published wheels only see the PyPI-range
 # dependency declared above.
 agent-config-kit = { path = "../../../packages/agent-config-kit", editable = true }
+witan-core = { path = "../../../packages/witan-core", editable = true }
 
 [dependency-groups]
 test = ["pytest>=8"]
@@ -69,7 +72,7 @@ testpaths = ["tests"]
 packages = ["witan_code"]
 
 [tool.bumpversion]
-current_version = "0.3.0"
+current_version = "0.4.0"
 allow_dirty = true
 
 [[tool.bumpversion.files]]

witan_code-0.4.0/tests/test_cli_output_format.py

@@ -0,0 +1,91 @@
+"""Tests for the global ``--output-format`` option."""
+
+from __future__ import annotations
+
+import json
+
+import pytest
+
+from witan_code import cli as cli_module
+from witan_code import output as output_module
+
+
+@pytest.fixture(autouse=True)
+def _reset_output_format():
+    """Every test starts and ends on the txt default regardless of order."""
+    output_module.set_output_format("txt")
+    yield
+    output_module.set_output_format("txt")
+
+
+def test_render_table_json_dumps_normalized_rows(capsys):
+    output_module.set_output_format("json")
+
+    cli_module._render_table(
+        title="Indexed repositories",
+        columns=["repo", "files"],
+        rows=[{"repo": "https://github.com/test/repo", "files": None}],
+    )
+
+    payload = json.loads(capsys.readouterr().out)
+    assert payload == {
+        "title": "Indexed repositories",
+        "rows": [{"repo": "https://github.com/test/repo", "files": ""}],
+    }
+
+
+def test_render_table_toml_dumps_normalized_rows(capsys):
+    import tomllib
+
+    output_module.set_output_format("toml")
+
+    cli_module._render_table(
+        title="Symbol table — https://github.com/test/repo",
+        columns=["role", "refs"],
+        rows=[{"role": "exported", "refs": 2}],
+    )
+
+    payload = tomllib.loads(capsys.readouterr().out)
+    assert payload["title"] == "Symbol table — https://github.com/test/repo"
+    assert payload["rows"] == [{"role": "exported", "refs": 2}]
+
+
+def test_repos_honors_structured_output(tmp_path, monkeypatch, capsys):
+    code_dir = tmp_path / "code"
+    code_dir.mkdir()
+    store = code_dir / "https_github.com_test_repo.omni"
+    store.mkdir()
+    (code_dir / f"{store.name}.repo").write_text("https://github.com/test/repo")
+    monkeypatch.setenv("WITAN_CODE_DIR", str(code_dir))
+    monkeypatch.setattr(
+        cli_module,
+        "_code_store_stats",
+        lambda store: ("https://github.com/test/repo", "7"),
+    )
+    monkeypatch.setattr(cli_module, "_dir_stats", lambda path: (1024, "2026-07-13"))
+    output_module.set_output_format("json")
+
+    cli_module.repos()
+
+    payload = json.loads(capsys.readouterr().out)
+    assert payload == {
+        "title": "Indexed repositories",
+        "rows": [
+            {
+                "repo": "https://github.com/test/repo",
+                "files": "7",
+                "size": "1.0KB",
+                "last indexed": "2026-07-13",
+            }
+        ],
+    }
+
+
+def test_launcher_sets_output_format_and_forwards_tokens(monkeypatch):
+    calls = []
+    monkeypatch.setattr(cli_module, "app", lambda tokens: calls.append(tokens))
+
+    cli_module._launcher("repos", output_format="yaml")
+
+    assert output_module.get_output_format() == "yaml"
+    assert calls == [("repos",)]

{witan_code-0.3.0 → witan_code-0.4.0}/tests/test_elicit.py

@@ -383,60 +383,9 @@ def test_find_definition_multi_repo_disambiguation(tmp_path, monkeypatch):
     assert {d["repo"] for d in r1} == {RA}
 
 
-# ── Direct unit tests for witan_code/elicit.py (no server/omnigraph needed) ──
-
-
-class _RaiseCtx:
-    async def elicit(self, *args, **kwargs):
-        raise RuntimeError("unsupported")
-
-
-def test_confirm_no_ctx_or_error_returns_default():
-    from witan_code import elicit
-
-    assert (
-        asyncio.run(elicit.confirm(None, "q?", default_when_unsupported=True)) is True
-    )
-    assert (
-        asyncio.run(elicit.confirm(None, "q?", default_when_unsupported=False)) is False
-    )
-    assert (
-        asyncio.run(elicit.confirm(_RaiseCtx(), "q?", default_when_unsupported=True))
-        is True
-    )
-
-
-def test_confirm_accept_and_decline():
-    from witan_code import elicit
-
-    assert (
-        asyncio.run(
-            elicit.confirm(_AcceptCtx(True), "q?", default_when_unsupported=False)
-        )
-        is True
-    )
-    # accepting with a False value is still a "no"
-    assert (
-        asyncio.run(
-            elicit.confirm(_AcceptCtx(False), "q?", default_when_unsupported=True)
-        )
-        is False
-    )
-    assert (
-        asyncio.run(elicit.confirm(_DeclineCtx(), "q?", default_when_unsupported=True))
-        is False
-    )
-
-
-def test_text_no_ctx_error_or_empty_returns_default():
-    from witan_code import elicit
-
-    assert asyncio.run(elicit.text(None, "q?", default="d")) == "d"
-    assert asyncio.run(elicit.text(_RaiseCtx(), "q?", default="d")) == "d"
-    assert asyncio.run(elicit.text(_AcceptCtx(""), "q?", default="d")) == "d"
-    # whitespace-only is treated as empty -> default; a real value is stripped
-    assert asyncio.run(elicit.text(_AcceptCtx("   "), "q?", default="d")) == "d"
-    assert asyncio.run(elicit.text(_AcceptCtx("  real  "), "q?", default="d")) == "real"
+# ── choose_repo unit tests (no server/omnigraph needed) ──
+# The confirm/text primitives are covered in witan-core's own test suite
+# (packages/witan-core/tests/test_elicit.py); only choose_repo is witan-code's.
 
 
 def test_choose_repo_exact_match_case_insensitive_and_stripped():

witan_code-0.4.0/tests/test_graph.py

@@ -0,0 +1,23 @@
+"""witan-code-subclass-specific OmnigraphClient tests.
+
+The generic base machinery (_find_binary lookup order, OCC conflict surfacing,
+admission-cap backoff) is covered in packages/witan-core/tests/test_omnigraph.py.
+Here we only assert witan-code's own subclass tail: the setup-hint in the
+binary-not-found message. (branch ops + bulk load are exercised against a real
+store in test_branches.py / test_indexer.py.)
+"""
+
+import shutil
+from pathlib import Path
+
+import pytest
+
+from witan_code.graph import OmnigraphClient
+
+
+def test_find_binary_message_names_witan_code_setup(tmp_path, monkeypatch):
+    monkeypatch.setattr(shutil, "which", lambda name: None)
+    monkeypatch.setattr(Path, "home", lambda: tmp_path)
+
+    with pytest.raises(RuntimeError, match="witan-code setup"):
+        OmnigraphClient._find_binary()

{witan_code-0.3.0 → witan_code-0.4.0}/tests/test_repo.py

@@ -8,18 +8,9 @@ import pytest
 from witan_code import repo
 
 
-@pytest.mark.parametrize(
-    ("url", "expected"),
-    [
-        ("git@github.com:mitodl/ol-django.git", "https://github.com/mitodl/ol-django"),
-        ("https://github.com/mitodl/ol-django", "https://github.com/mitodl/ol-django"),
-        ("ssh://git@github.com/mitodl/repo.git", "https://github.com/mitodl/repo"),
-    ],
-)
-def test_normalise_matches_memory_layer(url, expected):
-    # Must stay identical to witan.repo._normalise so symbol ids and
-    # the Layer-1 symbol_refs that point at them share one repo key.
-    assert repo._normalise(url) == expected
+# The repo-key canonicalizer (normalise) lives in witan_core.repo_key — a single
+# source of truth shared with the memory layer (no more "must stay identical"
+# copy). Its golden contract table is packages/witan-core/tests/test_repo_key.py.
 
 
 def test_detect_env_override(monkeypatch):

witan_code-0.4.0/tests/test_setup.py

@@ -0,0 +1,103 @@
+"""Tests for witan-code's registration bundle.
+
+Generic install-mechanics behavior (dry-run no-op, additive merge, JSON
+skip-not-crash, hook dedup, ...) is covered by agent-config-kit's own test
+suite (``packages/agent-config-kit/tests/``); the shared omnigraph installer is
+covered by ``packages/witan-core/tests/test_omnigraph_install.py``. The bundle
+tests here only assert that ``witan_code_bundle()`` + ``apply("claude", ...)``
+produces witan-code's own MCP entry and hook commands, i.e. that the wiring is
+correct.
+"""
+
+import json
+from pathlib import Path
+
+from agent_config_kit import apply
+
+from witan_code import setup
+
+
+def test_witan_code_bundle_registers_mcp_server_and_hooks(tmp_path, monkeypatch):
+    monkeypatch.setattr(Path, "home", lambda: tmp_path)
+    pkg_dir = tmp_path / "pkg"
+    pkg_dir.mkdir()
+
+    bundle = setup.witan_code_bundle(pkg_dir, "tester")
+    apply("claude", bundle)
+
+    claude_json = json.loads((tmp_path / ".claude.json").read_text())
+    entry = claude_json["mcpServers"]["witan-code"]
+    assert entry["type"] == "stdio"
+    assert entry["command"] == "uvx"
+    assert entry["env"]["WITAN_AUTHOR"] == "tester"
+
+    settings = json.loads((tmp_path / ".claude" / "settings.json").read_text())
+    session_init = [
+        h
+        for e in settings["hooks"]["SessionStart"]
+        for h in e["hooks"]
+        if h["command"] == "witan-code session-init"
+    ]
+    reindex = [
+        h
+        for e in settings["hooks"]["PostToolUse"]
+        for h in e["hooks"]
+        if h["command"] == "witan-code reindex-hook"
+    ]
+    context = [
+        h
+        for e in settings["hooks"]["UserPromptSubmit"]
+        for h in e["hooks"]
+        if h["command"] == "witan-code inject-context"
+    ]
+    checkpoint = [
+        h
+        for e in settings["hooks"]["Stop"]
+        for h in e["hooks"]
+        if h["command"] == "witan-code checkpoint"
+    ]
+    assert session_init and reindex and context and checkpoint
+    # Both prompt-path hooks carry a timeout so a hung git/store can't stall.
+    assert context[0]["timeout"] == 15
+    assert checkpoint[0]["timeout"] == 15
+
+
+def test_witan_code_bundle_honors_binary_override(tmp_path):
+    """witan.cli.setup_cmd passes binary="witan code" when folding this
+    bundle into witan's own, so hooks only need `witan` on PATH — not a
+    separately installed `witan-code` binary."""
+    pkg_dir = tmp_path / "pkg"
+    pkg_dir.mkdir()
+
+    bundle = setup.witan_code_bundle(pkg_dir, "tester", binary="witan code")
+
+    commands = {h.command for h in bundle.hooks if hasattr(h, "command")}
+    assert commands == {
+        "witan code session-init",
+        "witan code reindex-hook",
+        "witan code inject-context",
+        "witan code checkpoint",
+    }
+
+
+def test_witan_code_bundle_includes_pi_extensions_as_plugin_hooks(tmp_path):
+    pkg_dir = tmp_path / "pkg"
+    ext_dir = pkg_dir / "extensions" / "pi"
+    ext_dir.mkdir(parents=True)
+    (ext_dir / "codegraph.ts").write_text("// stub")
+
+    bundle = setup.witan_code_bundle(pkg_dir, "tester")
+
+    plugin_hooks = [h for h in bundle.hooks if hasattr(h, "entry_path")]
+    assert any(h.entry_path.name == "codegraph.ts" for h in plugin_hooks)
+
+
+def test_witan_code_bundle_includes_bundled_skills(tmp_path):
+    pkg_dir = tmp_path / "pkg"
+    skill_dir = pkg_dir / "skills" / "witan-code"
+    skill_dir.mkdir(parents=True)
+    (skill_dir / "SKILL.md").write_text("# witan-code")
+
+    bundle = setup.witan_code_bundle(pkg_dir, "tester")
+
+    assert any(s.name == "witan-code" for s in bundle.skills)