airblade / vim-localorie

A Vim plugin for easy look-up of translations for Rails i18n YAML keys.

vim-localorie

Localorie is a Vim plugin which makes working with Rails i18n YAML locale files a little easier.

Look up translations

With your cursor on an i18n key in a Rails view or controller, call localorie#translate() to populate the quickfix or location list with all the translations of that key.

If there is only one key in a line, your cursor doesn't need to be on the key to look up its translations - it can be anywhere in the line.

For example, with your cursor somewhere on .title:

# app/views/projects/index.html.erb
<h1><%= t '.title' %></h1>

– calling localorie#translate() will show the translations for projects.index.title.

Supported

• Fully-qualified lookup in views
• Lazy lookup in views
• Fully-qualified lookup in controllers
• Lazy lookup in controllers
• Model.model_name.human
• Model.human_attribute_name
• YAML anchors, aliases, and merge keys

Unsupported (so far)

• :scope and :default options
• Localisation keys.

It would also be nice, in a locale file, to look up locations where a key is used.

Expand YAML key

In a locale file, :echo localorie#expand_key() to echo the fully qualified key of the current line. This is handy when you are in the depths of a locale file and have lost track of the current line's scope.

For example, with your cursor anywhere on the last line:

en:
  foo:
    bar:
      baz: hello

– calling localorie#expand_key() will echo en.foo.bar.baz.

Mappings

I recommend mapping the functions in your vimrc. For example:

nnoremap <silent> <leader>lt :call localorie#translate()<CR>
nnoremap <silent> <leader>le :echo localorie#expand_key()<CR>

Autocommands

Add this autocommand to your vimrc to always see the fully qualified key of the current line:

autocmd CursorMoved *.yml echo localorie#expand_key()

Configuration

By default vim-localorie uses the quickfix list but doesn't switch to the quickfix window. To use the location list and/or switch to the new window, put this in your vimrc:

let g:localorie = {
    \ 'quickfix':  0,
    \ 'switch':    1
    \ }

Installation

Install like any other vim plugin.

Pathogen

cd ~/.vim/bundle
git clone git://github.com/airblade/vim-localorie.git

Voom

Edit your plugin manifest (voom edit) and add:

airblade/vim-localorie

VimPlug

Place this in your .vimrc:

Plug 'airblade/vim-localorie'

Then run the following in Vim:

:source %
:PlugInstall

NeoBundle

Place this in your .vimrc:

NeoBundle 'airblade/vim-localorie'

Then run the following in Vim:

:source %
:NeoBundleInstall

No plugin manager

Copy vim-localorie's subdirectories into your vim configuration directory:

cd /tmp && git clone git://github.com/airblade/vim-localorie.git
cp -r vim-localorie/* ~/.vim/

See :help add-global-plugin.

Intellectual Property

Copyright 2016-2020 Andrew Stewart. Released under the MIT licence.