jsvitolo / sublime-rails-snippets

Sublime Text snippets for the latest Ruby and Rails versions

Sublime Text Rails snippets

The repo aims to replace the default Rails snippets from Sublime Text and make it useful for the latest Ruby and Rails versions. All the snippets can be found in this cheatsheet generated by Snipcheat.

Installation

From Git

➜ cd ~/Library/Application\ Support/Sublime\ Text\ 2/Packages
➜ git clone https://github.com/tadast/sublime-rails-snippets.git Rails

It is important to clone it into a folder called Rails. Some Sublime plugins have hardcoded dependencies pointing to that path. See troubleshooting.

From Package Control

Look for "Ruby on Rails snippets". Here's how to install packages

Please Note: If you're a Sublime Text 3 user you'd need to tell your editor to use the Ruby on Rails syntax provided by Ruby on Rails Snippets. One can find this option in the editor by navigating their way via - View -> Syntax -> Open all with current extension as... -> Ruby on Rails Snippets -> Ruby on Rails

Housekeeping

⚠️ You will need to do some housekeeping after installing it from Package Control. First of all, remove the original Rails directory (see Backup). Then quit Sublime and delete Sublime's session cache.

rm ~/Library/Application\ Support/Sublime\ Text\ 2/Settings/Session.sublime_session

This will lose all session data (Sublime will 'forget' open filetabs, projects, search history etc.)

Troubleshooting

Can't find *.tmLanguage

If Sublime complains it can't find Ruby on Rails.tmLanguage, chances are you are using this hack.

You'll need to change the path where it looks for that file. Here's the forked version which works with this plugin.

You may also need to change Packages/(DetectSyntax|User)/DetectSyntax.sublime-settings to replace/include this rule

{
  "name": "Ruby on Rails snippets/Ruby Haml",
  "rules": [
    {"file_name": ".*\\.haml$"}
  ]
},
{
  "name": "Ruby on Rails snippets/Ruby on Rails",
  "rules": [
    {"function": {"name": "is_rails_file"}}
  ]
}

Ruby on Rails snippets is a default instalation directory for Package Control. If you installed in a different directory, change the path accordingly

Sublime picks Ruby syntax

You may need to tell Sublime to prefer Rails View -> Syntax -> Open all with current extension as... and pick Rails of Ruby on Rails snippets

How to contribute

1. Fork it
2. Create your feature branch for each group of snippet changes that could be merged individually (git checkout -b my-new-snippet)
3. Commit your changes (git commit -am 'Add some snippet [tab_trigger]')
4. Commit messages should start with a verb in present simple tense and have all affected tab triggers in square brackets e.g. "Add a snippets for partial rendering [rpc, rpo]"
5. Push to the branch (git push origin my-new-snippet)
6. Create new Pull Request