Skip to content

Rename module info subcommand to module view#7052

Merged
pditommaso merged 5 commits intomasterfrom
rename-module-info-to-inspect
Apr 20, 2026
Merged

Rename module info subcommand to module view#7052
pditommaso merged 5 commits intomasterfrom
rename-module-info-to-inspect

Conversation

@pditommaso
Copy link
Copy Markdown
Member

@pditommaso pditommaso commented Apr 20, 2026

Summary

  • Rename the nextflow module info subcommand to nextflow module view
  • Keep info registered as a backward-compatible alias so existing usage keeps working
  • Introduce a generic CmdBase.getAliases() hook and thread it through CmdModule so both JCommander parsing and the usage/help lookup resolve aliases
  • Update the CLI reference, module guide and 26.04 migration notes to use the new name

Rationale

All other nextflow module subcommands are named after a verb describing the action they perform: create, install, run, list, remove, search, publish, spec, validate. info was the odd one out — a noun describing the output rather than the action. Renaming it to view aligns it with the rest of the command surface and makes the CLI read consistently (nextflow module <verb> ...). The legacy info alias is retained to avoid breaking users and scripts already relying on the existing name.

Test plan

  • ./gradlew :nextflow:test --tests "nextflow.cli.module.CmdModuleInfoTest"
  • Manual: nextflow module view <scope>/<name> works
  • Manual: nextflow module info <scope>/<name> still works (alias)
  • Manual: nextflow module -h lists the command under the new name

🤖 Generated with Claude Code

Keep `info` as a backward-compatible alias. Adds a generic
`getAliases()` hook on `CmdBase` so subcommands can declare extra
names, and wires it through `CmdModule` so both the JCommander parser
and the usage/help lookup recognize aliases.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 20, 2026

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit 7a0dfd4
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/69e6230d386d8c0008e2f30d

@netlify
Copy link
Copy Markdown

netlify Bot commented Apr 20, 2026

Deploy Preview for nextflow-docs-staging canceled.

Name Link
🔨 Latest commit f4b6a12
🔍 Latest deploy log https://app.netlify.com/projects/nextflow-docs-staging/deploys/69e664fd6389ab0007f44855

@jorgee
Copy link
Copy Markdown
Contributor

jorgee commented Apr 20, 2026

Docs are still with info. Shouldn't be updated to inspect?

Switch the new name from `inspect` to `view`. The `info` alias is
still kept for backward compatibility. Update the CLI reference,
module guide and 26.04 migration notes to reflect the new name.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Paolo Di Tommaso <paolo.ditommaso@gmail.com>
@pditommaso pditommaso requested a review from a team as a code owner April 20, 2026 14:58
@pditommaso pditommaso changed the title Rename module info subcommand to module inspect Rename module info subcommand to module view Apr 20, 2026
@pditommaso
Copy link
Copy Markdown
Member Author

Updated to view (including docs)

Signed-off-by: Ben Sherman <bentshermann@gmail.com>
Signed-off-by: Ben Sherman <bentshermann@gmail.com>
@pditommaso pditommaso merged commit 7fa1109 into master Apr 20, 2026
24 checks passed
@pditommaso pditommaso deleted the rename-module-info-to-inspect branch April 20, 2026 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants