summaryrefslogtreecommitdiff
path: root/plugins/paver
diff options
context:
space:
mode:
authorMarc Cornellà <marc.cornella@live.com>2019-12-27 01:05:47 +0100
committerMarc Cornellà <marc.cornella@live.com>2019-12-27 01:05:47 +0100
commit4fd25920070f85bf358d297e79af1e85aac07f5a (patch)
treed3961d30ad57a9609230cc95c002de9f3770aa8c /plugins/paver
parente891fbff9e2e70acfbeff0734cd1fc012861e6ef (diff)
downloadzsh-4fd25920070f85bf358d297e79af1e85aac07f5a.tar.gz
zsh-4fd25920070f85bf358d297e79af1e85aac07f5a.tar.bz2
zsh-4fd25920070f85bf358d297e79af1e85aac07f5a.zip
paver: add README
Diffstat (limited to 'plugins/paver')
-rw-r--r--plugins/paver/README.md12
-rw-r--r--plugins/paver/paver.plugin.zsh6
2 files changed, 15 insertions, 3 deletions
diff --git a/plugins/paver/README.md b/plugins/paver/README.md
new file mode 100644
index 000000000..c38d898ba
--- /dev/null
+++ b/plugins/paver/README.md
@@ -0,0 +1,12 @@
+# Paver
+
+This plugin adds completion for the `paver` command-line tool of [Paver](https://pythonhosted.org/Paver/).
+
+To use it, add `paver` to the plugins array of your zshrc file:
+```zsh
+plugins=(... paver)
+```
+
+The completion function creates a cache of paver tasks with the name `.paver_tasks`,
+in the current working directory. It regenerates that cache when the `pavement.py`
+changes.
diff --git a/plugins/paver/paver.plugin.zsh b/plugins/paver/paver.plugin.zsh
index 40bdbd12f..7e70ea37c 100644
--- a/plugins/paver/paver.plugin.zsh
+++ b/plugins/paver/paver.plugin.zsh
@@ -1,7 +1,7 @@
_paver_does_target_list_need_generating () {
- [ ! -f .paver_targets ] && return 0;
- [ pavement.py -nt .paver_targets ] && return 0;
- return 1;
+ [ ! -f .paver_targets ] && return 0
+ [ pavement.py -nt .paver_targets ] && return 0
+ return 1
}
_paver () {