Project

extract_i18n

0.01
The project is in a healthy, maintained state
extract_i18npludoni/extract_i18nHomepageDocumentationSource CodeBug TrackerWiki
Extact i18n from Ruby files using Ruby parser and slim files using regex interactively
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
9,965
Stars
17
Forks
6
Watchers
5
 Releases
Current version
0.6.2
Total releases
8
First release
2020-10-06
Latest release
2024-01-29
 Issues
Open Issues
4
Closed Issues
0
Total Issues
4
Issue Closure Rate
0%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
4
Pull Request Acceptance Rate
80%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2021-10-03
Reverse Dependencies
0

 Dependencies

Runtime

diff-lcs
>= 0
diffy
>= 0
nokogiri
>= 0
parser
>= 2.6
slim
>= 0
tty-prompt
>= 0
zeitwerk
>= 0
 Project Readme

ExtractI18n

Gem Version

Read my blog post if you'd like more about the development of ExtractI18n.

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 (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. <Component /> will become <Component></Component>). 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.
  • ERB views

CURRENTLY THERE IS NO SUPPORT FOR:

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.

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.