Rails Helper for Visual Studio Code
Very similar to Vense's rails extension and Peng Lv's snippets but with my own twists and added snippets :)
I plan to modify, extend and add more to this over time as I learn more about Ruby and Rails.
Supported file extensions
- Ruby (.rb)
- Embedded Ruby (html.erb)
- Slim (html.slim)
tips
control/command + space loads the snippet suggestions if they aren't shown right away.$1 is where the snippet starts. $0 is where the snippet ends.- Press
tab to move onto the next part of a snippet.
--- Ruby ---
[do] statement
do
$0
end
[if] statement
if $1
$0
end
[else] statement
else
$0
end
[ifelse] statement
if $1
$2
else
$0
end
[if elsif] statement
if $1
$2
elsif $3
$0
end
[if elsif else] statement
if $1
$2
elsif
$3
else
$0
end
[first] statement
first(${quantity})
[find_by]
find_by(${1:key}: ${2:value})
[find_by_params] find_by_params
find_by(${1:id_name}: params[:${2:param}])
[where] where
where(${condition})
[increment] increment
increment(:${1:id})
[order] order
order(${1:column}: :${2:desc})
[limit] limit
limit(${quantity})
[def] function
def ${1:name}
$2
end
[map] map function
${1:array}.map { |${2:i}| $0}
[select] select function
${1:array}.select { |${2:i}| $0}
[inject] inject function
${1:array}.inject(${2:0}) { |{$3:acc}, ${4:i}| $0}
[all?] all?
${1:array}.all? {|${2:i}| $0}
[any?] any?
${1:array}.any? {|${2:i}| $0}
[begin] exception block
begin
$1
rescue => exception
$0
end
[begin ensure] exception block with ensure
begin
$1
rescue => exception
$2
ensure
$3
end
[begin else] exception block with else
begin
$1
rescue => exception
$2
else
$3
end
[begin else ensure] exception block with else and ensure
begin
$1
rescue => exception
$2
else
$3
ensure
$4
end
[class_initialize] create a class with empty initialize
class ${1:ClassName}
def initialize
$0
end
end
[cla1] Create a class and initialize 1 property
class ${1:ClassName}
def initialize(${2:first})
@${2:first} = ${2:first}
end
$0
end
[cla2] Create a class and initialize 2 properties
class ${1:ClassName}
def initialize(${2:first}, ${3:second})
@${2:first} = ${2:first}
@${3:second} = ${3:second}
end
$0
end
[cla3] Create a class and initialize 3 properties
class ${1:ClassName}
def initialize(${2:first}, ${3:second}, ${4:third})
@${2:first} = ${2:first}
@${3:second} = ${3:second}
@${4:third} = ${4:third}
end
$0
end
[clex] Create a class that extends another
class ${1:ClassName} < ${2:ParentClass}
$0
end
[class] class definition
class ${1:ClassName}
$0
end
[for] simple for loop
for ${1:value} in ${2:enumerable} do
$0
end
[each] forEach loop
${1:items}.each do |${2:item}|
$0
end
[loop] forever loop
loop do
$0
end
[while] while loop
while ${1:test}
$0
end
[until] until loop
until ${1:test}
$0
end
[module] create a module definition
module ${1:ModuleName}
$0
end
[unless] unless
unless ${1:test}
$0
end
[unless else] unless
unless ${1:test}
$2
else
$3
end
[rake] Create a rake task
namespace :{1} do
desc '$2',
task $3: :environment do
$4
end
end
--- Ruby on Rails / .rb ---
[only]
only: %i[${1:method}]
[except]
except: %i[${1:method}]
Rails Routing
[get] get route
get '/${1:route}', to: '${2:controller}#${3:method}'
[post] post route
post '/${1:route}', to: '${2:controller}#${3:method}'
[patch] patch route
patch '/${1:route}', to: '${2:controller}#${3:method}'
[put] put route
put '/${1:route}', to: '${2:controller}#${3:method}'
[delete] delete route
delete '/${1:route}', to: '${2:controller}#${3:method}'
[res] resources
resources :${res_name}
[resb] res_block
resources :${1:res_name} do
$2
end
[rescb] res_collection_block
resources :${1:res_name} do
collection do
$2
end
end
[resmember] res_member
resources :${1:res_name} do
member do
$2
end
end
[re] resources
resource :${res_name}
[reb] res_block
resource :${1:res_name} do
$2
end
[recb] res_collection_block
resource :${1:res_name} do
collection do
$2
end
end
[re member] res_member
resource :${1:res_name} do
member do
$2
end
end
[member] member block
member do
$1
end
[collection] collection block
collection do
$1
end
Redirect
[render] render path
render $0
[redirect_to] redirect_to
redirect_to ${1:path}
[redirect_to_msg] redirect_to with msg
redirect_to ${path}, notice: '${msg}'
Model
[has_one] has_one
has_one :$0
[dep] dependent
dependent: :${1:id}
[has_one_dep] has_one_dependent
has_one :${1:id}, dependent: :${2:type}
[has_many] has_many
has_many :$0
[has_many_through] has_many_through
has_many :${1:model1}, through: :${2:model2}
[has_many_dependent] has_many_dependent
has_many :${1:id}, dependent: :${2:type}
[belongs_to] belongs_to
belongs_to :
[belongs_to_cache] belongs_to_cache
belongs_to :${1:id}, cache: ${2:true}
[has_and_belongs_to_many] belongs_to_cache
has_and_belongs_to_many :${1:id}
Columns
[add_column] add_column
add_column :${1:table}, :${2:column}, :${3:type}
[add_reference] add_reference
add_reference :${1:table}, :${2:column}, foreign_key: true
t.[x] table column property
x = binary/boolean/date/datetime/decimal/float/integer/references/string/text/time/timestamp/timestamps
Params/Require
[params] params
params.require(:${1:id_name}).permit(:${2:variable})
[para1/2/3] parameters
params['$1']['$2']['$3']$0
[req] req
require '$1'$0
[reqq] alternative req
require(:$1)$0
[include] include
include($1)$0
[permit] permit
permit(${1:id});
Controller
class ${1:Name}Controller < ApplicationController
$2
end
[index] index method
def index
$1
end
[create] create method
def create
$0
end
[new] new method
def new
$0
end
[edit] edit method
def edit
$0
end
[show] show method
def show
$0
end
[update] update method
def update
$0
end
[destroy] destroy method
def destroy
$0
end
[crud] full crud
def index
end
def new
end
def create
end
def edit
end
def update
end
def show
end
def destroy
end
[before_action] before_action
before_action :${1:id}
--- html.erb / html.slim ---
[pre] template exec tag <% %>
<% $1 %>
[pe] template render tag <%= %>
<%= $1 %>
[preb] template exec tag block <%
<% $1 %>
$0
<% end %>
[peb] template render tag block <%=
<%= $1 %>
$0
<% end %>
[each] forEach loop
<% ${1:items}.each do |${2:item}| %>
$0
<% end %>
<%= form_for ${1:variable} do |${2:f}| %>
$0
<% end %>
[timezone] select time zone
<%= f.time_zone_select :${1:id_name} %>
[rangefield] range_field
<%= range_field (:${1:model_name}, :${2:id_name}, in: ${3:1..100}) %>
[selecttag] select_tag
<%= select_tag (:${1:id_name}, options_for_select(${2:options}))%>
[colorfield] color_field
<%= color_field :${$1:id_name} %>
[options_for_select] options_for_select
options_for_select([${1:options}])$0
[render] render
<%= render ${1:path} %>$0
[rendervar] render variable
<%= render ${1:path}, ${2:var1}: ${3:var2} %>
[lt] link_to
<%= link_to '${1:text}', ${2:path} %>
[ltc] link_to_class
<%= link_to '${1:text}', ${2:path}, class:'${3:class}' %>
[ltmd] link_to_method_data
<%= link_to '${1:link_text}', ${2:path}, method: '${3:method}', data:{ ${4:data} } %>
[ltmdc] link_to_method_data_class
<%= link_to '${1:link_text}', ${2:path}, method: '${3:method}', data:{ ${4:data} }, class:'${5:class}' %>
[ltmcon] link_to_method_confirm
<%= link_to \"${1:link_text}\", ${2:path}, method: \"${3:method}\", data:{ confirm: \"${4:confirm}\"} %>
[ltmconc] link_to_method_confirm_class
<%= link_to \"${1:link_text}\", ${2:path}, method: \"${3:method}\", data:{ confirm: \"${4:confirm}\"}, class:\"${5:class}\" %>
[submit] submit
<%= f.submit %>$0
[label] label
<%= f.label :${1:id_name}, '${2:text}' %>$0
[numberfield] number_field
<%= f.number_field (:${1:id_name}, in: ${2:1.0..20.0}, step: ${3:0.5}) %>$0
[timefield] time_field
<%= f.time_field :${1:id_name} %>
[hiddenfield] hidden_field
<%= f.hidden_field :${1:id_name} %>
[emailfield] email_field
<%= f.hidden_field :${1:id_name} %>
[urlfield] url_field
<%= f.url_field :${id_name} %>
[passwordfield] password_field
<%= f.password_field :${id_name} %>
[textarea] text_area
<%= f.text_area :${id_name} %>
[checkbox] check_box
<%= f.check_box :${id_name} %>
[textfield] text_field
<%= f.text_field :${id_name} %>
[datefield] date_field
<%= f.date_field :${id_name} %>
[datetime_field] datetime_field
<%= f.datetime_field :${1:id_name} %>
<%= f.radio_button :${1:name}, :value => '${2:value}' %>
<%= f.input :${1:id}, label: '${2:text}' %>
[path] path
${1:path}_path
[newpath] new_path
new_${1:path}_path
[editpath] edit_path
edit_${1:path}_path(${2:variable})
[if] if statement
<% if $1 %>
$2
<% end %>
[else] else
<% else %>
[elsif] elsif
<% elsif $1 %>$0
[ifelse] if else statement
<% if $1 %>
$2
<% else %>
$3
<% end %>
[if elsif]
<% if $1 %>
$2
<% elseif %>
$3
<% end %>
[if elsif else]
<% if $1 %>
$2
<% elseif %>
$3
<% else %>
$4
<% end %>
[unless] unless
<% unless ${1:falsevalue} %>
$2
<% end %>
[unless else] unless
<% unless ${1:falsevalue} %>
$2
<% else %>
$3
<% end %>
[%end] end
<% end %>
--- Other ---
[frozenstring]
# frozen_string_literal_true
[rbprettier] bundle exec rbprettier --write '**/*.rb'
- Add
gem 'prettier' to your gemfile
- Run
bundle in your terminal
- Optionally create a
.prettierrc file for configuration in the root of your project directory. here's a link to the repo for rb prettier
- Copy and paste this snippet into your terminal
bundle exec rbprettier --write '**/*.rb'
[gitbashssh] enter into gitbash to avoid re-entering your password on pushes
eval $(ssh-agent -s)
ssh-add ~/.ssh/id_rsa
- Copy and paste these two lines into your terminal
- Push to your repository without entering your password
License - MIT
