Skip to content

clap_man should respect the configured display order for args and subcommands #6072

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

clap_man should respect the configured display order for args and subcommands #6072

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1d261e4
test(clap_mangen): Test mangen display order
Jul 19, 2025
521f01d
fix(clap_mangen): Take into consideration display_order
Jul 19, 2025
6fd3d69
fix: Code review fixups
Jul 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 10 additions & 3 deletions clap_mangen/src/render.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,11 @@ pub(crate) fn synopsis(roff: &mut Roff, cmd: &clap::Command) {
let name = cmd.get_bin_name().unwrap_or_else(|| cmd.get_name());
let mut line = vec![bold(name), roman(" ")];

for opt in cmd.get_arguments().filter(|i| !i.is_hide_set()) {
let mut opts: Vec<_> = cmd.get_arguments().filter(|i| !i.is_hide_set()).collect();

opts.sort_by_key(|opt| opt.get_display_order());

for opt in opts {
let (lhs, rhs) = option_markers(opt);
match (opt.get_short(), opt.get_long()) {
(Some(short), Some(long)) => {
Expand Down Expand Up @@ -89,7 +93,10 @@ pub(crate) fn synopsis(roff: &mut Roff, cmd: &clap::Command) {
}

pub(crate) fn options(roff: &mut Roff, items: &[&Arg]) {
for opt in items.iter().filter(|a| !a.is_positional()) {
let mut sorted_items = items.to_vec();
sorted_items.sort_by_key(|opt| opt.get_display_order());

for opt in sorted_items.iter().filter(|a| !a.is_positional()) {
let mut header = match (opt.get_short(), opt.get_long()) {
(Some(short), Some(long)) => {
vec![short_option(short), roman(", "), long_option(long)]
Expand Down Expand Up @@ -131,7 +138,7 @@ pub(crate) fn options(roff: &mut Roff, items: &[&Arg]) {
}
}

for pos in items.iter().filter(|a| a.is_positional()) {
for pos in sorted_items.iter().filter(|a| a.is_positional()) {
let mut header = vec![];
let (lhs, rhs) = option_markers(pos);
header.push(roman(lhs));
Expand Down
Loading