Skip to content
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

Align and wrap description, usage, flags, and commands #41

Merged
merged 5 commits into from
Jun 11, 2024
Merged

Align and wrap description, usage, flags, and commands #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
33fefac
Align and wrap description, usage, flags, and commands
richard-viney Jun 7, 2024
7eea046
Make wrapping configurable. Refactoring.
richard-viney Jun 10, 2024
23527f8
Fix typo
richard-viney Jun 10, 2024
2b3319a
Replace \t with spaces and make indent width configurable (default 4 …
richard-viney Jun 10, 2024
069a99b
Add back \t
richard-viney Jun 11, 2024
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
18 changes: 11 additions & 7 deletions birdie_snapshots/cmd1_help.accepted
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,18 @@ Command: cmd1
This is cmd1

USAGE:
gleam run -m test cmd1 ( cmd3 | cmd4 ) [ ARGS ] [ --flag2=<INT> --flag5=<FLOAT_LIST> --global=<STRING> ]
gleam run -m test cmd1 ( cmd3 | cmd4 ) [ ARGS ] [ --flag2=<INT>
--global=<STRING> --very-very-very-long-flag=<FLOAT_LIST> ]

FLAGS:
--flag2=<INT> This is flag2
--flag5=<FLOAT_LIST> This is flag5
--global=<STRING> This is a global flag
--help Print help information
--flag2=<INT> This is flag2
--global=<STRING> This is a global flag
--help Print help information
--very-very-very-long-flag=<FLOAT_LIST> This is a very long flag with a
very very very very very very long
description

SUBCOMMANDS:
cmd3 This is cmd3
cmd4 This is cmd4
cmd3 This is cmd3
cmd4 This is cmd4 which has a very very very very very very
very very long description
6 changes: 3 additions & 3 deletions birdie_snapshots/cmd2_help.accepted
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ Command: cmd2
This is cmd2

USAGE:
gleam run -m test cmd2 <arg1> <arg2> [ --global=<STRING> ]
gleam run -m test cmd2 <arg1> <arg2> [ --global=<STRING> ]

FLAGS:
--global=<STRING> This is a global flag
--help Print help information
--global=<STRING> This is a global flag
--help Print help information
9 changes: 5 additions & 4 deletions birdie_snapshots/cmd3_help.accepted
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,10 @@ Command: cmd1 cmd3
This is cmd3

USAGE:
gleam run -m test cmd1 cmd3 <woo> [ 2 or more arguments ] [ --flag3=<BOOL> --global=<STRING> ]
gleam run -m test cmd1 cmd3 <woo> [ 2 or more arguments ] [ --flag3=<BOOL>
--global=<STRING> ]

FLAGS:
--flag3=<BOOL> This is flag3
--global=<STRING> This is a global flag
--help Print help information
--flag3=<BOOL> This is flag3
--global=<STRING> This is a global flag
--help Print help information
11 changes: 6 additions & 5 deletions birdie_snapshots/cmd4_help.accepted
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,13 @@ Some awesome global help text!

Command: cmd1 cmd4

This is cmd4
This is cmd4 which has a very very very very very very very very long
description

USAGE:
gleam run -m test cmd1 cmd4 [ --flag4=<FLOAT> --global=<STRING> ]
gleam run -m test cmd1 cmd4 [ --flag4=<FLOAT> --global=<STRING> ]

FLAGS:
--flag4=<FLOAT> This is flag4
--global=<STRING> This is a global flag
--help Print help information
--flag4=<FLOAT> This is flag4
--global=<STRING> This is a global flag
--help Print help information
8 changes: 4 additions & 4 deletions birdie_snapshots/cmd6_help.accepted
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ Command: cmd5 cmd6
This is cmd6

USAGE:
gleam run -m test cmd5 cmd6 ( cmd7 ) [ ARGS ] [ --global=<STRING> ]
gleam run -m test cmd5 cmd6 ( cmd7 ) [ ARGS ] [ --global=<STRING> ]

FLAGS:
--global=<STRING> This is a global flag
--help Print help information
--global=<STRING> This is a global flag
--help Print help information

SUBCOMMANDS:
cmd7 This is cmd7
cmd7 This is cmd7
2 changes: 1 addition & 1 deletion birdie_snapshots/cmd7_help.accepted
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ Command: cmd5 cmd6 cmd7
This is cmd7

USAGE:
gleam run -m test cmd5 cmd6 cmd7 [ ARGS ]
gleam run -m test cmd5 cmd6 cmd7 [ ARGS ]
17 changes: 10 additions & 7 deletions birdie_snapshots/root_help.accepted
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,17 @@ Some awesome global help text!
This is the root command

USAGE:
gleam run -m test ( cmd1 | cmd2 | cmd5 ) <arg1> <arg2> [ ARGS ] [ --flag1=<STRING> --global=<STRING> ]
gleam run -m test ( cmd1 | cmd2 | cmd5 | cmd8-very-very-very-very-long )
<arg1> <arg2> [ ARGS ] [ --flag1=<STRING> --global=<STRING> ]

FLAGS:
--flag1=<STRING> This is flag1
--global=<STRING> This is a global flag
--help Print help information
--flag1=<STRING> This is flag1
--global=<STRING> This is a global flag
--help Print help information

SUBCOMMANDS:
cmd1 This is cmd1
cmd2 This is cmd2
cmd5
cmd1 This is cmd1
cmd2 This is cmd2
cmd5
cmd8-very-very-very-very-long This is cmd8 with a very very very very very
very very long description
Loading
Loading