It must be possible to not call author and about clap method

[Boscop]

StructOpt will always call to author and about method. There should be a way to avoid these call. The goal is that if the value is the empty string, no call will be performed.

The issue originally was:

Order of args in --help should be in the order that fields appear in the options struct.
E.g. I want to have -i shown before -o in --help, but even though I put it before it in the struct, it appears after it in --help, why?

[TeXitoi]

StructOpt doesn't do anything about that, clap does.

You want that: https://docs.rs/clap/2.27.1/clap/enum.AppSettings.html#variant.DeriveDisplayOrder

Using structopt:

extern crate clap;
extern crate structopt;
#[macro_use]
extern crate structopt_derive;

use structopt::StructOpt;

#[derive(StructOpt, Debug)]
#[structopt(setting_raw = "clap::AppSettings::DeriveDisplayOrder")]
struct Opt {
    #[structopt(short = "s")]
    speed: bool,
    #[structopt(short = "d")]
    debug: bool,
}

fn main() {
    let opt = Opt::from_args();
    println!("{:?}", opt);
}

It gives:

$ cargo run -- -h
    Finished dev [unoptimized + debuginfo] target(s) in 0.0 secs
     Running `target/debug/test -h`
test 0.0.1
Guillaume Pinot <texitoi@texitoi.eu>


USAGE:
    test [FLAGS]

FLAGS:
    -s               
    -d               
    -h, --help       Prints help information
    -V, --version    Prints version information

Does it answer your question?

[Boscop]

Thanks!

Is there also a way to display the ARGS before OPTIONS and FLAGS?
Both in the USAGE line but also in the detailed list below.

[TeXitoi]

I can't find any similar feature in clap.

[TeXitoi]

By convention, ARGS will always be at the end on the USAGE line, because you can use -- to say "finish with options/flags, only args now" to be able to have args begining with a - (as used in my invocation of cargo run just above).

Thus, I think clap will not allow such a thing.

[Boscop]

Ah ok, and how can I not include the about or author info in structopt?

[mattiasb]

Sorry for chiming in, but just to be sure: @Boscop did you check the Clap documentation for how to do it there? If yes and it is indeed possible to perform it with Clap, what troubles did you have translating that into StructOpt?

[Boscop]

In clap it's done with .author(..) and .about(..), but Structopt generates the code calling .author(..) and .about(..). How can I tell it to not generate these calls?

[Boscop]

If I pass author="" it calls .author("") (and it generates .about("") if my Cargo.toml description is not set). So those are two additional empty lines between the line containing <program name> <version> and USAGE (in the output of --help). So 3 empty lines in total (if both author and about are set there is 1 line as space).

How can I tell Structopt to not do these calls if the strings are empty? (So there will always be only 1 line space between the line containing <program name> <version> and USAGE).

[TeXitoi]

You're right, that's not possible for the moment. I'll manage the case empty string to not call the clap method on author and about.

[TeXitoi]

v0.1.6 published

[Boscop]

Thanks!

[Boscop]

I just switched from 0.1 to 0.2 and this doesn't work anymore:
#[structopt(setting_raw = "clap::AppSettings::DeriveDisplayOrder)]"

What's the right way to do this now?

[TeXitoi]

The changelog explain everything.

Here, that's raw(setting ="..."))