branch_io_cli 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b4f76e8512262791b421dfa384a6150ad7adf8
-  data.tar.gz: b4e8cfd9acf1603beb48492f4f8484a7b30fcb34
+  metadata.gz: 4a59f8d672ea8d70c83d6bd2e23f1b56c1ace20f
+  data.tar.gz: 7a1367bb08e6e2bc1b9a496df9b79e9fd23cb0ef
 SHA512:
-  metadata.gz: 24e6d7cf3dcd20c0e99811a8292b424072dece3635c686ed80a78ce1934735bb3371f15c4264c805d656ae5896a8cb182b5f3c75708c03ad8dbda7ced4953025
-  data.tar.gz: d0c6011905c5d1aa3f1d811fba99006823bd9d52301fc4ab69217c6f93fbbd131f70e9026dd1a9cc1c3ed071729fec25cf076b7a97a76062bef0c1308a3d1f1a
+  metadata.gz: f3e1dad4aa4a7e8481275f6c3032ffd71c1f7ab67ff3d8aea9601b09f78b13cc6727c74fbe85aa9301995a622cc8f9f1ba5de0773e7a89fe12214a288380d0b2
+  data.tar.gz: 597fc8f8ed4f486e97ac60858d145b16bc6c14de69698502cdfcb11d2c538da2c540c6b39f16c3610f7541251318a2b0fbf003ef64c49724437ef2a7d76283e3

data/README.md

@@ -30,6 +30,32 @@ branch_io setup -h
 branch_io validate -h
 ```
 
+### Shell completion
+
+_Work in progress_
+
+You can enable completion of all options in `bash` or `zsh`. The following
+additions should follow initialization of RVM, rbenv or chruby or setting
+any Ruby-related environment variables if using the system Ruby.
+
+#### Bash
+
+Add to `~/.bash_profile` or `~/.bashrc`:
+
+```bash
+. `gem which branch_io_cli | sed 's+branch_io_cli.rb$+assets/completions/completion.bash+'`
+```
+
+#### Zsh
+
+Add to `~/.zshrc`:
+
+```zsh
+. `gem which branch_io_cli | sed 's+branch_io_cli.rb$+assets/completions/completion.zsh+'`
+```
+
+Currently command-line completion for bash is much more extensive than for zsh.
+
 ## Commands
 
 ### Setup command
@@ -86,6 +112,9 @@ command, respectively, available in your path.
 
 |Option|Description|
 |------|-----------|
+|-h, --help|Prints a list of commands or help for each command|
+|-v, --version|Prints the current version of the CLI|
+|-t, --trace|Prints a stack trace when exceptions are raised|
 |-L, --live-key key_live_xxxx|Branch live key|
 |-T, --test-key key_test_yyyy|Branch test key|
 |--app-link-subdomain myapp|Branch app.link subdomain, e.g. myapp for myapp.app.link|
@@ -154,6 +183,9 @@ targets.
 
 |Option|Description|
 |------|-----------|
+|-h, --help|Prints a list of commands or help for each command|
+|-v, --version|Prints the current version of the CLI|
+|-t, --trace|Prints a stack trace when exceptions are raised|
 |-D, --domains example.com,www.example.com|Comma-separated list of domains. May include app.link subdomains.|
 |--xcodeproj MyProject.xcodeproj|Path to an Xcode project to update|
 |--target MyAppTarget|Name of a target to modify in the Xcode project|

data/lib/assets/completions/completion.bash

@@ -0,0 +1,41 @@
+#!/bin/bash
+
+_branch_io_complete()
+{
+    local cur prev opts global_opts setup_opts validate_opts commands cmd
+    COMPREPLY=()
+    cur="${COMP_WORDS[COMP_CWORD]}"
+    prev="${COMP_WORDS[COMP_CWORD-1]}"
+    cmd="${COMP_WORDS[1]}"
+
+    commands="setup validate"
+    global_opts="-h --help -t --trace -v --version"
+
+    setup_opts="$global_opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme"
+    setup_opts="$setup_opts --xcodeproj --target --frameworks --podfile --cartfile"
+    # Don't autocomplete the default values here, e.g. --no-force, --pod-repo-update.
+    setup_opts="$setup_opts --no-add-sdk --no-validate --force --no-pod-repo-update --commit --no-patch-source"
+
+    validate_opts="$global_opts -D --domains --xcodeproj --target"
+
+    if [[ ${cur} == -* ]] ; then
+      case "${cmd}" in
+        setup)
+          opts=$setup_opts
+          ;;
+        validate)
+          opts=$validate_opts
+          ;;
+        *)
+          opts=$global_opts
+          ;;
+      esac
+      COMPREPLY=( $(compgen -W "${opts}" -- ${cur}) )
+    elif [[ ${prev} == branch_io ]] ; then
+      COMPREPLY=( $(compgen -W "${commands}" -- ${cur}) )
+    else
+      COMPREPLY=( $(compgen -o default ${cur}) )
+    fi
+    return 0
+}
+complete -F _branch_io_complete branch_io

data/lib/assets/completions/completion.zsh

@@ -0,0 +1,15 @@
+#!/bin/zsh
+
+_branch_io_complete() {
+  local word opts
+  word="$1"
+  opts="-h --help -t --trace -v --version"
+  opts="$opts -L --live-key -T --test-key -D --domains --app-link-subdomain -U --uri-scheme"
+  opts="$opts --xcodeproj --target --frameworks --podfile --cartfile"
+  # Don't autocomplete the default values here, e.g. --no-force, --pod-repo-update.
+  opts="$opts --no-add-sdk --no-validate --force --no-pod-repo-update --commit --no-patch-source"
+
+  reply=( "${(ps: :)opts}" )
+}
+
+compctl -K _branch_io_complete branch_io

data/lib/branch_io_cli/version.rb

@@ -1,3 +1,3 @@
 module BranchIOCLI
-  VERSION = "0.5.2"
+  VERSION = "0.5.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: branch_io_cli
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - Branch
@@ -220,6 +220,8 @@ files:
 - LICENSE
 - README.md
 - bin/branch_io
+- lib/assets/completions/completion.bash
+- lib/assets/completions/completion.zsh
 - lib/branch_io_cli.rb
 - lib/branch_io_cli/cli.rb
 - lib/branch_io_cli/commands.rb