cmd/plg: update description for filters

gbrlsnchs · May 1, 2020 · 7d4a307 · 7d4a307
1 parent 648f3f1
commit 7d4a307
Show file tree

Hide file tree

Showing 16 changed files with 145 additions and 143 deletions.
diff --git a/cmd/plg/main.go b/cmd/plg/main.go
@@ -75,6 +75,7 @@ func run() int {
 						OptionDetails: cli.OptionDetails{
 							Description: "Comma-separated list of tags. Targets with these tags will also be checked.",
 							Short:       't',
+							ArgLabel:    "TAG 1,...,TAG n",
 						},
 						Recipient: &root.check.tags,
 					},
@@ -123,19 +124,18 @@ func run() int {
 					},
 					"include": cli.VarOption{
 						OptionDetails: cli.OptionDetails{
-							Description: "Comma-separated list of targets to be included when scanning the target.",
-							ArgLabel:    "TARGET 1,...,TARGET n",
+							Description: "File to be included as a target. Repeat option to include more files.",
+							ArgLabel:    "FILE",
 						},
 						Recipient: &root.config.read.include,
 					},
 					"exclude": cli.VarOption{
 						OptionDetails: cli.OptionDetails{
-							Description: "Comma-separated list of targets to be excluded when scanning the target.",
-							ArgLabel:    "TARGET 1,...,TARGET n",
+							Description: "File to be excluded from targets. Repeat option to exclude more files.",
+							ArgLabel:    "FILE",
 						},
 						Recipient: &root.config.read.exclude,
 					},
