test(complete): Show newline issue

epage · epage · commit fba7c8597bf3 · 2024-02-16T16:16:36.000-06:00
diff --git a/clap_complete/tests/snapshots/basic.elvish b/clap_complete/tests/snapshots/basic.elvish
@@ -22,7 +22,8 @@ set edit:completion:arg-completer[my-app] = {|@words|
             cand -v 'v'
             cand -h 'Print help'
             cand --help 'Print help'
-            cand test 'Subcommand'
+            cand test 'Subcommand
+with a second line'
             cand help 'Print this message or the help of the given subcommand(s)'
         }
         &'my-app;test'= {
@@ -32,7 +33,8 @@ set edit:completion:arg-completer[my-app] = {|@words|
             cand --help 'Print help'
         }
         &'my-app;help'= {
-            cand test 'Subcommand'
+            cand test 'Subcommand
+with a second line'
             cand help 'Print this message or the help of the given subcommand(s)'
         }
         &'my-app;help;test'= {
diff --git a/clap_complete/tests/snapshots/basic.fish b/clap_complete/tests/snapshots/basic.fish
@@ -1,10 +1,12 @@
 complete -c my-app -n "__fish_use_subcommand" -s c
 complete -c my-app -n "__fish_use_subcommand" -s v
 complete -c my-app -n "__fish_use_subcommand" -s h -l help -d 'Print help'
-complete -c my-app -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand'
+complete -c my-app -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand
+with a second line'
 complete -c my-app -n "__fish_use_subcommand" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
 complete -c my-app -n "__fish_seen_subcommand_from test" -s d
 complete -c my-app -n "__fish_seen_subcommand_from test" -s c
 complete -c my-app -n "__fish_seen_subcommand_from test" -s h -l help -d 'Print help'
-complete -c my-app -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand'
+complete -c my-app -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand
+with a second line'
 complete -c my-app -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
diff --git a/clap_complete/tests/snapshots/basic.ps1 b/clap_complete/tests/snapshots/basic.ps1
@@ -25,7 +25,8 @@ Register-ArgumentCompleter -Native -CommandName 'my-app' -ScriptBlock {
             [CompletionResult]::new('-v', 'v', [CompletionResultType]::ParameterName, 'v')
             [CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help')
             [CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help')
-            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
+            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand
+with a second line')
             [CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
             break
         }
@@ -37,7 +38,8 @@ Register-ArgumentCompleter -Native -CommandName 'my-app' -ScriptBlock {
             break
         }
         'my-app;help' {
-            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
+            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand
+with a second line')
             [CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
             break
         }
diff --git a/clap_complete/tests/snapshots/basic.zsh b/clap_complete/tests/snapshots/basic.zsh
@@ -68,15 +68,17 @@ esac
 (( $+functions[_my-app_commands] )) ||
 _my-app_commands() {
     local commands; commands=(
-'test:Subcommand' \
+'test:Subcommand
+with a second line' \
 'help:Print this message or the help of the given subcommand(s)' \
     )
     _describe -t commands 'my-app commands' commands "$@"
 }
 (( $+functions[_my-app__help_commands] )) ||
 _my-app__help_commands() {
     local commands; commands=(
-'test:Subcommand' \
+'test:Subcommand
+with a second line' \
 'help:Print this message or the help of the given subcommand(s)' \
     )
     _describe -t commands 'my-app help commands' commands "$@"
diff --git a/clap_complete/tests/snapshots/custom_bin_name.elvish b/clap_complete/tests/snapshots/custom_bin_name.elvish
@@ -22,7 +22,8 @@ set edit:completion:arg-completer[bin-name] = {|@words|
             cand -v 'v'
             cand -h 'Print help'
             cand --help 'Print help'
-            cand test 'Subcommand'
+            cand test 'Subcommand
+with a second line'
             cand help 'Print this message or the help of the given subcommand(s)'
         }
         &'bin-name;test'= {
@@ -32,7 +33,8 @@ set edit:completion:arg-completer[bin-name] = {|@words|
             cand --help 'Print help'
         }
         &'bin-name;help'= {
-            cand test 'Subcommand'
+            cand test 'Subcommand
+with a second line'
             cand help 'Print this message or the help of the given subcommand(s)'
         }
         &'bin-name;help;test'= {
diff --git a/clap_complete/tests/snapshots/custom_bin_name.fish b/clap_complete/tests/snapshots/custom_bin_name.fish
@@ -1,10 +1,12 @@
 complete -c bin-name -n "__fish_use_subcommand" -s c
 complete -c bin-name -n "__fish_use_subcommand" -s v
 complete -c bin-name -n "__fish_use_subcommand" -s h -l help -d 'Print help'
-complete -c bin-name -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand'
+complete -c bin-name -n "__fish_use_subcommand" -f -a "test" -d 'Subcommand
+with a second line'
 complete -c bin-name -n "__fish_use_subcommand" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
 complete -c bin-name -n "__fish_seen_subcommand_from test" -s d
 complete -c bin-name -n "__fish_seen_subcommand_from test" -s c
 complete -c bin-name -n "__fish_seen_subcommand_from test" -s h -l help -d 'Print help'
-complete -c bin-name -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand'
+complete -c bin-name -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "test" -d 'Subcommand
+with a second line'
 complete -c bin-name -n "__fish_seen_subcommand_from help; and not __fish_seen_subcommand_from test; and not __fish_seen_subcommand_from help" -f -a "help" -d 'Print this message or the help of the given subcommand(s)'
diff --git a/clap_complete/tests/snapshots/custom_bin_name.ps1 b/clap_complete/tests/snapshots/custom_bin_name.ps1
@@ -25,7 +25,8 @@ Register-ArgumentCompleter -Native -CommandName 'bin-name' -ScriptBlock {
             [CompletionResult]::new('-v', 'v', [CompletionResultType]::ParameterName, 'v')
             [CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help')
             [CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help')
-            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
+            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand
+with a second line')
             [CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
             break
         }
@@ -37,7 +38,8 @@ Register-ArgumentCompleter -Native -CommandName 'bin-name' -ScriptBlock {
             break
         }
         'bin-name;help' {
-            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')
+            [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand
+with a second line')
             [CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')
             break
         }
diff --git a/clap_complete/tests/snapshots/custom_bin_name.zsh b/clap_complete/tests/snapshots/custom_bin_name.zsh
@@ -68,15 +68,17 @@ esac
 (( $+functions[_bin-name_commands] )) ||
 _bin-name_commands() {
     local commands; commands=(
-'test:Subcommand' \
+'test:Subcommand
+with a second line' \
 'help:Print this message or the help of the given subcommand(s)' \
     )
     _describe -t commands 'bin-name commands' commands "$@"
 }
 (( $+functions[_bin-name__help_commands] )) ||
 _bin-name__help_commands() {
     local commands; commands=(
-'test:Subcommand' \
+'test:Subcommand
+with a second line' \
 'help:Print this message or the help of the given subcommand(s)' \
     )
     _describe -t commands 'bin-name help commands' commands "$@"
diff --git a/clap_complete/tests/testsuite/common.rs b/clap_complete/tests/testsuite/common.rs
@@ -15,11 +15,13 @@ pub fn basic_command(name: &'static str) -> clap::Command {
                 .action(clap::ArgAction::SetTrue),
         )
         .subcommand(
-            clap::Command::new("test").about("Subcommand").arg(
-                clap::Arg::new("debug")
-                    .short('d')
-                    .action(clap::ArgAction::Count),
-            ),
+            clap::Command::new("test")
+                .about("Subcommand\nwith a second line")
+                .arg(
+                    clap::Arg::new("debug")
+                        .short('d')
+                        .action(clap::ArgAction::Count),
+                ),
         )
 }
 
diff --git a/clap_complete_fig/tests/common.rs b/clap_complete_fig/tests/common.rs
@@ -13,11 +13,13 @@ pub fn basic_command(name: &'static str) -> clap::Command {
                 .action(clap::ArgAction::SetTrue),
         )
         .subcommand(
-            clap::Command::new("test").about("Subcommand").arg(
-                clap::Arg::new("debug")
-                    .short('d')
-                    .action(clap::ArgAction::Count),
-            ),
+            clap::Command::new("test")
+                .about("Subcommand\nwith a second line")
+                .arg(
+                    clap::Arg::new("debug")
+                        .short('d')
+                        .action(clap::ArgAction::Count),
+                ),
         )
 }
 
diff --git a/clap_complete_fig/tests/snapshots/basic.fig.js b/clap_complete_fig/tests/snapshots/basic.fig.js
@@ -4,7 +4,7 @@ const completion: Fig.Spec = {
   subcommands: [
     {
       name: "test",
-      description: "Subcommand",
+      description: "Subcommand with a second line",
       options: [
         {
           name: "-d",
@@ -25,7 +25,7 @@ const completion: Fig.Spec = {
       subcommands: [
         {
           name: "test",
-          description: "Subcommand",
+          description: "Subcommand with a second line",
         },
         {
           name: "help",
diff --git a/clap_complete_nushell/tests/common.rs b/clap_complete_nushell/tests/common.rs
@@ -18,7 +18,7 @@ pub fn basic_command(name: &'static str) -> Command {
         )
         .subcommand(
             Command::new("test")
-                .about("Subcommand")
+                .about("Subcommand\nwith a second line")
                 .arg(Arg::new("debug").short('d').action(ArgAction::Count)),
         )
 }
@@ -36,7 +36,7 @@ pub fn feature_sample_command(name: &'static str) -> Command {
         .arg(
             Arg::new("config")
                 .action(ArgAction::Count)
-                .help("some config file")
+                .help("some config file\nwith another line")
                 .short('c')
                 .visible_short_alias('C')
                 .long("config")
diff --git a/clap_complete_nushell/tests/snapshots/basic.nu b/clap_complete_nushell/tests/snapshots/basic.nu
@@ -7,6 +7,7 @@ module completions {
   ]
 
   # Subcommand
+with a second line
   export extern "my-app test" [
     -d
     -c
@@ -18,6 +19,7 @@ module completions {
   ]
 
   # Subcommand
+with a second line
   export extern "my-app help test" [
   ]
 
diff --git a/clap_complete_nushell/tests/snapshots/feature_sample.nu b/clap_complete_nushell/tests/snapshots/feature_sample.nu
@@ -8,8 +8,11 @@ module completions {
   export extern my-app [
     file?: string             # some input file
     --config(-c)              # some config file
+with another line
     --conf                    # some config file
+with another line
     -C                        # some config file
+with another line
     choice?: string@"nu-complete my-app choice"
     --help(-h)                # Print help
     --version(-V)             # Print version
diff --git a/clap_complete_nushell/tests/snapshots/special_commands.nu b/clap_complete_nushell/tests/snapshots/special_commands.nu
@@ -8,8 +8,11 @@ module completions {
   export extern my-app [
     file?: string             # some input file
     --config(-c)              # some config file
+with another line
     --conf                    # some config file
+with another line
     -C                        # some config file
+with another line
     choice?: string@"nu-complete my-app choice"
     --help(-h)                # Print help
     --version(-V)             # Print version
diff --git a/clap_complete_nushell/tests/snapshots/sub_subcommands.nu b/clap_complete_nushell/tests/snapshots/sub_subcommands.nu
@@ -8,8 +8,11 @@ module completions {
   export extern my-app [
     file?: string             # some input file
     --config(-c)              # some config file
+with another line
     --conf                    # some config file
+with another line
     -C                        # some config file
+with another line
     choice?: string@"nu-complete my-app choice"
     --help(-h)                # Print help
     --version(-V)             # Print version
diff --git a/clap_mangen/tests/common.rs b/clap_mangen/tests/common.rs
@@ -15,11 +15,13 @@ pub fn basic_command(name: &'static str) -> clap::Command {
                 .action(clap::ArgAction::SetTrue),
         )
         .subcommand(
-            clap::Command::new("test").about("Subcommand").arg(
-                clap::Arg::new("debug")
-                    .short('d')
-                    .action(clap::ArgAction::Count),
-            ),
+            clap::Command::new("test")
+                .about("Subcommand\nwith a second line")
+                .arg(
+                    clap::Arg::new("debug")
+                        .short('d')
+                        .action(clap::ArgAction::Count),
+                ),
         )
 }
 
diff --git a/clap_mangen/tests/snapshots/basic.bash.roff b/clap_mangen/tests/snapshots/basic.bash.roff
@@ -20,6 +20,7 @@ Print help
 .TP
 my\-app\-test(1)
 Subcommand
+with a second line
 .TP
 my\-app\-help(1)
 Print this message or the help of the given subcommand(s)

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,8 @@ set edit:completion:arg-completer[my-app] = {\|@words\|`
`22`	`22`	`cand -v 'v'`
`23`	`23`	`cand -h 'Print help'`
`24`	`24`	`cand --help 'Print help'`
`25`		`- cand test 'Subcommand'`
	`25`	`+ cand test 'Subcommand`
	`26`	`+with a second line'`
`26`	`27`	`cand help 'Print this message or the help of the given subcommand(s)'`
`27`	`28`	`}`
`28`	`29`	`&'my-app;test'= {`
`@@ -32,7 +33,8 @@ set edit:completion:arg-completer[my-app] = {\|@words\|`
`32`	`33`	`cand --help 'Print help'`
`33`	`34`	`}`
`34`	`35`	`&'my-app;help'= {`
`35`		`- cand test 'Subcommand'`
	`36`	`+ cand test 'Subcommand`
	`37`	`+with a second line'`
`36`	`38`	`cand help 'Print this message or the help of the given subcommand(s)'`
`37`	`39`	`}`
`38`	`40`	`&'my-app;help;test'= {`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,8 @@ Register-ArgumentCompleter -Native -CommandName 'my-app' -ScriptBlock {`
`25`	`25`	`[CompletionResult]::new('-v', 'v', [CompletionResultType]::ParameterName, 'v')`
`26`	`26`	`[CompletionResult]::new('-h', 'h', [CompletionResultType]::ParameterName, 'Print help')`
`27`	`27`	`[CompletionResult]::new('--help', 'help', [CompletionResultType]::ParameterName, 'Print help')`
`28`		`- [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')`
	`28`	`+ [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand`
	`29`	`+with a second line')`
`29`	`30`	`[CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')`
`30`	`31`	`break`
`31`	`32`	`}`
`@@ -37,7 +38,8 @@ Register-ArgumentCompleter -Native -CommandName 'my-app' -ScriptBlock {`
`37`	`38`	`break`
`38`	`39`	`}`
`39`	`40`	`'my-app;help' {`
`40`		`- [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand')`
	`41`	`+ [CompletionResult]::new('test', 'test', [CompletionResultType]::ParameterValue, 'Subcommand`
	`42`	`+with a second line')`
`41`	`43`	`[CompletionResult]::new('help', 'help', [CompletionResultType]::ParameterValue, 'Print this message or the help of the given subcommand(s)')`
`42`	`44`	`break`
`43`	`45`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,11 +15,13 @@ pub fn basic_command(name: &'static str) -> clap::Command {`
`15`	`15`	`.action(clap::ArgAction::SetTrue),`
`16`	`16`	`)`
`17`	`17`	`.subcommand(`
`18`		`- clap::Command::new("test").about("Subcommand").arg(`
`19`		`- clap::Arg::new("debug")`
`20`		`- .short('d')`
`21`		`- .action(clap::ArgAction::Count),`
`22`		`- ),`
	`18`	`+ clap::Command::new("test")`
	`19`	`+ .about("Subcommand\nwith a second line")`
	`20`	`+ .arg(`
	`21`	`+ clap::Arg::new("debug")`
	`22`	`+ .short('d')`
	`23`	`+ .action(clap::ArgAction::Count),`
	`24`	`+ ),`
`23`	`25`	`)`
`24`	`26`	`}`
`25`	`27`
Original file line number	Diff line number	Diff line change
`@@ -13,11 +13,13 @@ pub fn basic_command(name: &'static str) -> clap::Command {`
`13`	`13`	`.action(clap::ArgAction::SetTrue),`
`14`	`14`	`)`
`15`	`15`	`.subcommand(`
`16`		`- clap::Command::new("test").about("Subcommand").arg(`
`17`		`- clap::Arg::new("debug")`
`18`		`- .short('d')`
`19`		`- .action(clap::ArgAction::Count),`
`20`		`- ),`
	`16`	`+ clap::Command::new("test")`
	`17`	`+ .about("Subcommand\nwith a second line")`
	`18`	`+ .arg(`
	`19`	`+ clap::Arg::new("debug")`
	`20`	`+ .short('d')`
	`21`	`+ .action(clap::ArgAction::Count),`
	`22`	`+ ),`
`21`	`23`	`)`
`22`	`24`	`}`
`23`	`25`