janware/jw-pkg
Watch
1
Code Pull requests Activity Actions

cmds.projects.CmdCreateFile: Add --field-* options and integration tests #100

Merged
Jan Lindemann merged 3 commits from jan/feature/20260913-cmds-projects-cmdcreatefile-add-field-x-options-and-integration-tests into master 2026-09-13 22:45:00 +02:00 AGit
Conversation 0 Commits 3 Files changed 9 +300 -8
Jan Lindemann commented 2026-09-13 22:31:26 +02:00
Owner
Copy link

This PR extends CmdCreateFile with --field-keys and --field-separator options for controlling template key validation and list-value joining, and adds end-to-end integration tests covering the command's tmpl and pyright formats:

cmds.projects.CmdCreateFile: Add --field-keys option

The --field option accepts arbitrary KEY=VALUE pairs, inserting them into the rendered template output, but there is no way to declare which keys a template actually supports. Passing a key the template does not use goes unnoticed, and a template cannot offer optional fields that drop out of the output when not supplied.

Add a --field-keys option, a comma-separated list of the keys a template accepts. Passing a key via --field that is not in that list is an error, and keys from the list that are not passed are added with an empty value, so the respective field renders as empty and effectively drops out of the output.

cmds.projects.CmdCreateFile: Add --field-separator option

List values in a rendered template are joined with a fixed separator of ",\n" (comma plus newline), and there is no way to change that. Templates sometimes want a different separator, e.g. a plain newline or a single-line comma-separated list.

Add a --field-separator option that controls how list values are joined in the rendered output. %n expands to a newline, and the default remains ",\n" for both formats. render_tmpl() applies the separator to the rendered template, while render_pyright() rejects any other value: the built-in pyrightconfig.json template is a fixed JSON document, and no alternative separator is supported for it.

Update the help output test expectation accordingly.

test/integration/projects/create-file: Add

CmdCreateFile renders a file from project metadata, yet nothing runs it end to end. The "tmpl" format substitutes --field values into template markers, and the "pyright" format computes extra paths from the jw run dependencies of a module. Both formats are untested, and so is the handling of missing templates, unknown --field keys, and malformed command-line arguments.

Add an integration test under test/integration/jw-pkg/projects that drives the command through the real CLI and diffs the rendered output against a reference. It covers single- and multi-value field substitution, the default and custom field separators including the %n newline escape, value quoting, and --field-keys filling in keys the caller omitted. The pyright case uses a relative topdir so the computed project paths stay relocatable. The error cases check that the command rejects a missing template name, an unknown template file, a --field key outside --field-keys, an unsupported pyright separator, and invalid --format and --field arguments with the expected message and exit status.

This PR extends CmdCreateFile with --field-keys and --field-separator options for controlling template key validation and list-value joining, and adds end-to-end integration tests covering the command's tmpl and pyright formats: #### cmds.projects.CmdCreateFile: Add --field-keys option The --field option accepts arbitrary KEY=VALUE pairs, inserting them into the rendered template output, but there is no way to declare which keys a template actually supports. Passing a key the template does not use goes unnoticed, and a template cannot offer optional fields that drop out of the output when not supplied. Add a --field-keys option, a comma-separated list of the keys a template accepts. Passing a key via --field that is not in that list is an error, and keys from the list that are not passed are added with an empty value, so the respective field renders as empty and effectively drops out of the output. #### cmds.projects.CmdCreateFile: Add --field-separator option List values in a rendered template are joined with a fixed separator of ",\n" (comma plus newline), and there is no way to change that. Templates sometimes want a different separator, e.g. a plain newline or a single-line comma-separated list. Add a --field-separator option that controls how list values are joined in the rendered output. %n expands to a newline, and the default remains ",\n" for both formats. render_tmpl() applies the separator to the rendered template, while render_pyright() rejects any other value: the built-in pyrightconfig.json template is a fixed JSON document, and no alternative separator is supported for it. Update the help output test expectation accordingly. #### test/integration/projects/create-file: Add CmdCreateFile renders a file from project metadata, yet nothing runs it end to end. The "tmpl" format substitutes --field values into template markers, and the "pyright" format computes extra paths from the jw run dependencies of a module. Both formats are untested, and so is the handling of missing templates, unknown --field keys, and malformed command-line arguments. Add an integration test under test/integration/jw-pkg/projects that drives the command through the real CLI and diffs the rendered output against a reference. It covers single- and multi-value field substitution, the default and custom field separators including the %n newline escape, value quoting, and --field-keys filling in keys the caller omitted. The pyright case uses a relative topdir so the computed project paths stay relocatable. The error cases check that the command rejects a missing template name, an unknown template file, a --field key outside --field-keys, an unsupported pyright separator, and invalid --format and --field arguments with the expected message and exit status.
The --field option accepts arbitrary KEY=VALUE pairs, inserting them into
the rendered template output, but there is no way to declare which keys
a template actually supports. Passing a key the template does not use goes
unnoticed, and a template cannot offer optional fields that drop out of
the output when not supplied.