-
 					"scanhidden": cli.BoolOption{
 						OptionDetails: cli.OptionDetails{
 							Description: "Include hidden files when scanning the target.",
@@ -146,7 +146,8 @@ func run() int {
 					"tags": cli.VarOption{
 						OptionDetails: cli.OptionDetails{
 							Description: "Comma-separated list of tags to be set for the target.",
-							Short: 't',
+							Short:       't',
+							ArgLabel:    "TAG 1,...,TAG n",
 						},
 						Recipient: &root.config.tags,
 					},
@@ -170,19 +171,18 @@ func run() int {
 					},
 					"include": cli.VarOption{
 						OptionDetails: cli.OptionDetails{
-							Description: "Comma-separated list of targets to be included from initialization.",
-							ArgLabel:    "TARGET 1,...,TARGET n",
+							Description: "File to be included as a target. Repeat option to include more files.",
+							ArgLabel:    "FILE",
 						},
 						Recipient: &root.init.read.include,
 					},
 					"exclude": cli.VarOption{
 						OptionDetails: cli.OptionDetails{
-							Description: "Comma-separated list of targets to be excluded from initialization.",
-							ArgLabel:    "TARGET 1,...,TARGET n",
+							Description: "File to be excluded from targets. Repeat option to exclude more files.",
+							ArgLabel:    "FILE",
 						},
 						Recipient: &root.init.read.exclude,
 					},
-
 					"hidden": cli.BoolOption{
 						OptionDetails: cli.OptionDetails{
 							Description: "Include hidden files on initialization.",
@@ -201,6 +201,7 @@ func run() int {
 						OptionDetails: cli.OptionDetails{
 							Description: "Comma-separated list of tags. Targets with these tags will also be linked.",
 							Short:       't',
+							ArgLabel:    "TAG 1,...,TAG n",
 						},
 						Recipient: &root.link.tags,
 					},
@@ -214,6 +215,7 @@ func run() int {
 						OptionDetails: cli.OptionDetails{
 							Description: "Comma-separated list of tags. Targets with these tags will also be shown.",
 							Short:       't',
+							ArgLabel:    "TAG 1,...,TAG n",
 						},
 						Recipient: &root.show.tags,
 					},

diff --git a/cmd/plg/testdata/TestCLI/darwin/check.ct b/cmd/plg/testdata/TestCLI/darwin/check.ct
@@ -5,9 +5,9 @@ USAGE:
     check [OPTIONS]
 
 OPTIONS:
-    -f, -fail    Return an error if there are any conflicts.
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be checked.
+    -f, -fail                      Return an error if there are any conflicts.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be checked.
 
 $ plg check -h
 Check the status of your dotfiles.
@@ -16,9 +16,9 @@ USAGE:
     check [OPTIONS]
 
 OPTIONS:
-    -f, -fail    Return an error if there are any conflicts.
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be checked.
+    -f, -fail                      Return an error if there are any conflicts.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be checked.
 
 $ plg check --> FAIL
 plg: open pilgo.yml: no such file or directory

diff --git a/cmd/plg/testdata/TestCLI/darwin/config.ct b/cmd/plg/testdata/TestCLI/darwin/config.ct
@@ -5,16 +5,16 @@ USAGE:
     config [OPTIONS] [TARGET]
 
 OPTIONS:
-    -b, -basedir <DIR>                      Set the target's base directory. Works recursively for all nested targets, unless overridden.
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded when scanning the target.
-    -f, -flatten                            Prevent the target from being included in the link name.
-    -h, -help                               Print this help message.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included when scanning the target.
-    -l, -link <NAME>                        Set the target's link name.
-    -s, -scandir                            Scan the target and set its files as its own targets.
-    -S, -scanhidden                         Include hidden files when scanning the target.
-    -t, -tags                               Comma-separated list of tags to be set for the target.
-    -H, -usehome                            Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
+    -b, -basedir <DIR>             Set the target's base directory. Works recursively for all nested targets, unless overridden.
+        -exclude <FILE>            File to be excluded from targets. Repeat option to exclude more files.
+    -f, -flatten                   Prevent the target from being included in the link name.
+    -h, -help                      Print this help message.
+        -include <FILE>            File to be included as a target. Repeat option to include more files.
+    -l, -link <NAME>               Set the target's link name.
+    -s, -scandir                   Scan the target and set its files as its own targets.
+    -S, -scanhidden                Include hidden files when scanning the target.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags to be set for the target.
+    -H, -usehome                   Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
 
 $ plg config -h
 Configure a dotfile in the configuration file.
@@ -23,16 +23,16 @@ USAGE:
     config [OPTIONS] [TARGET]
 
 OPTIONS:
-    -b, -basedir <DIR>                      Set the target's base directory. Works recursively for all nested targets, unless overridden.
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded when scanning the target.
-    -f, -flatten                            Prevent the target from being included in the link name.
-    -h, -help                               Print this help message.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included when scanning the target.
-    -l, -link <NAME>                        Set the target's link name.
-    -s, -scandir                            Scan the target and set its files as its own targets.
-    -S, -scanhidden                         Include hidden files when scanning the target.
-    -t, -tags                               Comma-separated list of tags to be set for the target.
-    -H, -usehome                            Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
+    -b, -basedir <DIR>             Set the target's base directory. Works recursively for all nested targets, unless overridden.
+        -exclude <FILE>            File to be excluded from targets. Repeat option to exclude more files.
+    -f, -flatten                   Prevent the target from being included in the link name.
+    -h, -help                      Print this help message.
+        -include <FILE>            File to be included as a target. Repeat option to include more files.
+    -l, -link <NAME>               Set the target's link name.
+    -s, -scandir                   Scan the target and set its files as its own targets.
+    -S, -scanhidden                Include hidden files when scanning the target.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags to be set for the target.
+    -H, -usehome                   Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
 
 $ mkdir targets
 $ mkdir links

diff --git a/cmd/plg/testdata/TestCLI/darwin/init.ct b/cmd/plg/testdata/TestCLI/darwin/init.ct
@@ -57,11 +57,11 @@ USAGE:
     init [OPTIONS]
 
 OPTIONS:
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded from initialization.
-    -f, -force                              Overwrite the existing configuration file.
-    -h, -help                               Print this help message.
-    -H, -hidden                             Include hidden files on initialization.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included from initialization.
+        -exclude <FILE>    File to be excluded from targets. Repeat option to exclude more files.
+    -f, -force             Overwrite the existing configuration file.
+    -h, -help              Print this help message.
+    -H, -hidden            Include hidden files on initialization.
+        -include <FILE>    File to be included as a target. Repeat option to include more files.
 
 $ plg init -h
 Initialize a configuration file.
@@ -70,8 +70,8 @@ USAGE:
     init [OPTIONS]
 
 OPTIONS:
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded from initialization.
-    -f, -force                              Overwrite the existing configuration file.
-    -h, -help                               Print this help message.
-    -H, -hidden                             Include hidden files on initialization.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included from initialization.
+        -exclude <FILE>    File to be excluded from targets. Repeat option to exclude more files.
+    -f, -force             Overwrite the existing configuration file.
+    -h, -help              Print this help message.
+    -H, -hidden            Include hidden files on initialization.
+        -include <FILE>    File to be included as a target. Repeat option to include more files.
diff --git a/cmd/plg/testdata/TestCLI/darwin/link.ct b/cmd/plg/testdata/TestCLI/darwin/link.ct
@@ -5,8 +5,8 @@ USAGE:
     link [OPTIONS]
 
 OPTIONS:
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be linked.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be linked.
 
 $ plg link -h
 Link your dotfiles as set in the configuration file.
@@ -15,8 +15,8 @@ USAGE:
     link [OPTIONS]
 
 OPTIONS:
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be linked.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be linked.
 
 $ plg link --> FAIL
 plg: open pilgo.yml: no such file or directory

diff --git a/cmd/plg/testdata/TestCLI/darwin/show.ct b/cmd/plg/testdata/TestCLI/darwin/show.ct
@@ -5,8 +5,8 @@ USAGE:
     show [OPTIONS]
 
 OPTIONS:
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be shown.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be shown.
 
 $ plg show -h
 Show your dotfiles in a tree view.
@@ -15,8 +15,8 @@ USAGE:
     show [OPTIONS]
 
 OPTIONS:
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be shown.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be shown.
 
 $ plg show --> FAIL
 plg: open pilgo.yml: no such file or directory

diff --git a/cmd/plg/testdata/TestCLI/linux/check.ct b/cmd/plg/testdata/TestCLI/linux/check.ct
@@ -5,9 +5,9 @@ USAGE:
     check [OPTIONS]
 
 OPTIONS:
-    -f, -fail    Return an error if there are any conflicts.
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be checked.
+    -f, -fail                      Return an error if there are any conflicts.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be checked.
 
 $ plg check -h
 Check the status of your dotfiles.
@@ -16,9 +16,9 @@ USAGE:
     check [OPTIONS]
 
 OPTIONS:
-    -f, -fail    Return an error if there are any conflicts.
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be checked.
+    -f, -fail                      Return an error if there are any conflicts.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be checked.
 
 $ plg check --> FAIL
 plg: open pilgo.yml: no such file or directory

diff --git a/cmd/plg/testdata/TestCLI/linux/config.ct b/cmd/plg/testdata/TestCLI/linux/config.ct
@@ -5,16 +5,16 @@ USAGE:
     config [OPTIONS] [TARGET]
 
 OPTIONS:
-    -b, -basedir <DIR>                      Set the target's base directory. Works recursively for all nested targets, unless overridden.
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded when scanning the target.
-    -f, -flatten                            Prevent the target from being included in the link name.
-    -h, -help                               Print this help message.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included when scanning the target.
-    -l, -link <NAME>                        Set the target's link name.
-    -s, -scandir                            Scan the target and set its files as its own targets.
-    -S, -scanhidden                         Include hidden files when scanning the target.
-    -t, -tags                               Comma-separated list of tags to be set for the target.
-    -H, -usehome                            Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
+    -b, -basedir <DIR>             Set the target's base directory. Works recursively for all nested targets, unless overridden.
+        -exclude <FILE>            File to be excluded from targets. Repeat option to exclude more files.
+    -f, -flatten                   Prevent the target from being included in the link name.
+    -h, -help                      Print this help message.
+        -include <FILE>            File to be included as a target. Repeat option to include more files.
+    -l, -link <NAME>               Set the target's link name.
+    -s, -scandir                   Scan the target and set its files as its own targets.
+    -S, -scanhidden                Include hidden files when scanning the target.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags to be set for the target.
+    -H, -usehome                   Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
 
 $ plg config -h
 Configure a dotfile in the configuration file.
@@ -23,16 +23,16 @@ USAGE:
     config [OPTIONS] [TARGET]
 
 OPTIONS:
-    -b, -basedir <DIR>                      Set the target's base directory. Works recursively for all nested targets, unless overridden.
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded when scanning the target.
-    -f, -flatten                            Prevent the target from being included in the link name.
-    -h, -help                               Print this help message.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included when scanning the target.
-    -l, -link <NAME>                        Set the target's link name.
-    -s, -scandir                            Scan the target and set its files as its own targets.
-    -S, -scanhidden                         Include hidden files when scanning the target.
-    -t, -tags                               Comma-separated list of tags to be set for the target.
-    -H, -usehome                            Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
+    -b, -basedir <DIR>             Set the target's base directory. Works recursively for all nested targets, unless overridden.
+        -exclude <FILE>            File to be excluded from targets. Repeat option to exclude more files.
+    -f, -flatten                   Prevent the target from being included in the link name.
+    -h, -help                      Print this help message.
+        -include <FILE>            File to be included as a target. Repeat option to include more files.
+    -l, -link <NAME>               Set the target's link name.
+    -s, -scandir                   Scan the target and set its files as its own targets.
+    -S, -scanhidden                Include hidden files when scanning the target.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags to be set for the target.
+    -H, -usehome                   Use home directory as the target's base directory and recursively for all nested targets, unless overridden.
 
 $ mkdir targets
 $ mkdir links

diff --git a/cmd/plg/testdata/TestCLI/linux/init.ct b/cmd/plg/testdata/TestCLI/linux/init.ct
@@ -57,11 +57,11 @@ USAGE:
     init [OPTIONS]
 
 OPTIONS:
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded from initialization.
-    -f, -force                              Overwrite the existing configuration file.
-    -h, -help                               Print this help message.
-    -H, -hidden                             Include hidden files on initialization.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included from initialization.
+        -exclude <FILE>    File to be excluded from targets. Repeat option to exclude more files.
+    -f, -force             Overwrite the existing configuration file.
+    -h, -help              Print this help message.
+    -H, -hidden            Include hidden files on initialization.
+        -include <FILE>    File to be included as a target. Repeat option to include more files.
 
 $ plg init -h
 Initialize a configuration file.
@@ -70,8 +70,8 @@ USAGE:
     init [OPTIONS]
 
 OPTIONS:
-        -exclude <TARGET 1,...,TARGET n>    Comma-separated list of targets to be excluded from initialization.
-    -f, -force                              Overwrite the existing configuration file.
-    -h, -help                               Print this help message.
-    -H, -hidden                             Include hidden files on initialization.
-        -include <TARGET 1,...,TARGET n>    Comma-separated list of targets to be included from initialization.
+        -exclude <FILE>    File to be excluded from targets. Repeat option to exclude more files.
+    -f, -force             Overwrite the existing configuration file.
+    -h, -help              Print this help message.
+    -H, -hidden            Include hidden files on initialization.
+        -include <FILE>    File to be included as a target. Repeat option to include more files.
diff --git a/cmd/plg/testdata/TestCLI/linux/link.ct b/cmd/plg/testdata/TestCLI/linux/link.ct
@@ -5,8 +5,8 @@ USAGE:
     link [OPTIONS]
 
 OPTIONS:
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be linked.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be linked.
 
 $ plg link -h
 Link your dotfiles as set in the configuration file.
@@ -15,8 +15,8 @@ USAGE:
     link [OPTIONS]
 
 OPTIONS:
-    -h, -help    Print this help message.
-    -t, -tags    Comma-separated list of tags. Targets with these tags will also be linked.
+    -h, -help                      Print this help message.
+    -t, -tags <TAG 1,...,TAG n>    Comma-separated list of tags. Targets with these tags will also be linked.
 
 $ plg link --> FAIL
 plg: open pilgo.yml: no such file or directory