i18n-js 3.6.0 → 3.8.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/FUNDING.yml +3 -0
- data/.github/workflows/tests.yaml +100 -0
- data/CHANGELOG.md +48 -1
- data/README.md +454 -341
- data/app/assets/javascripts/i18n.js +24 -21
- data/i18n-js.gemspec +1 -1
- data/i18njs.png +0 -0
- data/lib/i18n/js.rb +13 -8
- data/lib/i18n/js/middleware.rb +1 -1
- data/lib/i18n/js/private/config_store.rb +31 -0
- data/lib/i18n/js/version.rb +1 -1
- data/package.json +1 -1
- data/spec/js/localization.spec.js +14 -0
- data/spec/js/numbers.spec.js +4 -0
- data/spec/js/translate.spec.js +13 -3
- data/spec/js/translations.js +27 -2
- data/spec/spec_helper.rb +1 -0
- data/yarn.lock +2 -2
- metadata +12 -9
- data/.travis.yml +0 -39
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 4eebc45e9890bdf47c3c7183b008b7383fcfb6415756ca7152bc7b20e5362989
|
4
|
+
data.tar.gz: f4228b2bd329a17f99abc3e2cb455ed846126fdecb31cb2cf89ab361ae383a36
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 0af9e0e46cbbbeccc196296198d67457c103185713a3df784cc5a8ccf1670a9852a9a0ba1a8ce1aa46f885569bedbc12d1f956270860e67990a05f8e514c5c7a
|
7
|
+
data.tar.gz: 6c974b2d308f08edaaf0e387000c3736fb87ece6f012563dd7d731cfd8919d3d850d0c123e5f646e59b911ab613c3e9b7e4fe8bff90d9266227f1871b5cba914
|
data/.github/FUNDING.yml
ADDED
@@ -0,0 +1,100 @@
|
|
1
|
+
name: Tests
|
2
|
+
|
3
|
+
on:
|
4
|
+
pull_request:
|
5
|
+
branches:
|
6
|
+
- main
|
7
|
+
paths-ignore:
|
8
|
+
- 'README.md'
|
9
|
+
push:
|
10
|
+
branches:
|
11
|
+
- main
|
12
|
+
paths-ignore:
|
13
|
+
- 'README.md'
|
14
|
+
|
15
|
+
jobs:
|
16
|
+
ruby_unit_tests:
|
17
|
+
name: Ruby Unit Tests
|
18
|
+
if: "contains(github.event.commits[0].message, '[ci skip]') == false"
|
19
|
+
strategy:
|
20
|
+
fail-fast: false
|
21
|
+
matrix:
|
22
|
+
os:
|
23
|
+
- ubuntu
|
24
|
+
ruby:
|
25
|
+
- 2.4
|
26
|
+
- 2.5
|
27
|
+
- 2.6
|
28
|
+
- 2.7
|
29
|
+
gemfile:
|
30
|
+
- gemfiles/i18n_0_6.gemfile
|
31
|
+
- gemfiles/i18n_0_7.gemfile
|
32
|
+
- gemfiles/i18n_0_8.gemfile
|
33
|
+
- gemfiles/i18n_0_9.gemfile
|
34
|
+
- gemfiles/i18n_1_0.gemfile
|
35
|
+
- gemfiles/i18n_1_1.gemfile
|
36
|
+
- gemfiles/i18n_1_2.gemfile
|
37
|
+
- gemfiles/i18n_1_3.gemfile
|
38
|
+
- gemfiles/i18n_1_4.gemfile
|
39
|
+
- gemfiles/i18n_1_5.gemfile
|
40
|
+
- gemfiles/i18n_1_6.gemfile
|
41
|
+
- gemfiles/i18n_1_7.gemfile
|
42
|
+
- gemfiles/i18n_1_8.gemfile
|
43
|
+
allow_failures:
|
44
|
+
- false
|
45
|
+
include:
|
46
|
+
- os: ubuntu
|
47
|
+
ruby: ruby-head
|
48
|
+
gemfile: gemfiles/i18n_1_8.gemfile
|
49
|
+
allow_failures: true
|
50
|
+
env:
|
51
|
+
BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
|
52
|
+
ALLOW_FAILURES: "${{ matrix.allow_failures }}"
|
53
|
+
runs-on: ${{ matrix.os }}-latest
|
54
|
+
continue-on-error: ${{ endsWith(matrix.ruby, 'head') || matrix.ruby == 'debug' }}
|
55
|
+
steps:
|
56
|
+
- name: Checkout
|
57
|
+
uses: actions/checkout@v2
|
58
|
+
- name: Setup Ruby
|
59
|
+
uses: ruby/setup-ruby@v1
|
60
|
+
with:
|
61
|
+
ruby-version: ${{ matrix.ruby }}
|
62
|
+
bundler-cache: true
|
63
|
+
- name: Test
|
64
|
+
run: bundle exec rake spec:ruby || $ALLOW_FAILURES
|
65
|
+
|
66
|
+
js_unit_tests:
|
67
|
+
name: JS Unit Tests
|
68
|
+
if: "contains(github.event.commits[0].message, '[ci skip]') == false"
|
69
|
+
strategy:
|
70
|
+
fail-fast: false
|
71
|
+
matrix:
|
72
|
+
os:
|
73
|
+
- ubuntu
|
74
|
+
node:
|
75
|
+
- 10
|
76
|
+
- 12
|
77
|
+
- 14
|
78
|
+
runs-on: ${{ matrix.os }}-latest
|
79
|
+
steps:
|
80
|
+
- name: Checkout
|
81
|
+
uses: actions/checkout@v2
|
82
|
+
- name: Setup node
|
83
|
+
uses: actions/setup-node@v1
|
84
|
+
with:
|
85
|
+
node-version: ${{ matrix.node }}
|
86
|
+
- name: Get yarn cache directory path
|
87
|
+
id: yarn-cache-dir-path
|
88
|
+
run: echo "::set-output name=dir::$(yarn cache dir)"
|
89
|
+
- uses: actions/cache@v2
|
90
|
+
id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
|
91
|
+
with:
|
92
|
+
path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
|
93
|
+
key: ${{ runner.os }}-yarn-${{ github.ref }}-${{ github.sha }}
|
94
|
+
restore-keys: |
|
95
|
+
${{ runner.os }}-yarn-${{ github.ref }}-
|
96
|
+
${{ runner.os }}-yarn-
|
97
|
+
- name: Install JS Dependencies
|
98
|
+
run: yarn install
|
99
|
+
- name: Test
|
100
|
+
run: npm test
|
data/CHANGELOG.md
CHANGED
@@ -18,6 +18,48 @@ This project adheres to [Semantic Versioning](http://semver.org/).
|
|
18
18
|
- Nothing
|
19
19
|
|
20
20
|
|
21
|
+
## [3.8.2] - 2021-03-18
|
22
|
+
|
23
|
+
### Fixed
|
24
|
+
|
25
|
+
- [Ruby] Stop using deprecated method
|
26
|
+
(PR: https://github.com/fnando/i18n-js/pull/598)
|
27
|
+
- [Ruby] Fix typo in error class reference
|
28
|
+
(Commit: https://github.com/fnando/i18n-js/commit/cc075ad0a36e940205d0a14390379d69013d188e)
|
29
|
+
|
30
|
+
|
31
|
+
## [3.8.1] - 2021-02-25
|
32
|
+
|
33
|
+
### Fixed
|
34
|
+
|
35
|
+
- [Ruby] Fix performance issue reading config
|
36
|
+
(PR: https://github.com/fnando/i18n-js/pull/593)
|
37
|
+
|
38
|
+
|
39
|
+
## [3.8.0] - 2020-10-15
|
40
|
+
|
41
|
+
### Added
|
42
|
+
|
43
|
+
- [JS] Add option `scope` for `toHumanSize()`
|
44
|
+
(PR: https://github.com/fnando/i18n-js/pull/583)
|
45
|
+
|
46
|
+
|
47
|
+
## [3.7.1] - 2020-06-30
|
48
|
+
|
49
|
+
### Fixed
|
50
|
+
|
51
|
+
- [JS] For translation missing behaviour `guess`, replace all underscores to spaces properly
|
52
|
+
(PR: https://github.com/fnando/i18n-js/pull/574)
|
53
|
+
|
54
|
+
|
55
|
+
## [3.7.0] - 2020-05-29
|
56
|
+
|
57
|
+
### Added
|
58
|
+
|
59
|
+
- [JS] Allow options to be passed in when calling `I18n.localize`/`I18n.l`
|
60
|
+
(PR: https://github.com/fnando/i18n-js/pull/570)
|
61
|
+
|
62
|
+
|
21
63
|
## [3.6.0] - 2020-02-14
|
22
64
|
|
23
65
|
### Added
|
@@ -449,7 +491,12 @@ And today is not April Fools' Day
|
|
449
491
|
|
450
492
|
|
451
493
|
|
452
|
-
[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.
|
494
|
+
[Unreleased]: https://github.com/fnando/i18n-js/compare/v3.8.2...HEAD
|
495
|
+
[3.8.2]: https://github.com/fnando/i18n-js/compare/v3.8.1...v3.8.2
|
496
|
+
[3.8.1]: https://github.com/fnando/i18n-js/compare/v3.8.0...v3.8.1
|
497
|
+
[3.8.0]: https://github.com/fnando/i18n-js/compare/v3.7.1...v3.8.0
|
498
|
+
[3.7.1]: https://github.com/fnando/i18n-js/compare/v3.7.0...v3.7.1
|
499
|
+
[3.7.0]: https://github.com/fnando/i18n-js/compare/v3.6.0...v3.7.0
|
453
500
|
[3.6.0]: https://github.com/fnando/i18n-js/compare/v3.5.1...v3.6.0
|
454
501
|
[3.5.1]: https://github.com/fnando/i18n-js/compare/v3.5.0...v3.5.1
|
455
502
|
[3.5.0]: https://github.com/fnando/i18n-js/compare/v3.4.2...v3.5.0
|
data/README.md
CHANGED
@@ -1,17 +1,22 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
1
|
+
<p align="center">
|
2
|
+
<img width="250" height="58" src="https://github.com/fnando/i18n-js/raw/main/i18njs.png" alt="i18n.js">
|
3
|
+
</p>
|
4
|
+
|
5
|
+
<p align="center">
|
6
|
+
It's a small library to provide the Rails I18n translations on the JavaScript.
|
7
|
+
</p>
|
8
|
+
|
9
|
+
<p align="center">
|
10
|
+
<a href="https://github.com/fnando/i18n-js/actions?query=workflow%3ATests"><img src="https://github.com/fnando/i18n-js/workflows/Tests/badge.svg" alt="Tests"></a>
|
11
|
+
<a href="http://badge.fury.io/rb/i18n-js"><img src="http://img.shields.io/gem/v/i18n-js.svg" alt="Gem Version"></a>
|
12
|
+
<a href="https://www.npmjs.com/package/i18n-js"><img src="https://img.shields.io/npm/v/i18n-js.svg" alt="npm"></a>
|
13
|
+
<a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License: MIT"></a>
|
14
|
+
<a href="https://travis-ci.org/fnando/i18n-js"><img src="http://img.shields.io/travis/fnando/i18n-js.svg" alt="Build Status"></a>
|
15
|
+
<a href="https://coveralls.io/r/fnando/i18n-js"><img src="http://img.shields.io/coveralls/fnando/i18n-js.svg" alt="Coverage Status"></a>
|
16
|
+
<a href="https://gitter.im/fnando/i18n-js"><img src="https://img.shields.io/badge/gitter-join%20chat-1dce73.svg" alt="Gitter"></a>
|
17
|
+
</p>
|
18
|
+
|
19
|
+
---
|
15
20
|
|
16
21
|
Features:
|
17
22
|
|
@@ -23,8 +28,9 @@ Features:
|
|
23
28
|
- Lots more! :)
|
24
29
|
|
25
30
|
## Version Notice
|
26
|
-
The `master` branch (including this README) is for latest `3.0.0` instead of `2.x`.
|
27
31
|
|
32
|
+
The `main` branch (including this README) is for latest `3.0.0` instead of
|
33
|
+
`2.x`.
|
28
34
|
|
29
35
|
## Usage
|
30
36
|
|
@@ -33,14 +39,31 @@ The `master` branch (including this README) is for latest `3.0.0` instead of `2.
|
|
33
39
|
#### Rails app
|
34
40
|
|
35
41
|
Add the gem to your Gemfile.
|
42
|
+
|
36
43
|
```ruby
|
37
44
|
gem "i18n-js"
|
38
45
|
```
|
39
46
|
|
47
|
+
#### Rails with [webpacker](https://github.com/rails/webpacker)
|
48
|
+
|
49
|
+
If you're using `webpacker`, you may need to add the dependencies to your client
|
50
|
+
with:
|
51
|
+
|
52
|
+
```
|
53
|
+
yarn add i18n-js
|
54
|
+
# or, if you're using npm,
|
55
|
+
npm install i18n-js
|
56
|
+
```
|
57
|
+
|
58
|
+
For more details, see:
|
59
|
+
- [this gist](https://gist.github.com/bazzel/ecdff4718962e57c2d5569cf01d332fe)
|
60
|
+
- https://github.com/fnando/i18n-js/issues/597
|
61
|
+
|
40
62
|
#### Rails app with [Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
|
41
63
|
|
42
|
-
If you're using the
|
43
|
-
then you
|
64
|
+
If you're using the
|
65
|
+
[asset pipeline](http://guides.rubyonrails.org/asset_pipeline.html), then you
|
66
|
+
must add the following line to your `app/assets/javascripts/application.js`.
|
44
67
|
|
45
68
|
```javascript
|
46
69
|
//
|
@@ -56,9 +79,9 @@ then you must add the following line to your `app/assets/javascripts/application
|
|
56
79
|
|
57
80
|
#### Rails app without [Asset Pipeline](http://guides.rubyonrails.org/asset_pipeline.html)
|
58
81
|
|
82
|
+
First, put this in your `application.html` (layout file). Then get the JS files
|
83
|
+
following the instructions below.
|
59
84
|
|
60
|
-
First, put this in your `application.html` (layout file).
|
61
|
-
Then get the JS files following the instructions below.
|
62
85
|
```erb
|
63
86
|
<%# This is just an example, you can put `i18n.js` and `translations.js` anywhere you like %>
|
64
87
|
<%# Unlike the Asset Pipeline example, you need to require both **in order** %>
|
@@ -66,55 +89,66 @@ Then get the JS files following the instructions below.
|
|
66
89
|
<%= javascript_include_tag "translations", skip_pipeline: true %>
|
67
90
|
```
|
68
91
|
|
69
|
-
**There are two ways to get `translations.js` (For Rails app without Asset
|
70
|
-
|
71
|
-
|
72
|
-
|
73
|
-
|
74
|
-
|
75
|
-
|
76
|
-
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
92
|
+
**There are two ways to get `translations.js` (For Rails app without Asset
|
93
|
+
Pipeline).**
|
94
|
+
|
95
|
+
1. This `translations.js` file can be automatically generated by the
|
96
|
+
`I18n::JS::Middleware`. Just add `config.middleware.use I18n::JS::Middleware`
|
97
|
+
to your `config/application.rb` file.
|
98
|
+
2. If you can't or prefer not to generate this file, you can move the middleware
|
99
|
+
line to your `config/environments/development.rb` file and run
|
100
|
+
`rake i18n:js:export` before deploying. This will export all translation
|
101
|
+
files, including the custom scopes you may have defined on
|
102
|
+
`config/i18n-js.yml`. If `I18n.available_locales` is set (e.g. in your Rails
|
103
|
+
`config/application.rb` file) then only the specified locales will be
|
104
|
+
exported. Current version of `i18n.js` will also be exported to avoid version
|
105
|
+
mismatching by downloading.
|
81
106
|
|
82
107
|
#### Export Configuration (For translations)
|
83
108
|
|
84
|
-
Exported translation files generated by `I18n::JS::Middleware` or
|
85
|
-
|
86
|
-
|
87
|
-
|
88
|
-
|
109
|
+
Exported translation files generated by `I18n::JS::Middleware` or
|
110
|
+
`rake i18n:js:export` can be customized with config file `config/i18n-js.yml`
|
111
|
+
(use `rails generate i18n:js:config` to create it). You can even get more files
|
112
|
+
generated to different folders and with different translations to best suit your
|
113
|
+
needs. The config file also affects developers using Asset Pipeline to require
|
114
|
+
translations. Except the option `file`, since all translations are required by
|
115
|
+
adding `//= require i18n/translations`.
|
89
116
|
|
90
117
|
Examples:
|
118
|
+
|
91
119
|
```yaml
|
92
120
|
translations:
|
93
|
-
- file:
|
94
|
-
|
95
|
-
- file:
|
96
|
-
|
121
|
+
- file: "public/javascripts/path-to-your-messages-file.js"
|
122
|
+
only: "*.date.formats"
|
123
|
+
- file: "public/javascripts/path-to-your-second-file.js"
|
124
|
+
only: ["*.activerecord", "*.admin.*.title"]
|
97
125
|
```
|
98
126
|
|
99
|
-
If `only` is omitted all the translations will be saved. Also, make sure you add
|
127
|
+
If `only` is omitted all the translations will be saved. Also, make sure you add
|
128
|
+
that initial `*`; it specifies that all languages will be exported. If you want
|
129
|
+
to export only one language, you can do something like this:
|
130
|
+
|
100
131
|
```yaml
|
101
132
|
translations:
|
102
|
-
- file:
|
103
|
-
|
104
|
-
- file:
|
105
|
-
|
133
|
+
- file: "public/javascripts/en.js"
|
134
|
+
only: "en.*"
|
135
|
+
- file: "public/javascripts/pt-BR.js"
|
136
|
+
only: "pt-BR.*"
|
106
137
|
```
|
107
138
|
|
108
|
-
Optionally, you can auto generate a translation file per available locale if you
|
139
|
+
Optionally, you can auto generate a translation file per available locale if you
|
140
|
+
specify the `%{locale}` placeholder.
|
141
|
+
|
109
142
|
```yaml
|
110
143
|
translations:
|
111
|
-
- file: "public/javascripts/i18n/%{locale}.js"
|
112
|
-
|
113
|
-
- file: "public/javascripts/frontend/i18n/%{locale}.js"
|
114
|
-
|
144
|
+
- file: "public/javascripts/i18n/%{locale}.js"
|
145
|
+
only: "*"
|
146
|
+
- file: "public/javascripts/frontend/i18n/%{locale}.js"
|
147
|
+
only: ["*.frontend", "*.users.*"]
|
115
148
|
```
|
116
149
|
|
117
150
|
You can also include ERB in your config file.
|
151
|
+
|
118
152
|
```yaml
|
119
153
|
translations:
|
120
154
|
<% Widgets.each do |widget| %>
|
@@ -123,39 +157,37 @@ translations:
|
|
123
157
|
<% end %>
|
124
158
|
```
|
125
159
|
|
126
|
-
You are able to exclude certain phrases or whole groups of phrases by
|
127
|
-
|
128
|
-
|
129
|
-
|
160
|
+
You are able to exclude certain phrases or whole groups of phrases by specifying
|
161
|
+
the YAML key(s) in the `except` configuration option. The outputted JS
|
162
|
+
translations file (exported or generated by the middleware) will omit any keys
|
163
|
+
listed in `except` configuration param:
|
130
164
|
|
131
165
|
```yaml
|
132
166
|
translations:
|
133
|
-
- except: [
|
167
|
+
- except: ["*.active_admin", "*.ransack", "*.activerecord.errors"]
|
134
168
|
```
|
135
169
|
|
136
|
-
|
137
170
|
#### Export Configuration (For other things)
|
138
171
|
|
139
|
-
- `I18n::JS.config_file_path`
|
140
|
-
|
141
|
-
Default: `config/i18n-js.yml`
|
142
|
-
Behaviour: Try to read the config file from that location
|
172
|
+
- `I18n::JS.config_file_path` Expected Type: `String` Default:
|
173
|
+
`config/i18n-js.yml` Behaviour: Try to read the config file from that location
|
143
174
|
|
144
|
-
- `I18n::JS.export_i18n_js_dir_path`
|
145
|
-
|
146
|
-
|
147
|
-
|
148
|
-
|
175
|
+
- `I18n::JS.export_i18n_js_dir_path` Expected Type: `String` Default:
|
176
|
+
`public/javascripts` Behaviour:
|
177
|
+
|
178
|
+
- Any `String`: considered as a relative path for a folder to `Rails.root` and
|
179
|
+
export `i18n.js` to that folder for `rake i18n:js:export`
|
149
180
|
- Any non-`String` (`nil`, `false`, `:none`, etc): Disable `i18n.js` exporting
|
150
181
|
|
151
|
-
- `I18n::JS.sort_translation_keys`
|
152
|
-
Expected Type: `Boolean`
|
153
|
-
Default: `true`
|
182
|
+
- `I18n::JS.sort_translation_keys` Expected Type: `Boolean` Default: `true`
|
154
183
|
Behaviour:
|
155
|
-
|
184
|
+
|
185
|
+
- Sets whether or not to deep sort all translation keys in order to generate
|
186
|
+
identical output for the same translations
|
156
187
|
- Set to true to ensure identical asset fingerprints for the asset pipeline
|
157
188
|
|
158
|
-
- You may also set `export_i18n_js` and `sort_translation_keys` in your config
|
189
|
+
- You may also set `export_i18n_js` and `sort_translation_keys` in your config
|
190
|
+
file, e.g.:
|
159
191
|
|
160
192
|
```yaml
|
161
193
|
export_i18n_js: false
|
@@ -168,21 +200,24 @@ translations:
|
|
168
200
|
- ...
|
169
201
|
```
|
170
202
|
|
171
|
-
To find more examples on how to use the configuration file please refer to the
|
203
|
+
To find more examples on how to use the configuration file please refer to the
|
204
|
+
tests.
|
172
205
|
|
173
206
|
#### Fallbacks
|
174
207
|
|
175
|
-
If you specify the `fallbacks` option, you will be able to fill missing
|
176
|
-
Default value is `true`.
|
208
|
+
If you specify the `fallbacks` option, you will be able to fill missing
|
209
|
+
translations with those inside fallback locale(s). Default value is `true`.
|
177
210
|
|
178
211
|
Examples:
|
212
|
+
|
179
213
|
```yaml
|
180
214
|
fallbacks: true
|
181
215
|
|
182
216
|
translations:
|
183
|
-
- file: "public/javascripts/i18n/%{locale}.js"
|
184
|
-
|
217
|
+
- file: "public/javascripts/i18n/%{locale}.js"
|
218
|
+
only: "*"
|
185
219
|
```
|
220
|
+
|
186
221
|
This will enable merging fallbacks into each file. (set to `false` to disable).
|
187
222
|
If you use `I18n` with fallbacks, the fallbacks defined there will be used.
|
188
223
|
Otherwise `I18n.default_locale` will be used.
|
@@ -191,9 +226,10 @@ Otherwise `I18n.default_locale` will be used.
|
|
191
226
|
fallbacks: :de
|
192
227
|
|
193
228
|
translations:
|
194
|
-
- file: "public/javascripts/i18n/%{locale}.js"
|
195
|
-
|
229
|
+
- file: "public/javascripts/i18n/%{locale}.js"
|
230
|
+
only: "*"
|
196
231
|
```
|
232
|
+
|
197
233
|
Here, the specified locale `:de` will be used as fallback for all locales.
|
198
234
|
|
199
235
|
```yaml
|
@@ -202,42 +238,49 @@ fallbacks:
|
|
202
238
|
de: "en"
|
203
239
|
|
204
240
|
translations:
|
205
|
-
- file: "public/javascripts/i18n/%{locale}.js"
|
206
|
-
|
241
|
+
- file: "public/javascripts/i18n/%{locale}.js"
|
242
|
+
only: "*"
|
207
243
|
```
|
208
|
-
|
244
|
+
|
245
|
+
Fallbacks defined will be used, if not defined (e.g. `:pl`) `I18n.fallbacks` or
|
246
|
+
`I18n.default_locale` will be used.
|
209
247
|
|
210
248
|
```yaml
|
211
249
|
fallbacks: :default_locale
|
212
250
|
|
213
251
|
translations:
|
214
|
-
- file: "public/javascripts/i18n/%{locale}.js"
|
215
|
-
|
252
|
+
- file: "public/javascripts/i18n/%{locale}.js"
|
253
|
+
only: "*"
|
216
254
|
```
|
217
|
-
|
255
|
+
|
256
|
+
Setting the option to `:default_locale` will enforce the fallback to use the
|
257
|
+
`I18n.default_locale`, ignoring `I18n.fallbacks`.
|
218
258
|
|
219
259
|
Examples:
|
260
|
+
|
220
261
|
```yaml
|
221
262
|
fallbacks: false
|
222
263
|
|
223
264
|
translations:
|
224
|
-
- file: "public/javascripts/i18n/%{locale}.js"
|
225
|
-
|
265
|
+
- file: "public/javascripts/i18n/%{locale}.js"
|
266
|
+
only: "*"
|
226
267
|
```
|
227
|
-
You must disable this feature by setting the option to `false`.
|
228
268
|
|
229
|
-
|
269
|
+
You must disable this feature by setting the option to `false`.
|
230
270
|
|
271
|
+
To find more examples on how to use the configuration file please refer to the
|
272
|
+
tests.
|
231
273
|
|
232
274
|
#### Namespace
|
233
275
|
|
234
|
-
Setting the `namespace` option will change the namespace of the output
|
235
|
-
This can be useful in
|
276
|
+
Setting the `namespace` option will change the namespace of the output
|
277
|
+
Javascript file to something other than `I18n`. This can be useful in
|
278
|
+
no-conflict scenarios. Example:
|
236
279
|
|
237
280
|
```yaml
|
238
281
|
translations:
|
239
|
-
- file: "public/javascripts/i18n/translations.js"
|
240
|
-
|
282
|
+
- file: "public/javascripts/i18n/translations.js"
|
283
|
+
namespace: "MyNamespace"
|
241
284
|
```
|
242
285
|
|
243
286
|
will create:
|
@@ -247,19 +290,20 @@ MyNamespace.translations || (MyNamespace.translations = {});
|
|
247
290
|
MyNamespace.translations["en"] = { ... }
|
248
291
|
```
|
249
292
|
|
250
|
-
|
251
293
|
### Adding prefix & suffix to the translations file(s)
|
252
294
|
|
253
|
-
Setting the `prefix: "import I18n from 'i18n-js';\n"` option will add the line
|
254
|
-
|
255
|
-
|
295
|
+
Setting the `prefix: "import I18n from 'i18n-js';\n"` option will add the line
|
296
|
+
at the beginning of the resultant translation file. This can be useful to use
|
297
|
+
this gem with the [i18n-js](https://www.npmjs.com/package/i18n-js) npm package,
|
298
|
+
which is quite useful to use it with webpack. The user should provide the
|
299
|
+
semi-colon and the newline character if needed.
|
256
300
|
|
257
301
|
For example:
|
258
302
|
|
259
303
|
```yaml
|
260
304
|
translations:
|
261
|
-
- file: "public/javascripts/i18n/translations.js"
|
262
|
-
|
305
|
+
- file: "public/javascripts/i18n/translations.js"
|
306
|
+
prefix: "import I18n from 'i18n-js';\n"
|
263
307
|
```
|
264
308
|
|
265
309
|
will create:
|
@@ -269,47 +313,44 @@ import I18n from 'i18n-js';
|
|
269
313
|
I18n.translations || (I18n.translations = {});
|
270
314
|
```
|
271
315
|
|
272
|
-
|
273
316
|
`suffix` option is added in https://github.com/fnando/i18n-js/pull/561.
|
274
317
|
It's similar to `prefix` so won't explain it in details.
|
275
318
|
|
276
|
-
|
277
319
|
#### Pretty Print
|
278
320
|
|
279
|
-
Set the `pretty_print` option if you would like whitespace and indentation in
|
321
|
+
Set the `pretty_print` option if you would like whitespace and indentation in
|
322
|
+
your output file (default: false)
|
280
323
|
|
281
324
|
```yaml
|
282
325
|
translations:
|
283
|
-
- file: "public/javascripts/i18n/translations.js"
|
284
|
-
|
326
|
+
- file: "public/javascripts/i18n/translations.js"
|
327
|
+
pretty_print: true
|
285
328
|
```
|
286
329
|
|
287
|
-
|
288
330
|
#### Javascript Deep Merge (:js_extend option)
|
289
331
|
|
290
|
-
By default, the output file Javascript will call the `I18n.extend` method to
|
291
|
-
files are deep-merged with any locale data
|
292
|
-
|
332
|
+
By default, the output file Javascript will call the `I18n.extend` method to
|
333
|
+
ensure that newly loaded locale files are deep-merged with any locale data
|
334
|
+
already in memory. To disable this either globally or per-file, set the
|
335
|
+
`js_extend` option to false
|
293
336
|
|
294
337
|
```yaml
|
295
|
-
js_extend: false
|
338
|
+
js_extend: false # this will disable Javascript I18n.extend globally
|
296
339
|
translations:
|
297
|
-
- file: "public/javascripts/i18n/translations.js"
|
298
|
-
|
340
|
+
- file: "public/javascripts/i18n/translations.js"
|
341
|
+
js_extend: false # this will disable Javascript I18n.extend for this file
|
299
342
|
```
|
300
343
|
|
301
|
-
|
302
344
|
#### Vanilla JavaScript
|
303
345
|
|
304
|
-
Just add the `i18n.js` file to your page. You'll have to build the translations
|
305
|
-
by hand or using your favorite programming language. More info below.
|
306
|
-
|
346
|
+
Just add the `i18n.js` file to your page. You'll have to build the translations
|
347
|
+
object by hand or using your favorite programming language. More info below.
|
307
348
|
|
308
349
|
#### Via NPM with webpack and CommonJS
|
309
350
|
|
351
|
+
Add the following line to your package.json dependencies where version is the
|
352
|
+
version you want:
|
310
353
|
|
311
|
-
Add the following line to your package.json dependencies
|
312
|
-
where version is the version you want
|
313
354
|
```javascript
|
314
355
|
"i18n-js": "{version_constraint}"
|
315
356
|
|
@@ -317,17 +358,21 @@ where version is the version you want
|
|
317
358
|
// npm install requires it to be the gzipped tarball, see [npm install](https://www.npmjs.org/doc/cli/npm-install.html)
|
318
359
|
"i18n-js": "https://github.com/fnando/i18n-js/archive/{tag_name_or_branch_name_or_commit_sha}.tar.gz"
|
319
360
|
```
|
361
|
+
|
320
362
|
Run npm install then use via
|
363
|
+
|
321
364
|
```javascript
|
322
365
|
var i18n = require("i18n-js");
|
323
366
|
```
|
324
367
|
|
325
|
-
|
326
368
|
### Setting up
|
327
369
|
|
328
|
-
You **don't** need to set up a thing. The default settings will work just okay.
|
370
|
+
You **don't** need to set up a thing. The default settings will work just okay.
|
371
|
+
But if you want to split translations into several files or specify contexts,
|
372
|
+
you can follow the rest of this setting up section.
|
329
373
|
|
330
374
|
Set your locale is easy as
|
375
|
+
|
331
376
|
```javascript
|
332
377
|
I18n.defaultLocale = "pt-BR";
|
333
378
|
I18n.locale = "pt-BR";
|
@@ -335,9 +380,11 @@ I18n.currentLocale();
|
|
335
380
|
// pt-BR
|
336
381
|
```
|
337
382
|
|
338
|
-
**NOTE:** You can now apply your configuration **before I18n** is loaded like
|
383
|
+
**NOTE:** You can now apply your configuration **before I18n** is loaded like
|
384
|
+
this:
|
385
|
+
|
339
386
|
```javascript
|
340
|
-
I18n = {} // You must define this object in top namespace, which should be `window`
|
387
|
+
I18n = {}; // You must define this object in top namespace, which should be `window`
|
341
388
|
I18n.defaultLocale = "pt-BR";
|
342
389
|
I18n.locale = "pt-BR";
|
343
390
|
|
@@ -347,7 +394,8 @@ I18n.currentLocale();
|
|
347
394
|
// pt-BR
|
348
395
|
```
|
349
396
|
|
350
|
-
In practice, you'll have something like the following in your
|
397
|
+
In practice, you'll have something like the following in your
|
398
|
+
`application.html.erb`:
|
351
399
|
|
352
400
|
```erb
|
353
401
|
<script type="text/javascript">
|
@@ -361,7 +409,7 @@ You can use translate your messages:
|
|
361
409
|
```javascript
|
362
410
|
I18n.t("some.scoped.translation");
|
363
411
|
// or translate with explicit setting of locale
|
364
|
-
I18n.t("some.scoped.translation", {locale: "fr"});
|
412
|
+
I18n.t("some.scoped.translation", { locale: "fr" });
|
365
413
|
```
|
366
414
|
|
367
415
|
You can also interpolate values:
|
@@ -369,36 +417,38 @@ You can also interpolate values:
|
|
369
417
|
```javascript
|
370
418
|
// You need the `translations` object setup first
|
371
419
|
I18n.translations["en"] = {
|
372
|
-
greeting: "Hello %{name}"
|
373
|
-
}
|
420
|
+
greeting: "Hello %{name}",
|
421
|
+
};
|
374
422
|
|
375
|
-
I18n.t("greeting", {name: "John Doe"});
|
423
|
+
I18n.t("greeting", { name: "John Doe" });
|
376
424
|
```
|
425
|
+
|
377
426
|
You can set default values for missing scopes:
|
427
|
+
|
378
428
|
```javascript
|
379
429
|
// simple translation
|
380
|
-
I18n.t("some.missing.scope", {defaultValue: "A default message"});
|
430
|
+
I18n.t("some.missing.scope", { defaultValue: "A default message" });
|
381
431
|
|
382
432
|
// with interpolation
|
383
|
-
I18n.t("noun", {defaultValue: "I'm a {{noun}}", noun: "Mac"});
|
433
|
+
I18n.t("noun", { defaultValue: "I'm a {{noun}}", noun: "Mac" });
|
384
434
|
```
|
385
435
|
|
386
436
|
You can also provide a list of default fallbacks for missing scopes:
|
387
437
|
|
388
438
|
```javascript
|
389
439
|
// As a scope
|
390
|
-
I18n.t("some.missing.scope", {defaults: [{scope: "some.existing.scope"}]});
|
440
|
+
I18n.t("some.missing.scope", { defaults: [{ scope: "some.existing.scope" }] });
|
391
441
|
|
392
442
|
// As a simple translation
|
393
|
-
I18n.t("some.missing.scope", {defaults: [{message: "Some message"}]});
|
443
|
+
I18n.t("some.missing.scope", { defaults: [{ message: "Some message" }] });
|
394
444
|
```
|
395
445
|
|
396
|
-
Default values must be provided as an array of
|
397
|
-
|
398
|
-
|
446
|
+
Default values must be provided as an array of hashes where the key is the type
|
447
|
+
of translation desired, a `scope` or a `message`. The translation returned will
|
448
|
+
be either the first scope recognized, or the first message defined.
|
399
449
|
|
400
|
-
The translation will fallback to the `defaultValue` translation if no scope
|
401
|
-
|
450
|
+
The translation will fallback to the `defaultValue` translation if no scope in
|
451
|
+
`defaults` matches and if no default of type `message` is found.
|
402
452
|
|
403
453
|
Translation fallback can be enabled by enabling the `I18n.fallbacks` option:
|
404
454
|
|
@@ -408,9 +458,9 @@ Translation fallback can be enabled by enabling the `I18n.fallbacks` option:
|
|
408
458
|
</script>
|
409
459
|
```
|
410
460
|
|
411
|
-
By default missing translations will first be looked for in less
|
412
|
-
|
413
|
-
|
461
|
+
By default missing translations will first be looked for in less specific
|
462
|
+
versions of the requested locale and if that fails by taking them from your
|
463
|
+
`I18n.defaultLocale`.
|
414
464
|
|
415
465
|
```javascript
|
416
466
|
// if I18n.defaultLocale = "en" and translation doesn't exist
|
@@ -419,24 +469,26 @@ them from your `I18n.defaultLocale`.
|
|
419
469
|
I18n.t("some.missing.scope");
|
420
470
|
```
|
421
471
|
|
422
|
-
Custom fallback rules can also be specified for a particular language. There
|
423
|
-
|
472
|
+
Custom fallback rules can also be specified for a particular language. There are
|
473
|
+
three different ways of doing it so:
|
424
474
|
|
425
475
|
```javascript
|
426
476
|
I18n.locales.no = ["nb", "en"];
|
427
477
|
I18n.locales.no = "nb";
|
428
|
-
I18n.locales.no = function(locale){
|
478
|
+
I18n.locales.no = function (locale) {
|
479
|
+
return ["nb"];
|
480
|
+
};
|
429
481
|
```
|
430
482
|
|
431
483
|
By default a missing translation will be displayed as
|
432
484
|
|
433
485
|
[missing "name of scope" translation]
|
434
486
|
|
435
|
-
While you are developing or if you do not want to provide a translation
|
436
|
-
|
487
|
+
While you are developing or if you do not want to provide a translation in the
|
488
|
+
default language you can set
|
437
489
|
|
438
490
|
```javascript
|
439
|
-
I18n.missingBehaviour=
|
491
|
+
I18n.missingBehaviour = "guess";
|
440
492
|
```
|
441
493
|
|
442
494
|
this will take the last section of your scope and guess the intended value.
|
@@ -446,28 +498,34 @@ Camel case becomes lower cased text and underscores are replaced with space
|
|
446
498
|
|
447
499
|
becomes "what is your favorite Christmas present"
|
448
500
|
|
449
|
-
In order to still detect untranslated strings, you can
|
450
|
-
i18n.missingTranslationPrefix to something like:
|
501
|
+
In order to still detect untranslated strings, you can set
|
502
|
+
`i18n.missingTranslationPrefix` to something like:
|
503
|
+
|
451
504
|
```javascript
|
452
|
-
I18n.missingTranslationPrefix =
|
505
|
+
I18n.missingTranslationPrefix = "EE: ";
|
453
506
|
```
|
454
507
|
|
455
508
|
And result will be:
|
509
|
+
|
456
510
|
```javascript
|
457
|
-
"EE: what is your favorite Christmas present"
|
511
|
+
"EE: what is your favorite Christmas present";
|
512
|
+
|
458
513
|
```
|
459
514
|
|
460
515
|
This will help you doing automated tests against your localisation assets.
|
461
516
|
|
462
517
|
Some people prefer returning `null` for missing translation:
|
518
|
+
|
463
519
|
```javascript
|
464
|
-
I18n.missingTranslation = function () {
|
520
|
+
I18n.missingTranslation = function () {
|
521
|
+
return undefined;
|
522
|
+
};
|
465
523
|
```
|
466
524
|
|
467
525
|
Pluralization is possible as well and by default provides English rules:
|
468
526
|
|
469
527
|
```javascript
|
470
|
-
I18n.t("inbox.counting", {count: 10}); // You have 10 messages
|
528
|
+
I18n.t("inbox.counting", { count: 10 }); // You have 10 messages
|
471
529
|
```
|
472
530
|
|
473
531
|
The sample above expects the following translation:
|
@@ -483,21 +541,34 @@ en:
|
|
483
541
|
|
484
542
|
**NOTE:** Rails I18n recognizes the `zero` option.
|
485
543
|
|
486
|
-
If you need special rules just define them for your language, for example
|
544
|
+
If you need special rules just define them for your language, for example
|
545
|
+
Russian, just add a new pluralizer:
|
487
546
|
|
488
547
|
```javascript
|
489
548
|
I18n.pluralization["ru"] = function (count) {
|
490
|
-
var key =
|
549
|
+
var key =
|
550
|
+
count % 10 == 1 && count % 100 != 11
|
551
|
+
? "one"
|
552
|
+
: [2, 3, 4].indexOf(count % 10) >= 0 &&
|
553
|
+
[12, 13, 14].indexOf(count % 100) < 0
|
554
|
+
? "few"
|
555
|
+
: count % 10 == 0 ||
|
556
|
+
[5, 6, 7, 8, 9].indexOf(count % 10) >= 0 ||
|
557
|
+
[11, 12, 13, 14].indexOf(count % 100) >= 0
|
558
|
+
? "many"
|
559
|
+
: "other";
|
491
560
|
return [key];
|
492
561
|
};
|
493
562
|
```
|
494
563
|
|
495
|
-
You can find all rules on
|
564
|
+
You can find all rules on
|
565
|
+
<https://unicode-org.github.io/cldr-staging/charts/37/supplemental/language_plural_rules.html>.
|
496
566
|
|
497
|
-
If you're using the same scope over and over again, you may use the `scope`
|
567
|
+
If you're using the same scope over and over again, you may use the `scope`
|
568
|
+
option.
|
498
569
|
|
499
570
|
```javascript
|
500
|
-
var options = {scope: "activerecord.attributes.user"};
|
571
|
+
var options = { scope: "activerecord.attributes.user" };
|
501
572
|
|
502
573
|
I18n.t("name", options);
|
503
574
|
I18n.t("email", options);
|
@@ -526,14 +597,13 @@ I18n.l("percentage", 123.45);
|
|
526
597
|
// 123.450%
|
527
598
|
```
|
528
599
|
|
529
|
-
To have more control over number formatting, you can use the
|
530
|
-
`I18n.
|
531
|
-
functions.
|
600
|
+
To have more control over number formatting, you can use the `I18n.toNumber`,
|
601
|
+
`I18n.toPercentage`, `I18n.toCurrency` and `I18n.toHumanSize` functions.
|
532
602
|
|
533
603
|
```javascript
|
534
|
-
I18n.toNumber(1000);
|
535
|
-
I18n.toCurrency(1000);
|
536
|
-
I18n.toPercentage(100);
|
604
|
+
I18n.toNumber(1000); // 1,000.000
|
605
|
+
I18n.toCurrency(1000); // $1,000.00
|
606
|
+
I18n.toPercentage(100); // 100.000%
|
537
607
|
```
|
538
608
|
|
539
609
|
The `toNumber` and `toPercentage` functions accept the following options:
|
@@ -546,9 +616,9 @@ The `toNumber` and `toPercentage` functions accept the following options:
|
|
546
616
|
See some number formatting examples:
|
547
617
|
|
548
618
|
```javascript
|
549
|
-
I18n.toNumber(1000, {precision: 0});
|
550
|
-
I18n.toNumber(1000, {delimiter: ".", separator: ","}); // 1.000,000
|
551
|
-
I18n.toNumber(1000, {delimiter: ".", precision: 0});
|
619
|
+
I18n.toNumber(1000, { precision: 0 }); // 1,000
|
620
|
+
I18n.toNumber(1000, { delimiter: ".", separator: "," }); // 1.000,000
|
621
|
+
I18n.toNumber(1000, { delimiter: ".", precision: 0 }); // 1.000
|
552
622
|
```
|
553
623
|
|
554
624
|
The `toCurrency` function accepts the following options:
|
@@ -564,7 +634,7 @@ The `toCurrency` function accepts the following options:
|
|
564
634
|
You can provide only the options you want to override:
|
565
635
|
|
566
636
|
```javascript
|
567
|
-
I18n.toCurrency(1000, {precision: 0}); // $1,000
|
637
|
+
I18n.toCurrency(1000, { precision: 0 }); // $1,000
|
568
638
|
```
|
569
639
|
|
570
640
|
The `toHumanSize` function accepts the following options:
|
@@ -574,6 +644,7 @@ The `toHumanSize` function accepts the following options:
|
|
574
644
|
- `delimiter`: defaults to `""`
|
575
645
|
- `strip_insignificant_zeros`: defaults to `false`
|
576
646
|
- `format`: defaults to `%n%u`
|
647
|
+
- `scope`: defaults to `""`
|
577
648
|
|
578
649
|
<!---->
|
579
650
|
|
@@ -582,18 +653,17 @@ I18n.toHumanSize(1234); // 1KB
|
|
582
653
|
I18n.toHumanSize(1234 * 1024); // 1MB
|
583
654
|
```
|
584
655
|
|
585
|
-
|
586
656
|
#### Date formatting
|
587
657
|
|
588
658
|
```javascript
|
589
659
|
// accepted formats
|
590
|
-
I18n.l("date.formats.short", "2009-09-18");
|
591
|
-
I18n.l("time.formats.short", "2009-09-18 23:12:43");
|
592
|
-
I18n.l("time.formats.short", "2009-11-09T18:10:34");
|
660
|
+
I18n.l("date.formats.short", "2009-09-18"); // yyyy-mm-dd
|
661
|
+
I18n.l("time.formats.short", "2009-09-18 23:12:43"); // yyyy-mm-dd hh:mm:ss
|
662
|
+
I18n.l("time.formats.short", "2009-11-09T18:10:34"); // JSON format with local Timezone (part of ISO-8601)
|
593
663
|
I18n.l("time.formats.short", "2009-11-09T18:10:34Z"); // JSON format in UTC (part of ISO-8601)
|
594
|
-
I18n.l("date.formats.short", 1251862029000);
|
595
|
-
I18n.l("date.formats.short", "09/18/2009");
|
596
|
-
I18n.l("date.formats.short",
|
664
|
+
I18n.l("date.formats.short", 1251862029000); // Epoch time
|
665
|
+
I18n.l("date.formats.short", "09/18/2009"); // mm/dd/yyyy
|
666
|
+
I18n.l("date.formats.short", new Date()); // Date object
|
597
667
|
```
|
598
668
|
|
599
669
|
You can also add placeholders to the date format:
|
@@ -602,14 +672,16 @@ You can also add placeholders to the date format:
|
|
602
672
|
I18n.translations["en"] = {
|
603
673
|
date: {
|
604
674
|
formats: {
|
605
|
-
ordinal_day: "%B %{day}"
|
606
|
-
}
|
607
|
-
}
|
608
|
-
}
|
609
|
-
|
675
|
+
ordinal_day: "%B %{day}",
|
676
|
+
},
|
677
|
+
},
|
678
|
+
};
|
679
|
+
|
680
|
+
I18n.l("date.formats.ordinal_day", "2009-09-18", { day: "18th" }); // Sep 18th
|
610
681
|
```
|
611
682
|
|
612
|
-
If you prefer, you can use the `I18n.toTime` and `I18n.strftime` functions to
|
683
|
+
If you prefer, you can use the `I18n.toTime` and `I18n.strftime` functions to
|
684
|
+
format dates.
|
613
685
|
|
614
686
|
```javascript
|
615
687
|
var date = new Date();
|
@@ -648,8 +720,10 @@ The accepted formats for `I18n.strftime` are:
|
|
648
720
|
Check out `spec/*.spec.js` files for more examples!
|
649
721
|
|
650
722
|
#### Using pluralization and number formatting together
|
651
|
-
|
652
|
-
|
723
|
+
|
724
|
+
Sometimes you might want to display translation with formatted number, like
|
725
|
+
adding thousand delimiters to displayed number You can do this:
|
726
|
+
|
653
727
|
```json
|
654
728
|
{
|
655
729
|
"en": {
|
@@ -661,153 +735,176 @@ You can do this:
|
|
661
735
|
}
|
662
736
|
}
|
663
737
|
```
|
738
|
+
|
664
739
|
```js
|
665
740
|
var point_in_number = 1000;
|
666
|
-
I18n.t(
|
741
|
+
I18n.t("point", {
|
742
|
+
count: point_in_number,
|
743
|
+
formatted_number: I18n.toNumber(point_in_number),
|
744
|
+
});
|
667
745
|
```
|
668
|
-
Output should be `1,000 points`
|
669
746
|
|
747
|
+
Output should be `1,000 points`
|
670
748
|
|
671
749
|
## Using multiple exported translation files on a page.
|
672
|
-
|
750
|
+
|
751
|
+
This method is useful for very large apps where a single contained
|
752
|
+
translations.js file is not desirable. Examples would be a global translations
|
753
|
+
file and a more specific route translation file.
|
673
754
|
|
674
755
|
### Rails without asset pipeline
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
682
|
-
|
683
|
-
|
684
|
-
|
685
|
-
|
686
|
-
|
687
|
-
|
688
|
-
|
689
|
-
|
690
|
-
|
691
|
-
|
692
|
-
|
693
|
-
|
694
|
-
|
695
|
-
|
696
|
-
|
697
|
-
|
698
|
-
|
699
|
-
|
700
|
-
|
701
|
-
|
702
|
-
|
703
|
-
|
704
|
-
|
705
|
-
|
706
|
-
|
707
|
-
|
708
|
-
|
709
|
-
|
710
|
-
|
711
|
-
|
712
|
-
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
|
756
|
+
|
757
|
+
1. Setup your `config/i18n-js.yml` to have multiple files and try to minimize
|
758
|
+
any overlap.
|
759
|
+
|
760
|
+
```yaml
|
761
|
+
sort_translation_keys: true
|
762
|
+
fallbacks: false
|
763
|
+
|
764
|
+
translations:
|
765
|
+
+ file: "app/assets/javascript/nls/welcome.js"
|
766
|
+
only:
|
767
|
+
+ '*.welcome.*'
|
768
|
+
|
769
|
+
+ file: "app/assets/javascript/nls/albums.js"
|
770
|
+
only:
|
771
|
+
+ '*.albums.*'
|
772
|
+
|
773
|
+
+ file: "app/assets/javascript/nls/global.js"
|
774
|
+
only:
|
775
|
+
+ '*'
|
776
|
+
# Exempt any routes specific translations from being
|
777
|
+
# included in the global translation file
|
778
|
+
except:
|
779
|
+
+ '*.welcome.*'
|
780
|
+
+ '*.albums.*'
|
781
|
+
```
|
782
|
+
|
783
|
+
When `rake i18n:js:export` is executed it will create 3 translations files that
|
784
|
+
can be loaded via the `javascript_include_tag`
|
785
|
+
|
786
|
+
2. Add the `javascript_include_tag` to your layout and to any route specific
|
787
|
+
files that will require it.
|
788
|
+
|
789
|
+
```ruby
|
790
|
+
# views/layouts/application.html.erb
|
791
|
+
<%= javascript_include_tag(
|
792
|
+
"i18n"
|
793
|
+
"nls/global"
|
794
|
+
) %>
|
795
|
+
```
|
796
|
+
|
797
|
+
and in the route specific
|
798
|
+
|
799
|
+
```ruby
|
800
|
+
# views/welcome/index.html.erb
|
801
|
+
<%= javascript_include_tag(
|
802
|
+
"nls/welcome"
|
803
|
+
) %>
|
804
|
+
```
|
717
805
|
|
718
806
|
3. Make sure that you add these files to your `config/application.rb`
|
719
807
|
|
720
|
-
|
721
|
-
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
808
|
+
```ruby
|
809
|
+
config.assets.precompile += %w(
|
810
|
+
i18n
|
811
|
+
nls/*
|
812
|
+
)
|
813
|
+
```
|
726
814
|
|
727
815
|
### Using require.js / r.js
|
728
816
|
|
729
817
|
To use this with require.js we are only going to change a few things from above.
|
730
818
|
|
731
|
-
1. In your `config/i18n-js.yml` we need to add a better location for the i18n to
|
732
|
-
|
733
|
-
|
734
|
-
|
735
|
-
|
736
|
-
|
737
|
-
|
738
|
-
|
739
|
-
|
740
|
-
|
741
|
-
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
|
746
|
-
|
747
|
-
|
748
|
-
|
749
|
-
|
750
|
-
|
751
|
-
|
752
|
-
|
753
|
-
|
754
|
-
|
755
|
-
|
756
|
-
|
757
|
-
|
758
|
-
|
759
|
-
|
760
|
-
|
761
|
-
|
762
|
-
|
763
|
-
|
764
|
-
|
765
|
-
|
766
|
-
|
767
|
-
|
768
|
-
|
769
|
-
|
770
|
-
|
771
|
-
|
772
|
-
|
773
|
-
|
774
|
-
|
775
|
-
|
776
|
-
|
777
|
-
|
778
|
-
|
779
|
-
|
780
|
-
|
781
|
-
|
782
|
-
|
783
|
-
|
784
|
-
|
785
|
-
|
786
|
-
|
787
|
-
|
788
|
-
|
819
|
+
1. In your `config/i18n-js.yml` we need to add a better location for the i18n to
|
820
|
+
be exported to. You want to use this location so that it can be properly
|
821
|
+
precompiled by r.js.
|
822
|
+
|
823
|
+
```yaml
|
824
|
+
export_i18n_js: "app/assets/javascript/nls"
|
825
|
+
```
|
826
|
+
|
827
|
+
2. In your `config/require.yml` we need to add a map, shim all the translations,
|
828
|
+
and include them into the appropriate modules
|
829
|
+
|
830
|
+
```yaml
|
831
|
+
# In your maps add (if you do not have this you will need to add it)
|
832
|
+
map:
|
833
|
+
'*':
|
834
|
+
i18n: 'nls/i18n'
|
835
|
+
|
836
|
+
# In your shims
|
837
|
+
shims:
|
838
|
+
nls/welcome:
|
839
|
+
deps:
|
840
|
+
+ i18n
|
841
|
+
|
842
|
+
nls/global:
|
843
|
+
deps:
|
844
|
+
+ i18n
|
845
|
+
|
846
|
+
# Finally in your modules
|
847
|
+
modules:
|
848
|
+
+ name: 'application'
|
849
|
+
include:
|
850
|
+
+ i18n
|
851
|
+
+ 'nls/global'
|
852
|
+
|
853
|
+
+ name: 'welcome'
|
854
|
+
exclude:
|
855
|
+
+ application
|
856
|
+
include:
|
857
|
+
+ 'nls/welcome'
|
858
|
+
```
|
859
|
+
|
860
|
+
3. When `rake assets:precompile` is executed it will optimize the translations
|
861
|
+
into the correct modules so they are loaded with their assigned module, and
|
862
|
+
loading them with requirejs is as simple as requiring any other shim.
|
863
|
+
|
864
|
+
```javascript
|
865
|
+
define(["welcome/other_asset", "nls/welcome"], function (otherAsset) {
|
866
|
+
// ...
|
867
|
+
});
|
868
|
+
```
|
869
|
+
|
870
|
+
4. (optional) As an additional configuration we can make a task to be run before
|
871
|
+
the requirejs optimizer. This will allow any automated scripts that run the
|
872
|
+
requirejs optimizer to export the strings before we run r.js.
|
873
|
+
|
874
|
+
```rake
|
875
|
+
# lib/tasks/i18n.rake
|
876
|
+
Rake::Task[:'i18n:js:export'].prerequisites.clear
|
877
|
+
task :'i18n:js:export' => :'i18n:js:before_export'
|
878
|
+
task :'requirejs:precompile:external' => :'i18n:js:export'
|
879
|
+
|
880
|
+
namespace :i18n do
|
881
|
+
namespace :js do
|
882
|
+
task :before_export => :'assets:environment' do
|
883
|
+
I18n.load_path += Dir[Rails.root.join('config', 'locales', '*.{yml,rb}')]
|
884
|
+
I18n.backend.load_translations
|
789
885
|
end
|
790
886
|
end
|
791
|
-
|
887
|
+
end
|
888
|
+
```
|
792
889
|
|
793
890
|
## Using I18n.js with other languages (Python, PHP, ...)
|
794
891
|
|
795
|
-
The JavaScript library is language agnostic; so you can use it with PHP, Python,
|
796
|
-
The only requirement is that you need to set the
|
892
|
+
The JavaScript library is language agnostic; so you can use it with PHP, Python,
|
893
|
+
[your favorite language here]. The only requirement is that you need to set the
|
894
|
+
`translations` attribute like following:
|
797
895
|
|
798
896
|
```javascript
|
799
897
|
I18n.translations = {};
|
800
898
|
|
801
899
|
I18n.translations["en"] = {
|
802
|
-
message: "Some special message for you"
|
803
|
-
}
|
900
|
+
message: "Some special message for you",
|
901
|
+
};
|
804
902
|
|
805
903
|
I18n.translations["pt-BR"] = {
|
806
|
-
message: "Uma mensagem especial para você"
|
807
|
-
}
|
904
|
+
message: "Uma mensagem especial para você",
|
905
|
+
};
|
808
906
|
```
|
809
907
|
|
810
|
-
|
811
908
|
## Known Issues
|
812
909
|
|
813
910
|
### Missing translations in precompiled file(s) after adding any new locale file
|
@@ -815,66 +912,80 @@ I18n.translations["pt-BR"] = {
|
|
815
912
|
Due to the design of `sprockets`:
|
816
913
|
|
817
914
|
- `depend_on` only takes file paths, not directory paths
|
818
|
-
- registered `preprocessors` are only run when the fingerprint of any asset
|
915
|
+
- registered `preprocessors` are only run when the fingerprint of any asset
|
916
|
+
file, including `.erb` files, is changed
|
917
|
+
|
918
|
+
This means that new locale files will not be detected, and so they will not
|
919
|
+
trigger a i18n-js refresh. There are a few approaches to work around this:
|
819
920
|
|
820
|
-
|
921
|
+
1. You can force i18n-js to update its translations by completely clearing the
|
922
|
+
assets cache. Use one of the following:
|
821
923
|
|
822
|
-
1. You can force i18n-js to update its translations by completely clearing the assets cache. Use one of the following:
|
823
|
-
|
824
924
|
```bash
|
825
925
|
$ rake assets:clobber
|
826
926
|
# Or, with older versions of Rails:
|
827
927
|
$ rake tmp:cache:clear
|
828
928
|
```
|
829
929
|
|
830
|
-
These commands will remove
|
930
|
+
These commands will remove _all_ fingerprinted assets, and you will have to
|
931
|
+
recompile them with
|
831
932
|
|
832
933
|
```bash
|
833
934
|
$ rake assets:precompile
|
834
935
|
```
|
835
936
|
|
836
|
-
or similar commands.
|
937
|
+
or similar commands. If you are precompiling assets on the target machine(s),
|
938
|
+
cached pages may be broken by this, so they will need to be refreshed.
|
837
939
|
|
838
940
|
2. You can change something in a different locale file.
|
839
941
|
|
840
942
|
3. Finally, you can change `config.assets.version`.
|
841
943
|
|
842
|
-
**Note:** See issue [#213](https://github.com/fnando/i18n-js/issues/213) for
|
944
|
+
**Note:** See issue [#213](https://github.com/fnando/i18n-js/issues/213) for
|
945
|
+
more details and discussion of this issue.
|
843
946
|
|
844
947
|
### Translations in JS are not updated when Sprockets not loaded before this gem
|
845
948
|
|
846
|
-
The "rails engine" declaration will try to detect existence of "sprockets"
|
847
|
-
If sprockets is loaded after this gem, the
|
848
|
-
making JS translations file cache to depend on content of
|
849
|
-
So ensure sprockets is loaded before this gem
|
949
|
+
The "rails engine" declaration will try to detect existence of "sprockets"
|
950
|
+
before adding the initailizer If sprockets is loaded after this gem, the
|
951
|
+
preprocessor for making JS translations file cache to depend on content of
|
952
|
+
locale files will not be hooked. So ensure sprockets is loaded before this gem
|
953
|
+
by moving the entry of sprockets in the Gemfile or adding "require" statements
|
954
|
+
for sprockets somewhere.
|
850
955
|
|
851
|
-
**Note:** See issue [#404](https://github.com/fnando/i18n-js/issues/404) for
|
956
|
+
**Note:** See issue [#404](https://github.com/fnando/i18n-js/issues/404) for
|
957
|
+
more details and discussion of this issue.
|
852
958
|
|
853
959
|
### JS `I18n.toCurrency` & `I18n.toNumber` cannot handle large integers
|
854
960
|
|
855
|
-
The above methods use `toFixed` and it only supports 53 bit integers.
|
856
|
-
|
961
|
+
The above methods use `toFixed` and it only supports 53 bit integers. Ref:
|
962
|
+
http://2ality.com/2012/07/large-integers.html
|
857
963
|
|
858
|
-
Feel free to find & discuss possible solution(s) at issue
|
964
|
+
Feel free to find & discuss possible solution(s) at issue
|
965
|
+
[#511](https://github.com/fnando/i18n-js/issues/511)
|
859
966
|
|
860
967
|
### Only works with `Simple` backend
|
861
968
|
|
862
|
-
If you set `I18n.backend` to something other than the default `Simple` backend,
|
969
|
+
If you set `I18n.backend` to something other than the default `Simple` backend,
|
970
|
+
you will likely get an exception like this:
|
863
971
|
|
864
972
|
```
|
865
973
|
Undefined method 'initialized?' for <your backend class>
|
866
974
|
```
|
867
975
|
|
868
|
-
For now, i18n-js is only compatible with the `Simple` backend.
|
869
|
-
|
976
|
+
For now, i18n-js is only compatible with the `Simple` backend. If you need a
|
977
|
+
more sophisticated backend for your rails application, like
|
978
|
+
`I18n::Backend::ActiveRecord`, you can setup i18n-js to get translations from a
|
979
|
+
separate `Simple` backend, by adding the following in an initializer:
|
870
980
|
|
871
981
|
```ruby
|
872
982
|
I18n::JS.backend = I18n.backend
|
873
983
|
I18n.backend = I18n::Backend::Chain.new(<your other backend(s)>, I18n.backend)
|
874
984
|
```
|
875
985
|
|
876
|
-
This will use your backend with the default `Simple` backend as fallback, while
|
877
|
-
|
986
|
+
This will use your backend with the default `Simple` backend as fallback, while
|
987
|
+
i18n-js only sees and uses the simple backend. This means however, that only
|
988
|
+
translations from your static locale files will be present in JavaScript.
|
878
989
|
|
879
990
|
If you do cannot use a `Chain`-Backend for some reason, you can also set
|
880
991
|
|
@@ -883,9 +994,11 @@ I18n::JS.backend = I18n::Backend::Simple.new
|
|
883
994
|
I18n.backend = <something different>
|
884
995
|
```
|
885
996
|
|
886
|
-
However, the automatic reloading of translations in developement will not work
|
887
|
-
This is because Rails calls `I18n.reload!` for each request in
|
888
|
-
|
997
|
+
However, the automatic reloading of translations in developement will not work
|
998
|
+
in this case. This is because Rails calls `I18n.reload!` for each request in
|
999
|
+
development, but `reload!` will not be called on `I18n::JS.backend`, since it is
|
1000
|
+
a different object. One option would be to patch `I18n.reload!` in an
|
1001
|
+
initializer:
|
889
1002
|
|
890
1003
|
```ruby
|
891
1004
|
module I18n
|
@@ -896,11 +1009,12 @@ module I18n
|
|
896
1009
|
end
|
897
1010
|
```
|
898
1011
|
|
899
|
-
See issue [#428](https://github.com/fnando/i18n-js/issues/428) for more details
|
1012
|
+
See issue [#428](https://github.com/fnando/i18n-js/issues/428) for more details
|
1013
|
+
and discussion of this issue.
|
900
1014
|
|
901
1015
|
## Maintainer
|
902
1016
|
|
903
|
-
- Nando Vieira - <http://nandovieira.com
|
1017
|
+
- Nando Vieira - <http://nandovieira.com>
|
904
1018
|
|
905
1019
|
## Contributing
|
906
1020
|
|
@@ -908,13 +1022,14 @@ Once you've made your great commits:
|
|
908
1022
|
|
909
1023
|
1. [Fork](http://help.github.com/forking/) I18n.js
|
910
1024
|
2. Create a branch with a clear name
|
911
|
-
3. Make your changes (Please also add/change spec, README and CHANGELOG if
|
1025
|
+
3. Make your changes (Please also add/change spec, README and CHANGELOG if
|
1026
|
+
applicable)
|
912
1027
|
4. Push changes to the created branch
|
913
1028
|
5. [Create an Pull Request](http://github.com/fnando/i18n-js/pulls)
|
914
1029
|
6. That's it!
|
915
1030
|
|
916
|
-
Please respect the indentation rules and code style.
|
917
|
-
And
|
1031
|
+
Please respect the indentation rules and code style. And use 2 spaces, not tabs.
|
1032
|
+
And don't touch the versioning thing.
|
918
1033
|
|
919
1034
|
## Running tests
|
920
1035
|
|
@@ -936,21 +1051,19 @@ You can run both Ruby and JavaScript specs with `rake spec`.
|
|
936
1051
|
|
937
1052
|
(The MIT License)
|
938
1053
|
|
939
|
-
Permission is hereby granted, free of charge, to any person obtaining
|
940
|
-
|
941
|
-
|
942
|
-
|
943
|
-
|
944
|
-
|
945
|
-
|
946
|
-
|
947
|
-
|
948
|
-
|
949
|
-
|
950
|
-
|
951
|
-
|
952
|
-
|
953
|
-
IN
|
954
|
-
|
955
|
-
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
956
|
-
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
1054
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
1055
|
+
this software and associated documentation files (the 'Software'), to deal in
|
1056
|
+
the Software without restriction, including without limitation the rights to
|
1057
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
1058
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
1059
|
+
subject to the following conditions:
|
1060
|
+
|
1061
|
+
The above copyright notice and this permission notice shall be included in all
|
1062
|
+
copies or substantial portions of the Software.
|
1063
|
+
|
1064
|
+
THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
1065
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
1066
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
1067
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
1068
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
1069
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|