Add a --field-keys option, a comma-separated list of the keys a template
accepts. Passing a key via --field that is not in that list is an error,
and keys from the list that are not passed are added with an empty value,
so the respective field renders as empty and effectively drops out of the
output.

Assisted-by: unsloth/Qwen3.8-27B-GGUF:Q4_K_M with pi.dev v0.85.1
Signed-off-by: Jan Lindemann <jan@janware.com>
List values in a rendered template are joined with a fixed separator of
",\n" (comma plus newline), and there is no way to change that. Templates
sometimes want a different separator, e.g. a plain newline or a single-line
comma-separated list.

Add a --field-separator option that controls how list values are joined
in the rendered output. %n expands to a newline, and the default remains
",\n" for both formats. render_tmpl() applies the separator to the rendered
template, while render_pyright() rejects any other value: the built-in
pyrightconfig.json template is a fixed JSON document, and no alternative
separator is supported for it.

Update the help output test expectation accordingly.

Assisted-by: unsloth/Qwen3.8-27B-GGUF:Q4_K_M with pi.dev v0.85.1
Signed-off-by: Jan Lindemann <jan@janware.com>
test/integration/projects/create-file: Add
All checks were successful
CI / Packaging - Kali Linux (pull_request) Successful in 4m18s
Details
CI / Packaging - OpenSUSE Tumbleweed (pull_request) Successful in 4m24s
Details
CI / Packaging test (pull_request) Successful in 0s
Details
CI / Packaging - Kali Linux (push) Successful in 4m52s
Details
CI / Packaging - OpenSUSE Tumbleweed (push) Successful in 4m30s
Details
CI / Packaging test (push) Successful in 0s
Details
6fe8f5dc65
 
CmdCreateFile renders a file from project metadata, yet nothing runs it end
to end. The "tmpl" format substitutes --field values into template markers,
and the "pyright" format computes extra paths from the jw run dependencies
of a module. Both formats are untested, and so is the handling of missing
templates, unknown --field keys, and malformed command-line arguments.

Add an integration test under test/integration/jw-pkg/projects that drives
the command through the real CLI and diffs the rendered output against
a reference. It covers single- and multi-value field substitution, the
default and custom field separators including the %n newline escape, value
quoting, and --field-keys filling in keys the caller omitted. The pyright
case uses a relative topdir so the computed project paths stay relocatable.
The error cases check that the command rejects a missing template name, an
unknown template file, a --field key outside --field-keys, an unsupported
pyright separator, and invalid --format and --field arguments with the
expected message and exit status.

Assisted-by: unsloth/Qwen3.8-27B-GGUF:Q4_K_M with pi.dev v0.85.1
Signed-off-by: Jan Lindemann <jan@janware.com>
Jan Lindemann scheduled this pull request to auto merge when all checks succeed 2026-09-13 22:31:27 +02:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
janware/jw-pkg!100
No description provided.