Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 1.81 KB

README.md

File metadata and controls

55 lines (34 loc) · 1.81 KB

IYE

IYE - short for I18N YAML Editor - makes it easy to translate your Rails I18N files and keep them up to date. Unlike a lot of other tools in this space, IYE works directly on the YAML files instead of keeping a separate database in sync. This has several benefits:

  • Branching and diffing is trivial
  • It does not alter the workflow for developers etc., whom can continue editing the YAML files directly
  • If your YAML files are organized in subfolders, this structure is kept intact

IYE yaml editor

Prerequisites

You need to understand a few things about IYE for it to make sense, mainly:

  • IYE does not create new keys - keys must exist for at least one locale in the YAML files
  • IYE does not create new locales - at least one key must exist for each locale in the YAML files

Workflow

  1. Install IYE:

     $ gem install iye

  2. Navigate to the folder containing your YAML files and start IYE:

     $ iye . [-p 5050 -b 127.0.0.1]

    At this point IYE loads all translation keys for all locales, and creates any keys that might be missing for existing locales.

  3. Point browser at http://localhost:5050

  4. Make changes and press 'Save' - each time you do this, all the keys will be written to their original YAML files, which you can confirm e.g. by using git diff.

  5. Optionally you can change the port and binding address of the server by providing the -p and -b arguments

Development

The source ships with a config.ru suitable for development use with shotgun:

shotgun -p 5050

To run tests:

bundle install
bundle exec rake

Troubleshooting

Build status