diff options
| author | Thomas Kriechbaumer <kriechbaumer@gmail.com> | 2014-07-07 14:23:37 +0200 |
|---|---|---|
| committer | Thomas Kriechbaumer <kriechbaumer@gmail.com> | 2014-07-15 16:42:23 +0200 |
| commit | 34bc91e79d8cbb7b889402746770f1671d9b5872 (patch) | |
| tree | d342898a0642f7f759e560701f4a59f25931b34a /plugins/bundler | |
| parent | b007fee187bb111c13c0c95b39763b28dc3f8ca0 (diff) | |
| download | zsh-34bc91e79d8cbb7b889402746770f1671d9b5872.tar.gz zsh-34bc91e79d8cbb7b889402746770f1671d9b5872.tar.bz2 zsh-34bc91e79d8cbb7b889402746770f1671d9b5872.zip | |
added Bundler readme file
Diffstat (limited to 'plugins/bundler')
| -rw-r--r-- | plugins/bundler/README.md | 49 | ||||
| -rw-r--r-- | plugins/bundler/bundler.plugin.zsh | 2 |
2 files changed, 50 insertions, 1 deletions
diff --git a/plugins/bundler/README.md b/plugins/bundler/README.md new file mode 100644 index 000000000..56f0c7176 --- /dev/null +++ b/plugins/bundler/README.md @@ -0,0 +1,49 @@ +# Bundler + +- adds completion for basic bundler commands +- adds short aliases for common bundler commands + - `be` aliased to `bundle exec` + - `bl` aliased to `bundle list` + - `bp` aliased to `bundle package` + - `bo` aliased to `bundle open` + - `bu` aliased to `bundle update` + - `bi` aliased to `bundle install --jobs=<cpu core count>` (only for bundler `>= 1.4.0`) +- adds a wrapper for common gems: + - looks for a binstub under `./bin/` and executes it (if present) + - calls `bundle exec <gem executable>` otherwise + +For a full list of *common gems* being wrapped by default please look at the `bundler.plugin.zsh` file. + +## Configuration + +Please use the exact name of the executable and not the gem name. + +### Add additional gems to be wrapped + +Add this before the plugin-list in your `.zshrc`: +```sh +BUNDLED_COMMANDS=(rubocop) +plugins=(... bundler ...) +``` +This will add the wrapper for the `rubocop` gem (i.e. the executable). + + +### Exclude gems from being wrapped + +Add this before the plugin-list in your `.zshrc`: +```sh +UNBUNDLED_COMMANDS=(foreman spin) +plugins=(... bundler ...) +``` +This will exclude the `foreman` and `spin` gems (i.e. their executable) from being wrapped. + +## Excluded gems + +These gems should not be called with `bundle exec`. Please see the Issues on GitHub for clarification. + +`berks` +`foreman` +`mailcatcher` +`rails` +`ruby` +`spin` diff --git a/plugins/bundler/bundler.plugin.zsh b/plugins/bundler/bundler.plugin.zsh index 4f9eea922..9c920aa1f 100644 --- a/plugins/bundler/bundler.plugin.zsh +++ b/plugins/bundler/bundler.plugin.zsh @@ -100,6 +100,6 @@ for cmd in $bundled_commands; do alias $cmd=bundled_$cmd if which _$cmd > /dev/null 2>&1; then - compdef _$cmd bundled_$cmd=$cmd + compdef _$cmd bundled_$cmd=$cmd fi done |