https://github.com/pludoni/extract_i18n
Automatically extract I18n keys from Ruby, Slim files bootstrap your I18n conversion
https://github.com/pludoni/extract_i18n
i18n pug rails ruby slim
Last synced: 23 days ago
JSON representation
Automatically extract I18n keys from Ruby, Slim files bootstrap your I18n conversion
- Host: GitHub
- URL: https://github.com/pludoni/extract_i18n
- Owner: pludoni
- License: mit
- Created: 2020-10-06T10:16:51.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-21T15:21:12.000Z (5 months ago)
- Last Synced: 2025-09-04T23:36:50.394Z (about 1 month ago)
- Topics: i18n, pug, rails, ruby, slim
- Language: Ruby
- Homepage:
- Size: 222 KB
- Stars: 25
- Watchers: 4
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ExtractI18n
[](https://badge.fury.io/rb/extract_i18n)
[Read my blog post if you'd like more about the development of ExtractI18n](https://www.stefanwienert.de/blog/2020/07/26/internationalize-medium-rails-app-with-tooling/).
CLI helper program to automatically extract bare text strings into Rails I18n interactively.
Useful when adding i18n to a medium/large Rails app.
This Gem **supports** the following source files:
- Ruby files (controllers, models etc.) via Ruby-Parser, e.g. walking all Ruby Strings
- Slim Views (via Regexp parser by [SlimKeyfy](https://github.com/phrase/slimkeyfy) (MIT License))
- Vue templates
- will scan all texts and common string-attributes such as title, alt etc. for static strings and replace with vue-i18n's $t
- Caveats: because of limitations of the HTML/XML parser it will slightly transform the HTML, for example, self closing tags are expanded (e.g. ```` will become ````). Also multi-line arrangements of attributes, tags etc. might produce unexpected results, so make sure to use Git and diff the result.
- Vue Pug views
- Pug is very similar to slim and thus relatively well extractable via Regexp.
- Javascript string Literals by vendoring a small **nodeJS** script in ``js/find_string_tokens.js`` (requires node16+).
- Vue: Literal strings in script block (via bundled nodejs file)
- JS/TS: Literal strings
- ERB views
- by vendoring/extending https://github.com/ProGM/i18n-html_extractor (MIT License)
CURRENTLY THERE IS **NO SUPPORT** FOR:
- haml ( integrating https://github.com/shaiguitar/haml-i18n-extractor)
- JS: Template-Literals
But I am open to integrating PRs for those!
I strongly recommend using a Source-Code-Management (Git) and ``i18n-tasks`` for checking the key consistency.
I've created a scanner to make that work with vue $t structures too: https://gist.github.com/zealot128/e6ec1767a40a6c3d85d7f171f4d88293
## Installation
install:
$ gem install extract_i18n
## Usage
DO USE A SOURCE-CODE-MANAGEMENT-SYSTEM (Git). There is no guarantee that programm will not destroy your workspace :)
```
extract-i18n --help
extract-i18n --locale de --yaml config/locales/unsorted.de.yml app/views/user
```
If you prefer relative keys in slim views use ``--slim-relative``, e.g. ``t('.title')`` instead of ``t('users.index.title')``.
I prefer absolute keys, as it makes copy pasting/ moving files much safer.
To extract Vue/JS files, we usually put them in a namespace ``js.*`` and handle them with i18n-tasks as well, so to extract Vue-Components, or plain JS files:
```
extract-i18n --locale de --yaml config/locales/unsorted.de.yml -n js app/javascript/components/Foobar.vue
```
Will prefix the keys with ``js.components.foobar``. This system also switches the **interpolation format** from ``%{foo}`` to ``{foo}``, when handling Vue,JS,TS file.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/zealot128/extract_i18n.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).