Plan shared core report output before integration additions

This commit is contained in:
2026-11-06 19:34:26 +00:00
parent b6a8f1f2cc
commit 756954f056
2 changed files with 214 additions and 70 deletions

View File

@@ -36,9 +36,10 @@ The published ckprompt v0.2.0 retains its earlier dependencies; see the
### PromptKit v0.19.0 adoption
The [PromptKit v0.19.0 roadmap](promptkit-v0.19.0.md) owns the proposed adoption,
operator CLI additions for PromptKit and ConfigKit, open decisions,
and completion checklist. Scope is agreed in principle and remains subject to
roadmap review. Implementation has not started. Use released upstream contracts
the agreed shared core report output prerequisite, operator CLI additions for
PromptKit and ConfigKit, open decisions, and completion checklist. Scope is
agreed in principle and remains subject to roadmap review. Implementation has
not started. Use released upstream contracts
only; do not inspect or monitor unreleased work in anticipation of adoption.
## Future capability targets
@@ -78,8 +79,8 @@ adoption identifiers OD-3 through OD-6; the new roadmap has its own decision num
belongs in `ckconfig`, with PromptKit exposing native evidence through its
configuration scope. The
[initial report implementation approach](promptkit-v0.19.0.md#initial-report-implementation-approach)
favors direct Go-to-YAML serialization, thin projections, and shared output
helpers. Further presentation refinements should follow practical feedback.
uses the shared core reporting prerequisite, direct serialization, and thin
projections. Further presentation refinements should follow practical feedback.
Transient acquisition overrides are included as an opt-in loader capability in
[roadmap OD-11](promptkit-v0.19.0.md#od-11-transient-configuration-overrides).
@@ -102,10 +103,10 @@ public reusable `ckprompt` collections for standard and application-owned CLI
commands, composed through existing core bindings.
[Roadmap OD-2](promptkit-v0.19.0.md#od-2-request-controls-and-provider-parameter-grammar)
records the agreed canonical naming, scoped convenience aliases, integration
installation collection, and selected text/file input forms; no core extension
is required. Output-contract overrides and appended-message flags are deferred
below. These are CLI features; general-purpose helpers for application-internal
PromptKit use are outside CommandKit's ownership boundary.
installation collection, and selected text/file input forms; those flag and alias
features need no core extension. Output-contract overrides and appended-message
flags are deferred below. These are CLI features; general-purpose helpers for
application-internal PromptKit use are outside CommandKit's ownership boundary.
- **Focused backend inspection.** Defer a standard backend detail command
until a released PromptKit version provides a suitable public backend
@@ -159,6 +160,14 @@ steps. No delivery date or final API is selected here.
### Reporting extensions
The [shared core report output prerequisite](promptkit-v0.19.0.md#shared-core-report-output-prerequisite)
is now part of the working adoption roadmap. It records the agreed command
output declarations, format-independent reporting operation, and centralized
representation rules, initially targeting YAML. Human-oriented/native rendering
and format availability remain open discussions there. Additional renderers such
as JSON, XML, and Markdown remain future work; planning for them does not select
their mappings, command coverage, or delivery dates.
Error-conversion helpers such as `WarnError` remain deferred pending demonstrated
value; applications can already use `report.Warn(err.Error())`. Terminal redraw
and progress-bar presentation were outside the completed reporting scope and
@@ -183,7 +192,8 @@ candidate checks do not become general prohibitions on development workspaces.
These capabilities remain outside the delivered scope and require a concrete
operator or consumer need and an appropriate ownership/behavior decision:
- JSON reports and output-file management or reloadable export.
- Additional report renderers as described under [reporting extensions](#reporting-extensions),
and output-file management or reloadable export.
- Shell completion extensions, including alias discovery described above and
dynamic discovery of configured or remote values.
- Persistent configuration mutation. Transient CLI overrides are selected under