Merge pull request #160 from DannyBen/add/stdin-support

Add support for stdin

Author: DannyBen

examples/stdin/.gitignore

@@ -0,0 +1,2 @@
+src/initialize.sh
+cli

examples/stdin/README.md

@@ -0,0 +1,93 @@
+# STDIN Example
+
+Demonstrates how to read from STDIN.
+
+This example was generated with:
+
+```bash
+$ bashly init --minimal
+# ... now edit bashly.yml to match ...
+$ bashly generate
+# ... now edit *.sh to match ...
+$ bashly generate
+```
+
+<!-- include: src/root_command.sh -->
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: cli
+help: STDIN Example
+version: 0.1.0
+
+args:
+- name: path
+  
+  # Set the default path value to -, which is the standard operator for stdin.
+  default: "-"
+  help: Path to file (reads from stdin if empty)
+
+flags:
+- long: --file
+  short: -f
+  arg: path
+
+  # This is also supported in flags
+  # Note that in both cases, your script needs to handle the value '-' as there
+  # is no special treatment in bashly, other than allowing '-' as argument.
+  default: "-"
+  help: Another path to file
+```
+
+## `src/root_command.sh`
+
+```bash
+inspect_args
+
+# Since cat knows how to handle '-' as a value, it will work with both a file
+# path and '-' argument.
+cat "${args[path]}"
+
+```
+
+
+## Generated script output
+
+### `$ ./cli some-file`
+
+```shell
+args:
+- ${args[--file]} = -
+- ${args[path]} = some-file
+some file with some content
+
+
+```
+
+### `$ cat some-file | ./cli`
+
+```shell
+args:
+- ${args[--file]} = -
+- ${args[path]} = -
+some file with some content
+
+
+```
+
+### `$ cat some-file | ./cli -`
+
+```shell
+args:
+- ${args[--file]} = -
+- ${args[path]} = -
+some file with some content
+
+
+```
+
+
+

examples/stdin/some-file

@@ -0,0 +1 @@
+some file with some content

examples/stdin/src/bashly.yml

@@ -0,0 +1,22 @@
+name: cli
+help: STDIN Example
+version: 0.1.0
+
+args:
+- name: path
+  
+  # Set the default path value to -, which is the standard operator for stdin.
+  default: "-"
+  help: Path to file (reads from stdin if empty)
+
+flags:
+- long: --file
+  short: -f
+  arg: path
+
+  # This is also supported in flags
+  # Note that in both cases, your script needs to handle the value '-' as there
+  # is no special treatment in bashly, other than allowing '-' as argument.
+  default: "-"
+  help: Another path to file
+

examples/stdin/src/root_command.sh

@@ -0,0 +1,5 @@
+inspect_args
+
+# Since cat knows how to handle '-' as a value, it will work with both a file
+# path and '-' argument.
+cat "${args[path]}"

examples/stdin/test.sh

@@ -0,0 +1,13 @@
+#!/usr/bin/env bash
+
+rm -f "src/initialize.sh"
+
+set -x
+
+bashly generate
+
+### Try Me ###
+
+./cli some-file
+cat some-file | ./cli
+cat some-file | ./cli -

lib/bashly/views/command/parse_requirements_while.erb

@@ -7,7 +7,7 @@ while [[ $# -gt 0 ]]; do
 
 % end
 
-  -* )
+  -?* )
 % if catch_all
     other_args+=("$1")
     shift

spec/approvals/examples/stdin

@@ -0,0 +1,23 @@
++ bashly generate
+creating user files in src
+created src/initialize.sh
+skipped src/root_command.sh (exists)
+created ./cli
+run ./cli --help to test your bash script
++ ./cli some-file
+args:
+- ${args[--file]} = -
+- ${args[path]} = some-file
+some file with some content
++ cat some-file
++ ./cli
+args:
+- ${args[--file]} = -
+- ${args[path]} = -
+some file with some content
++ cat some-file
++ ./cli -
+args:
+- ${args[--file]} = -
+- ${args[path]} = -
+some file with some content