- Add bash completion generation

Author: DannyBen

examples/README.md

@@ -42,3 +42,4 @@ Each of these examples demonstrates one aspect or feature of bashly.
 - [config-ini](config-ini#readme) - using the config (INI) functions
 - [colors](colors#readme) - using the color print feature
 - [yaml](yaml#readme) - using the YAML reading functions
+- [completions](completions#readme) - adding bash completion functionality

examples/completions/README.md

@@ -0,0 +1,161 @@
+# Bash Completions Example
+
+Demonstrates how to build a script that supports bash completions.
+
+This example was generated with:
+
+    $ bashly init
+    $ bashly add comp function
+    $ bashly generate
+
+-----
+
+## `bashly.yml`
+
+```yaml
+name: cli
+help: Sample application with bash completions
+version: 0.1.0
+
+commands:
+- name: completions
+  help: |-
+    Generate bash completions
+    Usage: eval "\$(cli completions)"
+
+- name: download
+  short: d
+  help: Download a file
+
+  args:
+  - name: source
+    required: true
+    help: URL to download from
+  - name: target
+    help: "Target filename (default: same as source)"
+
+  flags:
+  - long: --force
+    short: -f
+    help: Overwrite existing files
+
+  examples:
+  - cli download example.com
+  - cli download example.com ./output -f
+
+  environment_variables:
+  - name: default_target_location
+    help: Set the default location to download to
+
+- name: upload
+  short: u
+  help: Upload a file
+  args:
+  - name: source
+    required: true
+    help: File to upload
+
+  flags:
+  - long: --user
+    short: -u
+    arg: user
+    help: Username to use for logging in
+    required: true
+  - long: --password
+    short: -p
+    arg: password
+    help: Password to use for logging in
+```
+
+## Generated script output
+
+### `$ ./cli`
+
+```shell
+cli - Sample application with bash completions
+
+Usage:
+  cli [command]
+  cli [command] --help | -h
+  cli --version | -v
+
+Commands:
+  completions   Generate bash completions
+  download      Download a file
+  upload        Upload a file
+
+
+
+```
+
+### `$ ./cli -h`
+
+```shell
+cli - Sample application with bash completions
+
+Usage:
+  cli [command]
+  cli [command] --help | -h
+  cli --version | -v
+
+Commands:
+  completions   Generate bash completions
+  download      Download a file
+  upload        Upload a file
+
+Options:
+  --help, -h
+    Show this help
+
+  --version, -v
+    Show version number
+
+
+
+```
+
+### `$ ./cli completions -h`
+
+```shell
+cli completions
+
+  Generate bash completions
+  Usage: eval "$(cli completions)"
+
+Usage:
+  cli completions
+  cli completions --help | -h
+
+Options:
+  --help, -h
+    Show this help
+
+
+
+```
+
+### `$ ./cli completions`
+
+```shell
+#!/usr/bin/env bash
+
+# This bash completions script was generated by
+# completely (https://github.com/dannyben/completely)
+# Modifying it manually is not recommended
+_cli_completions() {
+  local cur=${COMP_WORDS[COMP_CWORD]}
+
+  case "$COMP_LINE" in
+    'cli download'*) COMPREPLY=($(compgen -W "--force --help -f -h" -- "$cur")) ;;
+    'cli upload'*) COMPREPLY=($(compgen -W "--help --password --user -h -p -u" -- "$cur")) ;;
+    'cli'*) COMPREPLY=($(compgen -W "--help --version -h -v download upload" -- "$cur")) ;;
+  esac
+}
+
+complete -F _cli_completions cli
+
+
+```
+
+
+