stow/oh-my-zsh/.oh-my-zsh/plugins/bundler/README.md

   1 # Bundler
   2
   3 This plugin adds completion for basic bundler commands, as well as aliases and helper functions for
   4 an easier experience with bundler.
   5
   6 To use it, add `bundler` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... bundler)
  10 ```
  11
  12 ## Aliases
  13
  14 | Alias  | Command                              | Description                                                                              |
  15 |--------|--------------------------------------|------------------------------------------------------------------------------------------|
  16 | `ba`   | `bundle add`                         | Add gem to the Gemfile and run bundle install                                            |
  17 | `bck`  | `bundle check`                       | Verifies if dependencies are satisfied by installed gems                                 |
  18 | `bcn`  | `bundle clean`                       | Cleans up unused gems in your bundler directory                                          |
  19 | `be`   | `bundle exec`                        | Execute a command in the context of the bundle                                           |
  20 | `bi`   | `bundle install --jobs=<core_count>` | Install the dependencies specified in your Gemfile (using all cores in bundler >= 1.4.0) |
  21 | `bl`   | `bundle list`                        | List all the gems in the bundle                                                          |
  22 | `bo`   | `bundle open`                        | Opens the source directory for a gem in your bundle                                      |
  23 | `bout` | `bundle outdated`                    | List installed gems with newer versions available                                        |
  24 | `bp`   | `bundle package`                     | Package your needed .gem files into your application                                     |
  25 | `bu`   | `bundle update`                      | Update your gems to the latest available versions                                        |
  26
  27 ## Gem wrapper
  28
  29 The plugin adds a wrapper for common gems, which:
  30
  31 - Looks for a binstub under `./bin/` and executes it if present.
  32 - Calls `bundle exec <gem>` otherwise.
  33
  34 Common gems wrapped by default (by name of the executable):
  35
  36 `annotate`, `cap`, `capify`, `cucumber`, `foodcritic`, `guard`, `hanami`, `irb`, `jekyll`, `kitchen`, `knife`, `middleman`, `nanoc`, `pry`, `puma`, `rackup`, `rainbows`, `rake`, `rspec`, `rubocop`, `shotgun`, `sidekiq`, `spec`, `spork`, `spring`, `strainer`, `tailor`, `taps`, `thin`, `thor`, `unicorn` and `unicorn_rails`.
  37
  38 ### Settings
  39
  40 You can add or remove gems from the list of wrapped commands.
  41 Please **use the exact name of the executable** and not the gem name.
  42
  43 #### Include gems to be wrapped (`BUNDLED_COMMANDS`)
  44
  45 Add this before the plugin list in your `.zshrc`:
  46
  47 ```sh
  48 BUNDLED_COMMANDS=(rubocop)
  49 plugins=(... bundler ...)
  50 ```
  51
  52 This will add the wrapper for the `rubocop` gem (i.e. the executable).
  53
  54 #### Exclude gems from being wrapped (`UNBUNDLED_COMMANDS`)
  55
  56 Add this before the plugin list in your `.zshrc`:
  57
  58 ```sh
  59 UNBUNDLED_COMMANDS=(foreman spin)
  60 plugins=(... bundler ...)
  61 ```
  62
  63 This will exclude the `foreman` and `spin` gems (i.e. their executable) from being wrapped.
  64
  65 ### Excluded gems
  66
  67 These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/ohmyzsh/ohmyzsh/pull/2923) on GitHub for clarification:
  68
  69 - `berks`
  70 - `foreman`
  71 - `mailcatcher`
  72 - `rails`
  73 - `ruby`
  74 - `spin`