dcarrillo/prezto
1
0
Fork 0
mirror of https://github.com/dcarrillo/prezto.git synced 2024-12-23 03:27:59 +00:00
Code Issues Releases Wiki Activity
d828d06643
prezto/modules/ruby/README.md

107 lines
3.1 KiB
Markdown
Raw Normal View History

general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
# Ruby
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
Configures [Ruby][1] local gem installation, loads version managers, and defines
aliases.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Local Gem Installation
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
When a Ruby version manager is not detected, local gems are installed in
ruby: Cleanup and optimize 'ruby' module Changes: - Honor `$RBENV_ROOT` or `RVM_DIR` if set but, no need to set it explicitly if not set. Instead, let the respective initialization scripts take care of that. - Reverse `rbenv` vs `rvm` selection order, preferring `rbenv` instead. - Check for availability of `rbenv` or `rvm` function instead of command to validate requirements. In a properly configured and initialized shell, `rbenv` or `rvm` will be available as function. - Adhere to more idiomatic Zsh operation and minimize redundant syntaxes. For additional rationale, see: https://github.com/rbenv/rbenv/wiki/Why-rbenv%3F
2021-05-17 06:24:03 +00:00
_`~/.gem`_; otherwise, they are installed according to the manager.
## rbenv
An alternative RVM is to use [_rbenv_][2], which allows for switching between
multiple, isolated Ruby installations in the home directory.
While it is not as feature rich as RVM, it is not loaded into the shell and is
not known to cause conflicts with shell scripts.
This will be loaded automatically if _rbenv_ is installed to `$RBENV_ROOT`,
_`~/.rbenv`_, or if the `rbenv` command is on the path.
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## rvm
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
ruby: Cleanup and optimize 'ruby' module Changes: - Honor `$RBENV_ROOT` or `RVM_DIR` if set but, no need to set it explicitly if not set. Instead, let the respective initialization scripts take care of that. - Reverse `rbenv` vs `rvm` selection order, preferring `rbenv` instead. - Check for availability of `rbenv` or `rvm` function instead of command to validate requirements. In a properly configured and initialized shell, `rbenv` or `rvm` will be available as function. - Adhere to more idiomatic Zsh operation and minimize redundant syntaxes. For additional rationale, see: https://github.com/rbenv/rbenv/wiki/Why-rbenv%3F
2021-05-17 06:24:03 +00:00
An alternative to the above is to use [The Ruby Version Manager (_rvm_)][3],
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
which allows for managing multiple, isolated Ruby installations and gem sets in
the home directory.
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
Since RVM is loaded into the shell and is known to override shell commands, it
may conflict with shell scripts.
Inform the user to load ruby as late as possible when using RVM
2014-02-18 04:39:08 +00:00
Load this module as late as possible when using RVM since RVM will complain if
it is not first in `$PATH`.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## chruby
[Fix #361] Load chruby when found
2014-02-02 04:37:29 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
Yet another alternative is [_chruby_][4], which is simpler than both _rvm_ and
_rbenv_.
[Fix #361] Load chruby when found
2014-02-02 04:37:29 +00:00
### Settings
#### Auto-Switch
To enable auto switching the Ruby version on directory change based on the
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
`.ruby-version` file, add the following line to _`${ZDOTDIR:-$HOME}/.zpreztorc`_:
[Fix #361] Load chruby when found
2014-02-02 04:37:29 +00:00
[general] Switch code block formatting to use fence formatting Changes: * Indented code block doesn't support syntax highlighting, use fenced formatting (```) instead for better syntax highlighting * Wrap commands/functions in backticks * Typo fixes
2017-07-21 01:07:29 +00:00
```sh
zstyle ':prezto:module:ruby:chruby' auto-switch 'yes'
```
[Fix #361] Load chruby when found
2014-02-02 04:37:29 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Bundler
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
Manage gems that are not meant to be used as commands, such as application
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
dependencies, with [Bundler][5].
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Aliases
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
Refactor Ruby aliases
2012-08-15 01:10:12 +00:00
### General
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- `rb` is short for `ruby`.
Refactor Ruby aliases
2012-08-15 01:10:12 +00:00
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
### Bundler
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- `rbb` manages ruby dependencies (`bundle`).
- `rbbc` cleans up unused gems in your bundler directory.
- `rbbe` executes a script in the context of the current bundle.
- `rbbi` installs the gems specified in the `Gemfile` in `vendor/bundle`.
- `rbbI` installs the following:
- gems specified in the `Gemfile` in `vendor/bundle`.
- packages the gems into `vendor/cache`.
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
- appends bundler directories to `.gitignore`.
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- `rbbl` lists all gems in the current bundle.
- `rbbo` opens an installed gem in the editor.
- `rbbp` packages gem files into `vendor/cache`.
- `rbbu` updates gems to their latest version.
## Functions
- `ruby-app-root` displays the path to the Ruby application root directory.
- `ruby-info` exposes information about the Ruby environment via the
`$ruby_info` associative array.
## Theming
[Fix #259] Add ruby-info function
2012-09-07 03:06:50 +00:00
To display the name of the current Ruby version in a prompt, define the
Fix the name of the theme setup function in READMEs
2012-10-02 16:53:59 +00:00
following style in the `prompt_name_setup` function.
[Fix #259] Add ruby-info function
2012-09-07 03:06:50 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
```sh
# %v - ruby version.
zstyle ':prezto:module:ruby:info:version' format 'version:%v'
```
[Fix #259] Add ruby-info function
2012-09-07 03:06:50 +00:00
Then add `$ruby_info[version]` to `$PROMPT` or `$RPROMPT` and call
Fix the name of the theme setup function in READMEs
2012-10-02 16:53:59 +00:00
`ruby-info` in the `prompt_name_preexec` hook function.
[Fix #259] Add ruby-info function
2012-09-07 03:06:50 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
## Authors
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
general: Update documentation better qualifying runcom paths Zsh and Prezto files don't always reside in `~/`. Instead, they have a more spec compliant location (`${ZDOTDIR:-$HOME}/`). Make them unambiguous in the documentation. Likewise, for `$GNUPGHOME`. Further, add instruction for optionally setting up Prezto in `$XDG_CONFIG_HOME`. While at this, also add clarification on relative ordering of some of the modules, apply more formatting tweaks and doc improvements.
2021-05-05 17:59:01 +00:00
_The authors of this module should be contacted via the [issue tracker][6]._
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
- [Sorin Ionescu](https://github.com/sorin-ionescu)
[Fix #115] Add documentation for ruby
2012-06-13 01:02:14 +00:00
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[1]: https://www.ruby-lang.org
ruby: Cleanup and optimize 'ruby' module Changes: - Honor `$RBENV_ROOT` or `RVM_DIR` if set but, no need to set it explicitly if not set. Instead, let the respective initialization scripts take care of that. - Reverse `rbenv` vs `rvm` selection order, preferring `rbenv` instead. - Check for availability of `rbenv` or `rvm` function instead of command to validate requirements. In a properly configured and initialized shell, `rbenv` or `rvm` will be available as function. - Adhere to more idiomatic Zsh operation and minimize redundant syntaxes. For additional rationale, see: https://github.com/rbenv/rbenv/wiki/Why-rbenv%3F
2021-05-17 06:24:03 +00:00
[2]: https://github.com/rbenv/rbenv
[3]: https://rvm.io
Use backticks rather than italics for paths This is more typical with what I observe elsewhere
2017-08-29 23:40:17 +00:00
[4]: https://github.com/postmodern/chruby
general: Reformat documentation with better formatting and wording General purpose reformating and rewording in (a few places). This should also make markdown linting happier. Prefer back-ticks wherever useful and use `console` for code blocks to be executed on terminal. Also, update references links wherever possible (including update from 'http://' to 'https://').
2021-05-04 01:59:31 +00:00
[5]: https://gembundler.com
[6]: https://github.com/sorin-ionescu/prezto/issues
Reference in New Issue Copy Permalink