Skip to content

Clean up support scripts under SCRIPTS.md #170

Open

Description

@tony

Summary

.github/SCRIPTS.md now sets the rules for support scripts. Against it, libtmux-java has 3 items to delete as parity with Python libtmux or tmuxp, 1 to delete for having no caller, 5 to move under scripts/<name>/ with typed Python and tests, 4 to consolidate into shared tooling, 1 to remove once the API lands, and 2 to keep. The Clojure modules add three Gradle-driven .clj runners, which stay.

Motivation

.github/SCRIPTS.md keeps a script only for a current use (a CI job, a release step, a generator, a docs check or a maintainer task in CONTRIBUTING.md), says parity with Python libtmux or tmuxp is not a use, and requires kept scripts to live in scripts/<name>/ with a README and tests and to pass ruff format, ruff check, ty check and pytest in CI. The decision is in libtmux/docs#323. A scan of trunk found the items below.

Tasks

Delete: parity with Python libtmux or tmuxp

Delete: no caller

Move to scripts/<name>/ with typed Python and tests

Consolidate into shared tooling

Remove shell setup once the API lands

Keep

Acceptance

No Python libtmux or tmuxp install, fetch or import remains, outside attribution in MIGRATION.md, the changelogs and the guides:

$ rg -l 'import libtmux|tmux-python/libtmux|pip install (libtmux|tmuxp)|tmuxp==|TMUX_WORKSPACE_TEST_PYTHON'

Nothing refers to the deleted module or the ledgers:

$ rg -l 'tools[./]ci[./]tmux_ref|test_tmux_ref|docs/parity|python-api\.md|test-map\.md' .github tools docs build-logic

examples/api/run.sh is gone:

$ fd run.sh examples

CI runs ruff format --check, ruff check, ty check and pytest over every kept script under scripts/, and each has a README.md and tests/.

References

Activity

  1. tony commented on Nov 15, 2026

    @tony
    ContributorAuthor

    Ten checklist items and the missing-API item (#142) landed on master through 986df201. Two stay open:

    • The rest of the optional workspace Python test runtime step, which the workspace-cli Python bridge uses until Decide whether the workspace CLIs keep their tmuxp and Python libtmux bridge docs#324 decides what happens to the bridge. The import libtmux floor assertion is deleted.
    • The macOS tmux build in clojure-compatibility.yml. The shared build-tmux action installs its dependencies with apt and has no macOS support, so the step stays until it does.

    #174 is decided: tools/mcp-swap stays Java, .github/SCRIPTS.md records the exception and .github/CONTRIBUTING.md names the maintainer task. The first option of #174 (delete it) and the second (move it to Python) were not taken; either is a one-commit follow-up if the maintainer prefers it.

  2. tony commented on Nov 16, 2026

    @tony
    ContributorAuthor

    Item from the independent script review, added here so the commit that fixes it can reference this issue:

    • ProcessTest.java embeds Python child programs in text blocks. Move each into a checked .py test resource that the ruff and ty steps cover, with test behaviour unchanged.
  3. tony commented on Nov 16, 2026

    @tony
    ContributorAuthor

    The ProcessTest item is on master at 952b8d2; every workflow at that head passed (CI https://github.com/libtmux/libtmux-java/actions/runs/43791280060, tmux matrix https://github.com/libtmux/libtmux-java/actions/runs/43791279687).

    • The twelve Python programs in ProcessTest.java text blocks are checked .py test resources under libtmux-workspace-cli/src/test/resources/io/github/libtmux/workspace/cli/probes, loaded by the test, and covered by the ruff format, ruff check and ty steps of the scripts job. All 24 ProcessTest tests pass locally; a probe changed to answer the wrong key fails its test.

    The commit was pushed before the instruction to cite the issue, so it carries no Refs line. integration-tests/.../NativeClient.java still embeds one Python program; it was outside this item.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions