Merge pull request #33 from RODNOTGOD/master

Add new zsh completion and update README.md

Author: pimterry

README.md

@@ -29,23 +29,34 @@ curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes > /usr/local/bin/notes &
 
 By default your notes live in ~/notes, but you can change that to anywhere you like by setting the `$NOTES_DIRECTORY` environmental variable. See [how do I configure this?](#how-do-i-configure-this) for more details.
 
-#### Installing Bash completion
+#### Installing auto completion
 
-`notes` includes bash autocompletion, to let you tab-complete commands and your note names. This requires Bash > 4.0 and [bash-completion](https://github.com/scop/bash-completion) to be installed - it's probably available from your friendly local package manager.
+`notes` includes auto completion, to let you tab-complete commands and your note names. This requires Bash > 4.0 and [bash-completion](https://github.com/scop/bash-completion) or Zsh to be installed - it's probably available from your friendly local package manager.
 
-To enable completion for notes, copy the completion script into your bash completion directory, and it should be automatically loaded. The bash completion directory is `/usr/share/bash-completion/completions/` on a typical Debian install, or `/usr/local/etc/bash_completion.d/` on OSX with `bash-completion` from homebrew. You may be able to find your own bash completion directory by running the following command:
+To enable completion for notes, copy the completion script into your bash or zsh completion directory, and it should be automatically loaded. The bash completion directory is `/usr/share/bash-completion/completions/` on a typical Debian install, or `/usr/local/etc/bash_completion.d/` on OSX with `bash-completion` from homebrew. The zsh completion directory is `/usr/share/zsh/functions/Completion/` in Linux. You may be able to find your own bash completion directory by running the following command:
 
     pkg-config --variable=completionsdir bash-completion
 
 Installing the completions might be as follows:
 
+Bash
 ```bash
 curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes.bash_completion > /usr/share/bash-completion/completions/notes
 ```
 
+Zsh  
+On *buntu based distros
+```bash
+curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes._notes > /usr/local/share/site-functions/_notes
+```
+On other Unix distros the command should as follows
+```bash
+curl https://cdn.rawgit.com/pimterry/notes/v0.2.0/notes._notes > /usr/share/zsh/site-functions/_notes
+```
+
 You'll need to open a new shell for this to take effect.
 
-## How do I configure this?
+# How do I configure this?
 
 To get started with you'll want to set `$EDITOR` to your favourite text editor, and probably `$NOTES_DIRECTORY` to the directory in which you'd like to use to store your notes (this defaults to `~/notes`). You'll typically want to set these as environment variables in your `.bashrc`, `.zshrc`, or similar.
 
@@ -103,7 +114,6 @@ All the above works. Here's what's coming next:
 
 - [ ] More interesting and nicer looking file/grep search result formatting, perhaps only when not piping? (https://github.com/pimterry/notes/issues/27)
 - [ ] Make the file extension optional (https://github.com/pimterry/notes/issues/24)
-- [ ] zsh command and note name autocompletion (https://github.com/pimterry/notes/issues/25)
 - [ ] Interactive mode? `notes` could open a scrollable list of notes, open your editor when you pick one, and reappear after you close it. (https://github.com/pimterry/notes/issues/17)
 - [ ] Tree view (https://github.com/pimterry/notes/issues/26)
 - [ ] Easy way to see short notes snippets in find/grep/tree? Could be option (`--snippets`) or by piping to a command (`notes find | notes snippets`). Maybe call it `head`? (https://github.com/pimterry/notes/issues/22)

_notes

@@ -0,0 +1,52 @@
+#compdef notes
+# ------------------------------------------------------------------------------
+# Description
+# -----------
+#
+#  Simple delightful note taking, with more unix and less lock-in. (https://github.com/pimterry/notes)
+#
+# ------------------------------------------------------------------------------
+# Authors
+# -------
+#
+#  * pimterry et al.
+#
+# ------------------------------------------------------------------------------
+
+__notes_cmd ()
+{
+  local -a list
+  list=(
+    new:'Create new file'
+    ls:'<pattern> List notes by path'
+    find:'[pattern] Search notes by filename and path'
+    grep:'<pattern> Search notes by content'
+    search:'[pattern] Search notes by filename or content'
+    open:'<name> Open a notes for editing by full name'
+    rm:'[-r | --recursive] <name> Remove note, or folder if -r or --recursive is given]'
+    --help:'Show usage'
+  )
+  _describe -t sub-commands 'sub commands' list && _ret=0
+}
+
+_notes ()
+{
+  local configured_dir=${NOTES_DIRECTORY%/}
+  local note_dir="${configured_dir:-$HOME/notes}"
+
+  if (($CURRENT == 2)); then
+    _alternative 'sub-commands:files:__notes_cmd' && _ret=0
+  elif (($CURRENT == 3)); then
+    case $words[2] in
+      open|o|rm)
+        _path_files -W "${note_dir}" && _ret=0;;
+      new|n|ls)
+        _path_files -W "${note_dir}" -/ && _ret=0;;
+    esac
+  elif (($CURRENT >= 3)); then
+    case $words[2] in
+      rm)
+        _path_files -W "${note_dir}" && _ret=0;;
+    esac
+  fi
+}

test/test-open.bats

@@ -124,4 +124,4 @@ notes="./notes"
 
   assert_failure
   assert_output "Please set \$EDITOR to edit notes"
-}
+}