feat: param description#30
Open
rickliujh wants to merge 5 commits into
Open
Conversation
Add a documentary `description` field to both static and dynamic param definitions. When a required static param is missing, its description is appended to the error so the failure is self-explanatory. The field is documentary only and never rendered, so it is exempt from T4. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Add an optional Prompter to module.Load via a functional option. When the root module is run with --interactive/-i, each required static param that is neither provided nor defaulted is prompted for on stdin using its name and description, then used as if supplied via --param. Prompting is root-only (child modules never receive a prompter) and static- only (dynamic params derive from commands). Default behavior is unchanged: without --interactive, missing required params fail fast. On EOF with no value the run fails rather than blocking, so --interactive in a non-TTY context does not hang. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Cover the optional param `description` field and the `run --interactive` flag across the README, the loom.yaml schema reference, the run CLI reference, and the getting-started guide. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Owner
Author
|
Add an optional description to metadata (the module itself) and to spec.modules[] (child references), alongside the existing param descriptions. Both new fields are documentary but templatable, rendered in place with resolved params: metadata.description with the module's own params during Load, modules[].description with the parent's params in the executor. Per the T4 rule (every string field except spec.params is templatable), this also corrects dynamicParams[].description to be templatable — it was wrongly exempted when first added. params[].description stays documentary and non-templated, since it is surfaced before params resolve (P7). Both new fields are validated for undeclared param refs like other templatable fields. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.