Merge pull request #543 from DannyBen/add/flag-needs

Add support for needy flags: `flag.needs`

Author: DannyBen

examples/command-default-force/README.md

@@ -93,7 +93,7 @@ args: none
 tester all - Run all tests
 
 Usage:
-  tester all
+  tester [all]
   tester all --help | -h
 
 Options:

examples/command-default/README.md

@@ -102,6 +102,38 @@ args:
 - ${args[source]} = something
 
 
+````
+
+### `$ ./ftp upload`
+
+````shell
+missing required argument: SOURCE
+usage: ftp [upload] SOURCE
+
+
+````
+
+### `$ ./ftp upload -h`
+
+````shell
+ftp upload - Upload a file
+
+Alias: u
+
+Usage:
+  ftp [upload] SOURCE
+  ftp upload --help | -h
+
+Options:
+  --help, -h
+    Show this help
+
+Arguments:
+  SOURCE
+    File to upload
+
+
+
 ````
 
 ### `$ ./ftp upload something`

examples/conflicts/README.md

@@ -51,12 +51,15 @@ Usage:
 Options:
   --cache
     Enable cache
+    Conflicts: --no-cache
 
   --no-cache
     Disable cache
+    Conflicts: --cache, --fast
 
   --fast
     Run faster
+    Conflicts: --no-cache
 
   --help, -h
     Show this help

examples/needs/.gitignore

@@ -0,0 +1 @@
+cli

examples/needs/README.md

@@ -0,0 +1,113 @@
+# Needy Flags Example
+
+Demonstrates the use of needy flags that must be executed together.
+
+This example was generated with:
+
+```bash
+$ bashly init --minimal
+# ... now edit src/bashly.yml to match the example ...
+$ bashly generate
+```
+
+-----
+
+## `bashly.yml`
+
+````yaml
+name: cli
+help: Sample application to demonstrate the use of needy flags
+version: 0.1.0
+
+flags:
+- long: --add
+  short: -a
+  arg: alias
+  help: Alias to add
+  # When using --add, --command and --target must also be provided
+  needs: [--command, --target]
+
+- long: --command
+  short: -c
+  arg: command
+  help: Command for the alias
+  # Note that this relationship is marked on both sides
+  needs: [--add]
+
+- long: --target
+  short: -t
+  arg: target
+  help: Where to add the alias
+  needs: [--add]
+  allowed: [global, local]
+````
+
+
+
+## Output
+
+### `$ ./cli -h`
+
+````shell
+cli - Sample application to demonstrate the use of needy flags
+
+Usage:
+  cli [OPTIONS]
+  cli --help | -h
+  cli --version | -v
+
+Options:
+  --add, -a ALIAS
+    Alias to add
+    Needs: --command, --target
+
+  --command, -c COMMAND
+    Command for the alias
+    Needs: --add
+
+  --target, -t TARGET
+    Where to add the alias
+    Allowed: global, local
+    Needs: --add
+
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+
+
+
+````
+
+### `$ ./cli --add deploy`
+
+````shell
+--add requires --command
+
+
+````
+
+### `$ ./cli --add deploy --command 'git push'`
+
+````shell
+--add requires --target
+
+
+````
+
+### `$ ./cli --add deploy --command 'git push' --target local`
+
+````shell
+# this file is located in 'src/root_command.sh'
+# you can edit it freely and regenerate (it will not be overwritten)
+args:
+- ${args[--add]} = deploy
+- ${args[--command]} = git push
+- ${args[--target]} = local
+
+
+````
+
+
+

examples/needs/src/bashly.yml

@@ -0,0 +1,26 @@
+name: cli
+help: Sample application to demonstrate the use of needy flags
+version: 0.1.0
+
+flags:
+- long: --add
+  short: -a
+  arg: alias
+  help: Alias to add
+  # When using --add, --command and --target must also be provided
+  needs: [--command, --target]
+
+- long: --command
+  short: -c
+  arg: command
+  help: Command for the alias
+  # Note that this relationship is marked on both sides
+  needs: [--add]
+
+- long: --target
+  short: -t
+  arg: target
+  help: Where to add the alias
+  needs: [--add]
+  allowed: [global, local]
+

examples/needs/src/root_command.sh

@@ -0,0 +1,3 @@
+echo "# this file is located in 'src/root_command.sh'"
+echo "# you can edit it freely and regenerate (it will not be overwritten)"
+inspect_args

examples/needs/test.sh

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./cli -h
+./cli --add deploy
+./cli --add deploy --command 'git push'
+./cli --add deploy --command 'git push' --target local

examples/render-mandoc/README.md

@@ -102,7 +102,7 @@ ISSUE TRACKER
 AUTHORS
        Lana Lang.
 
-Version 0.1.0                      July 2024                       download(1)
+Version 0.1.0                     August 2024                      download(1)
 
 
 ````

examples/render-mandoc/docs/download.1

@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 3.2
 .\"
-.TH "download" "1" "July 2024" "Version 0.1.0" "Sample application"
+.TH "download" "1" "August 2024" "Version 0.1.0" "Sample application"
 .SH NAME
 \f[B]download\f[R] \- Sample application
 .SH SYNOPSIS