Skip to content

S0b: console support as internal packages of the command #3

Closed

Description

@david-Darkcollective

Part of #17. Design: docs/design.md §7.2.

Scope

The command's console support lives in the relix-cli module as internal packages. The module exports nothing, and nothing is published to Maven Central: this code is the command's implementation, not an API.

The earlier command's relix-console module (DarkCollective/relix) is the starting point. Its code is copied in and changed freely, and nothing keeps the two copies in step.

  • render/: OutputFormat and its formatters (table, CSV, JSON; TSV and NDJSON follow in S2a), and a terminal renderer for a reference page's markdown.
  • report/: the bundle JSON, provenance output and the optimisation report.
  • io/: a ScriptLoader over files, so import resolves relative to the importing file.
  • drivers/: download progress.
  • Not here: the reference-page index. DocRegistry and DocEntry are not copied. relix doc uses the engine's lookup in relix-docs (Move the reference lookup into relix-docs: functions and front-end pages in one index relix-core#95).
  • Not here: config/, or the earlier relix-env.json loader. The design drops that format (§8), so there is no profile loading to copy. Profiles and ${VAR} placeholders are new code in S1 (S1: command skeleton — script sources, exit codes, diagnostics, profiles, engine options #4).
  • Tests come with the code, including the test that renders every worked example from the engine's reference pages and diffs the result against the table the page prints. A guard follows its renderer, so it runs against this command's table renderer and reads the engine's manuals artifact for the pinned version.

A need the engine's published API does not meet goes here, or into the engine when another embedder would need it too. It never goes into a separately published library.

Dependencies

Acceptance

  • The packages build and their tests pass here.
  • module-info exports no package.
  • The build publishes no Maven artifact.
  • No class of the reference index (DocRegistry, DocEntry) is in the module.

Activity

  1. changed the title [-]S0b: relix-console as a published library[/-] [+]S0b: console support as internal packages of the command[/+] on Oct 7, 2026
  2. added
    area:cliThe relix command itself
    and removed
    area:consoleThe relix-console library
    on Oct 7, 2026
  3. added 2 commits that reference this issue on Oct 7, 2026
    df8cf98
    dd35ca3
  4. david-Darkcollective commented on Oct 7, 2026

    @david-Darkcollective
    MemberAuthor

    Done in #20, merged to develop (ae08a51). config/ moved to S1 (#4).

  5. added a commit that references this issue on Oct 7, 2026
    1f1911b
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

    area:cliThe relix command itselfbacklogNot yet scheduledenhancementNew feature or request

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions