ohmyzsh/plugins/bundler
Marc Cornellà 2991f237ae
bundler: allow aliases in `bundle exec`
This means that if you have, for example, `alias rs='rails server'`, you can
run `be rs` and have it expanded to `bundle exec rails server`.

Fixes #5818
2018-08-07 21:04:09 +02:00
..
README.md Add missing alias to README of bundler plugin 2016-01-29 13:04:53 +01:00
_bundler Add 'outdated' and 'platform' completions to bundler plugin 2014-07-15 16:42:23 +02:00
bundler.plugin.zsh bundler: allow aliases in `bundle exec` 2018-08-07 21:04:09 +02:00

README.md

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
    • bout aliased to bundle outdated
    • 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:

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:

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 issue #2923 on GitHub for clarification.

berks foreman mailcatcher rails ruby spin