linux/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-19 21:41:07 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(rails): fix comments and docs

Browse source
This commit is contained in:
Marc Cornellà 2022-03-07 15:20:03 +01:00
parent 3075d0c0ab
commit 47d313c904
2 changed files with 16 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
plugins/rails/README.md
View file

@ -1,6 +1,7 @@
# Rails # Rails
This plugin adds completion for [Ruby On Rails Framework](https://rubyonrails.org/) and [Rake](https://ruby.github.io/rake/) commands, as well as some aliases for logs and environment variables. This plugin adds completion for [Ruby On Rails Framework](https://rubyonrails.org/) and
[Rake](https://ruby.github.io/rake/) commands, as well as some aliases for logs and environment variables.
To use it, add `rails` to the plugins array in your zshrc file: To use it, add `rails` to the plugins array in your zshrc file:
@ -67,7 +68,9 @@ plugins=(... rails)
These are global aliases. Use in combination with a command or just run them These are global aliases. Use in combination with a command or just run them
separately. For example: `REP rake db:migrate` will migrate the production db. separately. For example: `REP rake db:migrate` will migrate the production db.
### Legacy rake aliases ## Legacy
### Rake aliases
The following commands are run [using `rails` instead of `rake` since Rails v5][1], but are preserved under the The following commands are run [using `rails` instead of `rake` since Rails v5][1], but are preserved under the
prefix `rk` for backwards compatibility. prefix `rk` for backwards compatibility.
@ -93,7 +96,7 @@ prefix `rk` for backwards compatibility.
| `rksts` | `rake stats` | Print code statistics | | `rksts` | `rake stats` | Print code statistics |
| `rkt` | `rake test` | Run Rails tests | | `rkt` | `rake test` | Run Rails tests |
### Legacy stuff ### Other
| Alias | Command | | Alias | Command |
| ------- | ---------------------------------- | | ------- | ---------------------------------- |
@ -105,3 +108,5 @@ prefix `rk` for backwards compatibility.
| `sr` | `ruby script/runner` | | `sr` | `ruby script/runner` |
| `ssp` | `ruby script/spec` | | `ssp` | `ruby script/spec` |
| `sstat` | `thin --stats "/thin/stats" start` | | `sstat` | `thin --stats "/thin/stats" start` |
- `remote_console <server> <directory>`: runs `ruby script/console production` on a remote server.

12
plugins/rails/rails.plugin.zsh
View file

@ -1,3 +1,4 @@
# rails command wrapper
function _rails_command () { function _rails_command () {
if [ -e "bin/stubs/rails" ]; then if [ -e "bin/stubs/rails" ]; then
bin/stubs/rails $@ bin/stubs/rails $@
@ -12,28 +13,31 @@ function _rails_command () {
fi fi
} }
alias rails='_rails_command'
compdef _rails_command=rails
# rake command wrapper
function _rake_command () { function _rake_command () {
if [ -e "bin/stubs/rake" ]; then if [ -e "bin/stubs/rake" ]; then
bin/stubs/rake $@ bin/stubs/rake $@
elif [ -e "bin/rake" ]; then elif [ -e "bin/rake" ]; then
bin/rake $@ bin/rake $@
elif type bundle &> /dev/null && ([ -e "Gemfile" ] || [ -e "gems.rb" ]); then elif type bundle &> /dev/null && [[ -e "Gemfile" || -e "gems.rb" ]]; then
bundle exec rake $@ bundle exec rake $@
else else
command rake $@ command rake $@
fi fi
} }
alias rails='_rails_command'
compdef _rails_command=rails
alias rake='_rake_command' alias rake='_rake_command'
compdef _rake_command=rake compdef _rake_command=rake
# Log aliases
alias devlog='tail -f log/development.log' alias devlog='tail -f log/development.log'
alias prodlog='tail -f log/production.log' alias prodlog='tail -f log/production.log'
alias testlog='tail -f log/test.log' alias testlog='tail -f log/test.log'
# Environment settings
alias -g RED='RAILS_ENV=development' alias -g RED='RAILS_ENV=development'
alias -g REP='RAILS_ENV=production' alias -g REP='RAILS_ENV=production'
alias -g RET='RAILS_ENV=test' alias -g RET='RAILS_ENV=test'