From e09aac3751ab1f489aed2dc7ef1d7a7a2fcecd5d Mon Sep 17 00:00:00 2001 From: Sandip Subedi Date: Sat, 3 Oct 2020 11:38:44 -0500 Subject: [PATCH] bundler: format aliases table and clean up README (#9300) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Marc Cornellà --- plugins/bundler/README.md | 75 +++++++++++++++++++++++---------------- 1 file changed, 44 insertions(+), 31 deletions(-) diff --git a/plugins/bundler/README.md b/plugins/bundler/README.md index a3bceb0ae..7b79cbcdc 100644 --- a/plugins/bundler/README.md +++ b/plugins/bundler/README.md @@ -1,34 +1,48 @@ # Bundler -- Adds completion for basic bundler commands +This plugin adds completion for basic bundler commands, as well as aliases and helper functions for +an easier experience with bundler. -- Adds short aliases for common bundler commands - - `ba` aliased to `bundle add` - - `be` aliased to `bundle exec`. - It also supports aliases (if `rs` is `rails server`, `be rs` will bundle-exec `rails server`). - - `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=` (only for bundler `>= 1.4.0`) - - `bcn` aliased to `bundle clean` - - `bck` aliased to `bundle check` +To use it, add `bundler` to the plugins array in your zshrc file: -- Adds a wrapper for common gems: - - Looks for a binstub under `./bin/` and executes it (if present) - - Calls `bundle exec ` otherwise +```zsh +plugins=(... bundler) +``` + +## Aliases + +| Alias | Command | Description | +|--------|--------------------------------------|------------------------------------------------------------------------------------------| +| `ba` | `bundle add` | Add gem to the Gemfile and run bundle install | +| `bck` | `bundle check` | Verifies if dependencies are satisfied by installed gems | +| `bcn` | `bundle clean` | Cleans up unused gems in your bundler directory | +| `be` | `bundle exec` | Execute a command in the context of the bundle | +| `bi` | `bundle install --jobs=` | Install the dependencies specified in your Gemfile (using all cores in bundler >= 1.4.0) | +| `bl` | `bundle list` | List all the gems in the bundle | +| `bo` | `bundle open` | Opens the source directory for a gem in your bundle | +| `bout` | `bundle outdated` | List installed gems with newer versions available | +| `bp` | `bundle package` | Package your needed .gem files into your application | +| `bu` | `bundle update` | Update your gems to the latest available versions | + +## Gem wrapper + +The plugin adds a wrapper for common gems, which: + +- Looks for a binstub under `./bin/` and executes it if present. +- Calls `bundle exec ` otherwise. Common gems wrapped by default (by name of the executable): + `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`. -## Configuration +### Settings -Please use the exact name of the executable and not the gem name. +You can add or remove gems from the list of wrapped commands. +Please **use the exact name of the executable** and not the gem name. -### Add additional gems to be wrapped +#### Include gems to be wrapped (`BUNDLED_COMMANDS`) -Add this before the plugin-list in your `.zshrc`: +Add this before the plugin list in your `.zshrc`: ```sh BUNDLED_COMMANDS=(rubocop) @@ -37,10 +51,9 @@ plugins=(... bundler ...) This will add the wrapper for the `rubocop` gem (i.e. the executable). +#### Exclude gems from being wrapped (`UNBUNDLED_COMMANDS`) -### Exclude gems from being wrapped - -Add this before the plugin-list in your `.zshrc`: +Add this before the plugin list in your `.zshrc`: ```sh UNBUNDLED_COMMANDS=(foreman spin) @@ -49,13 +62,13 @@ plugins=(... bundler ...) This will exclude the `foreman` and `spin` gems (i.e. their executable) from being wrapped. -## Excluded gems +### Excluded gems -These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/ohmyzsh/ohmyzsh/pull/2923) on GitHub for clarification. +These gems should not be called with `bundle exec`. Please see [issue #2923](https://github.com/ohmyzsh/ohmyzsh/pull/2923) on GitHub for clarification: -`berks` -`foreman` -`mailcatcher` -`rails` -`ruby` -`spin` +- `berks` +- `foreman` +- `mailcatcher` +- `rails` +- `ruby` +- `spin`