Merge branch 'master' into develop

Author: Sushil Gupta

CHANGELOG.md

@@ -1,3 +1,13 @@
+## [0.3.2] 2018-09-06 15:09:22 UTC
+
+- [6e8755f](https://github.com/adhocore/php-cli/commit/6e8755f) docs: autocompletion (Jitendra Adhikari)
+- [1152671](https://github.com/adhocore/php-cli/commit/1152671) chore(zsh.plugin): auto complete provider for zsh with oh-my-zsh (Jitendra Adhikari)
+
+## [0.3.1] 2018-09-06 00:09:23 UTC
+
+- [f390b6b](https://github.com/adhocore/php-cli/commit/f390b6b) refactor: remove redundant codeCoverageIgnore (Sushil Gupta)
+- [cd8d109](https://github.com/adhocore/php-cli/commit/cd8d109) refactor: minor refactor on messages + add isWindows() method using DIRECTORY_SEPARATOR check to set pipes (Sushil Gupta)
+
 ## [0.3.0] 2018-09-04 15:09:50 UTC
 
 - [a1c2c30](https://github.com/adhocore/php-cli/commit/a1c2c30) docs: add shell section and contributors (Jitendra Adhikari)

README.md

@@ -21,6 +21,8 @@ Framework agnostic Command Line Interface utilities and helpers for PHP. Build C
 
 **IO:** [Colorizer](#color) · [Cursor manipulator](#cursor) · [Stream writer](#writer) · [Stream reader](#reader)
 
+**Other:** [Autocompletion](#autocompletion)
+
 ## Installation
 ```bash
 composer require adhocore/cli
@@ -227,7 +229,7 @@ Same version number is passed to all attached Commands. So you can trigger versi
 
 ### Shell
 
-Very thing shell wrapper that provides convenience methods around `proc_open()`.
+Very thin shell wrapper that provides convenience methods around `proc_open()`.
 
 #### Basic usage
 
@@ -489,11 +491,69 @@ Whenever an exception is caught by `Application::handle()`, it will show a beaut
 
 ![Exception Preview](https://user-images.githubusercontent.com/2908547/44401057-8b350880-a577-11e8-8ca6-20508d593d98.png "Exception trace")
 
+### Autocompletion
+
+Any console applications that are built on top of **adhocore/cli** can entertain autocomplete of commands and options in zsh shell with oh-my-zsh.
+
+All you have to do is add one line to the end of `~/.oh-my-zsh/custom/plugins/ahccli/ahccli.plugin.zsh`:
+
+> `compdef _ahccli <appname>`
+
+Example: `compdef _ahccli phint` for [phint](https://github.com/adhocore/phint).
+
+That is cumbersome to perform manually, here's a complete command you can copy/paste/run:
+
+#### One time setup
+
+```sh
+mkdir -p ~/.oh-my-zsh/custom/plugins/ahccli && cd ~/.oh-my-zsh/custom/plugins/ahccli
+
+[ -f ./ahccli.plugin.zsh ] || curl -sSLo ./ahccli.plugin.zsh https://raw.githubusercontent.com/adhocore/php-cli/master/ahccli.plugin.zsh
+
+chmod 760 ./ahccli.plugin.zsh && cd -
+```
+
+##### Load ahccli plugin
+
+> This is also one time setup.
+
+```sh
+# Open .zshrc
+nano ~/.zshrc
+
+# locate plugins=(... ...) and add ahccli
+plugins=(git ... ... ahccli)
+
+# ... then save it (Ctrl + O)
+```
+
+#### Registering app
+
+```sh
+# replace appname with real name eg: phint
+echo compdef _ahccli appname >> ~/.oh-my-zsh/custom/plugins/ahccli/ahccli.plugin.zsh
+```
+
+> Of course you can add multiple apps, just change appname in above command
+
+Then either restart the shell or source the plugin like so:
+
+```sh
+source ~/.oh-my-zsh/custom/plugins/ahccli/ahccli.plugin.zsh
+```
+
+#### Trigger autocomplete
+
+```sh
+appname <tab>            # autocompletes commands               (phint <tab>)
+appname subcommand <tab> # autocompletes options for subcommand (phint init <tab>)
+```
+
 ### Related
 
-- [adhocore/phalcon-ext](https://github.com/adhocore/phalcon-ext) Phalcon extension using `adhocore/cli`
-- [adhocore/phint](https://github.com/adhocore/phint) PHP project scaffolding app using `adhocore/cli`
-- [adhocore/type-hinter](https://github.com/adhocore/php-type-hinter) Auto PHP7 typehinter tool using `adhocore/cli`
+- [adhocore/phalcon-ext](https://github.com/adhocore/phalcon-ext) &middot; Phalcon extension using `adhocore/cli`
+- [adhocore/phint](https://github.com/adhocore/phint) &middot; PHP project scaffolding app using `adhocore/cli`
+- [adhocore/type-hinter](https://github.com/adhocore/php-type-hinter) &middot; Auto PHP7 typehinter tool using `adhocore/cli`
 
 ### Contributors
 

VERSION

@@ -1 +1 @@
-0.3.0
+0.3.2

ahccli.plugin.zsh

@@ -0,0 +1,42 @@
+# ------------------------------------------------------------------------------
+#          FILE:  ahccli.plugin.zsh
+#   DESCRIPTION:  oh-my-zsh ahccli plugin file.
+#        AUTHOR:  Jitendra Adhikari ([email protected])
+#       VERSION:  0.0.1
+#       LICENSE:  MIT
+# ------------------------------------------------------------------------------
+# Specifically tuned to support autocompletion for apps build with adhocore/cli!
+#         Check https://github.com/adhocore/php-cli#autocompletion
+# ------------------------------------------------------------------------------
+
+# AhcCli command completion
+_ahccli_command_list () {
+  command $1 --help 2>/dev/null | sed "1,/Commands/d" | gawk 'match($0, /  ([a-z]+) [a-z]*  /, c) { print c[1] }'
+}
+
+# AhcCli option completion
+_ahccli_option_list () {
+  command $1 $2 --help 2>/dev/null | sed '1,/Options/d' | gawk 'match($0, /  .*(--[a-z-]+)(\.\.\.)?.    /, o) { print o[1] }'
+}
+
+# AhcCli compdef handler
+_ahccli () {
+  local curcontext="$curcontext" state line cmd subcmd
+  typeset -A opt_args
+  _arguments '1: :->cmd' '*: :->opts'
+
+  cmd=`echo $curcontext | gawk 'match($0, /\:([_a-z-]+)\:$/, c) { print c[1] }'`
+  subcmd=`echo $line | awk '{print $1}'`
+
+  case $state in
+    cmd) compadd $(_ahccli_command_list $cmd) ;;
+    opts) compadd $(_ahccli_option_list $cmd $subcmd) ;;
+  esac
+}
+
+#
+# Register commands for autocompletion below:
+#
+# format:  compdef _ahccli <cmd>
+# example: compdef _ahccli phint
+#