https://github.com/sage/i18n_yaml_editor

I18n Yaml Editor makes it easy to translate your Rails I18N files and keep them up to date
https://github.com/sage/i18n_yaml_editor

Last synced: about 1 year ago
JSON representation

I18n Yaml Editor makes it easy to translate your Rails I18N files and keep them up to date

• Host: GitHub
• URL: https://github.com/sage/i18n_yaml_editor
• Owner: Sage
• License: mit
• Archived: true
• Created: 2015-09-30T18:32:38.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2020-11-26T16:00:55.000Z (over 5 years ago)
• Last Synced: 2025-04-26T06:53:40.355Z (over 1 year ago)
• Language: Ruby
• Homepage: https://github.com/Sage/i18n_yaml_editor
• Size: 253 KB
• Stars: 22
• Watchers: 122
• Forks: 9
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# I18n Yaml Editor

[![Build Status](https://travis-ci.org/Sage/i18n_yaml_editor.svg?branch=master)](https://travis-ci.org/Sage/i18n_yaml_editor)

[![Maintainability](https://api.codeclimate.com/v1/badges/f71fb2039dd7d50eb90d/maintainability)](https://codeclimate.com/github/Sage/i18n_yaml_editor/maintainability)

[![Test Coverage](https://api.codeclimate.com/v1/badges/f71fb2039dd7d50eb90d/test_coverage)](https://codeclimate.com/github/Sage/i18n_yaml_editor/test_coverage)

[![Documentation Status](http://inch-ci.org/github/Sage/i18n_yaml_editor.svg?branch=master)](http://inch-ci.org/github/Sage/i18n_yaml_editor)

[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Sage/i18n_yaml_editor/blob/master/LICENSE)

[![Gem Version](https://badge.fury.io/rb/i18n_yaml_editor.svg)](https://badge.fury.io/rb/i18n_yaml_editor)

I18n Yaml Editor is based on [IYE](https://github.com/firmafon/iye).

I18n Yaml Editor makes it easy to translate your Rails I18N files and keep them up to date.

It uses YAML files directly, so you don't need to keep 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

![I18n Yaml Editor](https://cloud.githubusercontent.com/assets/1446195/10295880/1f829dd6-6bc4-11e5-9a08-bb79d9864bdb.png)

## Prerequisites

You need to understand a few things about I18n Yaml Editor for it to make sense, mainly:

* I18n Yaml Editor does not create new keys - keys must exist for at least one locale in the YAML files

* I18n Yaml Editor does not create new locales - at least one key must exist for each locale in the YAML files

## Workflow

1. Install I18n Yaml Editor:

        $ gem install i18n_yaml_editor

2. The `i18n_yaml_editor` executable is now available, use it wherever you want.

        $ i18n_yaml_editor path/to/i18n/locales [port]

    At this point I18n Yaml Editor loads all translation keys for all locales, and creates any

    keys that might be missing for existing locales, the default port is 5050

3. Point browser at [http://localhost:5050](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.

5. Review your changes before committing files, e.g. by using `git diff`.

## Development

### Getting started

        $ git clone git@github.com:Sage/i18n_yaml_editor.git

        $ cd i18n_yaml_editor

        $ gem install bundler

        $ bundle install

        $ SIMPLE_COV=true bundle exec guard

## License

This gem is available as open source under the terms of the

[MIT licence](LICENSE).

Copyright (c) 2018 Sage Group Plc. All rights reserved.