Blame view

plugins/bundler/README.md 1.43 KB
093a6c34b   mj   Squashed 'repos/r...
1
2
3
4
5
6
7
8
  # 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`
46fe1183a   mj   Squashed 'repos/r...
9
    - `bout` aliased to `bundle outdated`
093a6c34b   mj   Squashed 'repos/r...
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
    - `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
238d8e65a   mj   Squashed 'repos/r...
42
  These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/robbyrussell/oh-my-zsh/pull/2923) on GitHub for clarification.
093a6c34b   mj   Squashed 'repos/r...
43
44
45
46
47
48
49
  
  `berks`
  `foreman`
  `mailcatcher`
  `rails`
  `ruby`
  `spin`