Replace render with native prepared request preview in migration plan
This commit is contained in:
@@ -65,7 +65,8 @@ Scriptorium.
|
||||
Decision recorded 2026-11-19: include configuration comparison, provider smoke
|
||||
tests, and shell completion in the initial migration, alongside application and
|
||||
PromptKit configuration scopes, resource inventories and inspection,
|
||||
requirements discovery, and concrete request validation.
|
||||
requirements discovery, concrete request validation, and prepared-request
|
||||
preview.
|
||||
|
||||
Use the existing upstream capabilities. Configuration comparison should cover
|
||||
both application and PromptKit scopes, with independent selections for each
|
||||
@@ -77,8 +78,7 @@ completion, with appropriate hints for application-owned inputs. Dynamic
|
||||
completion of installed resource names is a separate possible enhancement.
|
||||
|
||||
Application-specific wiring remains to be designed, but inclusion of these
|
||||
three capabilities is settled. Prepared-request preview and the future of
|
||||
`render` remain a separate discussion below.
|
||||
capabilities is settled. The prepared-request preview decision is recorded below.
|
||||
|
||||
### Generation and subprocess requirements
|
||||
|
||||
@@ -153,6 +153,28 @@ With quiet mode and no requested files, generation still runs while ordinary
|
||||
result output is suppressed. The [upstream reporting contract][upstream-cli]
|
||||
owns the shared verbosity rules.
|
||||
|
||||
### Prepared-request preview
|
||||
|
||||
Decision recorded 2026-11-19: replace `render` entirely with the native
|
||||
`promptkit show prepared PROMPT_ID` command, enabled through ckprompt's request
|
||||
preparation integration. Remove `render` without a compatibility alias.
|
||||
|
||||
Use the native prepared-run report, standard request flags, diagnostics,
|
||||
verbosity, and outcomes. Default and explicit text output use the upstream YAML
|
||||
presentation; JSON remains available through `--format json`. Remove
|
||||
`defaults.render_format` and any custom prepared-output formatting code left
|
||||
unused by the migration.
|
||||
|
||||
Share application configuration selection, collection loading, and applicable
|
||||
request construction with generation so previews describe the corresponding
|
||||
execution request. PromptKit continues to own preparation semantics.
|
||||
|
||||
Use the native result stream for preview output; consumers can capture or
|
||||
redirect stdout to save it. The generation command's `--output` decision does
|
||||
not itself extend the native inspection commands. File-output convenience does
|
||||
not justify retaining a separate preview command. Update maintained examples
|
||||
and release migration guidance to use `promptkit show prepared`.
|
||||
|
||||
## Upstream baseline
|
||||
|
||||
The initial review covered CommandKit **v0.7.0**, ckconfig **v0.9.0**, and
|
||||
@@ -197,18 +219,7 @@ responsibilities. Decide their mapping to the CommandKit invocation context
|
||||
and PromptKit operation timeout, separately from the standard per-attempt
|
||||
timeout flag.
|
||||
|
||||
### 2 Prepared-request preview and the existing render command
|
||||
|
||||
Upstream `promptkit show prepared` overlaps Scriptorium's `render` command.
|
||||
Prefer one preparation path and the native prepared report.
|
||||
|
||||
Decide whether the upstream command fully meets the product need, or whether an
|
||||
application command still serves a distinct purpose such as artifact-oriented
|
||||
file output. Retaining the old name or custom report solely for compatibility
|
||||
is already ruled out. Review associated application defaults, including the
|
||||
current render-format setting, when deciding the final interface.
|
||||
|
||||
### 3 Configuration selection and namespace experience
|
||||
### 2 Configuration selection and namespace experience
|
||||
|
||||
Use consistent application configuration and PromptKit source selection across
|
||||
generation, inspection, requirements, and previews. Application-only
|
||||
@@ -225,7 +236,7 @@ namespace-filtered and all-namespace inventory views. Begin with upstream
|
||||
behavior; identify any unmet collection-navigation need before adding local
|
||||
conventions. Collection discovery itself does not need redesign for CommandKit.
|
||||
|
||||
### 4 Native reports and executable consumer needs
|
||||
### 3 Native reports and executable consumer needs
|
||||
|
||||
Adopt native inspection reports as the starting point. Standard prompt
|
||||
inspection includes captured prompt messages, unlike the current Scriptorium
|
||||
@@ -251,7 +262,7 @@ real request and may read input artifacts and check relevant credentials;
|
||||
discovery must work before those artifacts exist. Neither guarantees a future
|
||||
generation will succeed.
|
||||
|
||||
### 5 Application commands and standard request flags
|
||||
### 4 Application commands and standard request flags
|
||||
|
||||
Decide the final generation command operands and application-specific flags
|
||||
around the reusable ckprompt request flag groups. Use their standard names,
|
||||
|
||||
Reference in New Issue
Block a user