mirror of
https://github.com/clap-rs/clap
synced 2024-12-14 14:52:33 +00:00
36bc641648
This is an intermediate solution for #4408. As there were no agreeed upon goals, I went with what I felt read well and that I saw commonly used on non-clap commands. - "information" isn't really a necessary word. - I originally favored `Print this help` but realied that doesn't read correctly in completions. - Besides being shorter, the reason for the flipped short/long hint is it gives people the context they need for scanning, emphasizing "summary" and "more". Fixes #4409
141 lines
3.1 KiB
JavaScript
141 lines
3.1 KiB
JavaScript
const completion: Fig.Spec = {
|
|
name: "my-app",
|
|
description: "Tests completions",
|
|
subcommands: [
|
|
{
|
|
name: "test",
|
|
description: "tests things",
|
|
options: [
|
|
{
|
|
name: "--case",
|
|
description: "the case to test",
|
|
isRepeatable: true,
|
|
args: {
|
|
name: "case",
|
|
isOptional: true,
|
|
},
|
|
},
|
|
{
|
|
name: ["-h", "--help"],
|
|
description: "Print help",
|
|
},
|
|
{
|
|
name: ["-V", "--version"],
|
|
description: "Print version",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
name: "some_cmd",
|
|
description: "top level subcommand",
|
|
subcommands: [
|
|
{
|
|
name: "sub_cmd",
|
|
description: "sub-subcommand",
|
|
options: [
|
|
{
|
|
name: "--config",
|
|
description: "the other case to test",
|
|
isRepeatable: true,
|
|
args: {
|
|
name: "config",
|
|
isOptional: true,
|
|
suggestions: [
|
|
"Lest quotes aren't escaped.",
|
|
],
|
|
},
|
|
},
|
|
{
|
|
name: ["-h", "--help"],
|
|
description: "Print help",
|
|
},
|
|
{
|
|
name: ["-V", "--version"],
|
|
description: "Print version",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
name: "help",
|
|
description: "Print this message or the help of the given subcommand(s)",
|
|
subcommands: [
|
|
{
|
|
name: "sub_cmd",
|
|
description: "sub-subcommand",
|
|
},
|
|
{
|
|
name: "help",
|
|
description: "Print this message or the help of the given subcommand(s)",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
options: [
|
|
{
|
|
name: ["-h", "--help"],
|
|
description: "Print help",
|
|
},
|
|
{
|
|
name: ["-V", "--version"],
|
|
description: "Print version",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
name: "help",
|
|
description: "Print this message or the help of the given subcommand(s)",
|
|
subcommands: [
|
|
{
|
|
name: "test",
|
|
description: "tests things",
|
|
},
|
|
{
|
|
name: "some_cmd",
|
|
description: "top level subcommand",
|
|
subcommands: [
|
|
{
|
|
name: "sub_cmd",
|
|
description: "sub-subcommand",
|
|
},
|
|
],
|
|
},
|
|
{
|
|
name: "help",
|
|
description: "Print this message or the help of the given subcommand(s)",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
options: [
|
|
{
|
|
name: ["-c", "-C", "--config", "--conf"],
|
|
description: "some config file",
|
|
isRepeatable: true,
|
|
},
|
|
{
|
|
name: ["-h", "--help"],
|
|
description: "Print help",
|
|
},
|
|
{
|
|
name: ["-V", "--version"],
|
|
description: "Print version",
|
|
},
|
|
],
|
|
args: [
|
|
{
|
|
name: "file",
|
|
isOptional: true,
|
|
template: "filepaths",
|
|
},
|
|
{
|
|
name: "choice",
|
|
isOptional: true,
|
|
suggestions: [
|
|
"first",
|
|
"second",
|
|
],
|
|
},
|
|
]
|
|
};
|
|
|
|
export default completion;
|