i18n-js 4.0.0.alpha2 → 4.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45e8592f190777f676916988517d474dffb4f18f09120df26733c947d63ca140
-  data.tar.gz: 04dfd46cfd05501a7cd1e97c5612a1ab5dbec52f98bad5f9119febcf28ce3ab8
+  metadata.gz: 7e0fd83a034e8eaa82e97f46beb39a96da4d671952762f7751d093d4823e1aed
+  data.tar.gz: acff26df94aa46c0c50d5864c97b32bc1108a611a748c2dd7fff4d626ec41cf4
 SHA512:
-  metadata.gz: 96caedcf824fb434a3b77dba666dd23cff72fbfd9f3d3175c928d768920d402f2d9250bb9ff0810e836ff5fbd90d3825b19621a4fd7c27ef10a7a40586990326
-  data.tar.gz: bc68a8b9e54c991dc21e50ca52986b2f5c39418e6aed3b48664efbcb501e8f34d7a1333a608d6de4b6d5d8bcf7f2fc3c2de5584123b47cc6873e29047da2fdfb
+  metadata.gz: d72a28ddbe75742e605c86d8e3b06ce2e1ada21bc95f2b189e2e120b671c7c0d4d239dfc7c3753abd4b97f57820146001cfdfb89e2c407ae3054ea93fba98d72
+  data.tar.gz: 5ed38c2ea91915fadcc6cc7a4b718d1473cc41afff0c5cd3f6dd6e1345e2eed29c53bace6403239dd516a180485b055414cd65c00291747d20c6055c6b2f6a2a

data/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+---
+contact_links:
+  - name: "🤨 Q&A"
+    url: https://github.com/fnando/i18n-js/discussions/new?category=q-a
+    about: Have a question? Ask it away here!

data/.github/workflows/ruby-tests.yml

@@ -2,8 +2,10 @@
 name: ruby-tests
 
 on:
-  pull_request:
+  pull_request_target:
   push:
+    branches:
+      - v4
   workflow_dispatch:
     inputs: {}
 
@@ -14,14 +16,17 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0"]
+        ruby: ["2.7", "3.0", "3.1"]
         gemfile:
           - Gemfile
+    if: |
+      github.actor == 'dependabot[bot]' && github.event_name == 'pull_request_target' ||
+      github.actor != 'dependabot[bot]'
 
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v3
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         id: bundler-cache
         with:
           path: vendor/bundle

data/.rubocop.yml

@@ -7,11 +7,10 @@ AllCops:
   NewCops: enable
   Exclude:
     - tmp/**/*
+    - vendor/**/*
+    - gemfiles/**/*
 
 Naming/FileName:
   Exclude:
     - lib/i18n-js.rb
     - lib/guard/i18n-js.rb
-
-Metrics:
-  Enabled: false

data/README.md

@@ -1,15 +1,30 @@
-# i18n-js
-
-[![Tests](https://github.com/fnando/i18n-js/workflows/ruby-tests/badge.svg)](https://github.com/fnando/i18n-js)
-[![Code Climate](https://codeclimate.com/github/fnando/i18n-js/badges/gpa.svg)](https://codeclimate.com/github/fnando/i18n-js)
-[![Gem](https://img.shields.io/gem/v/i18n-js.svg)](https://rubygems.org/gems/i18n-js)
-[![Gem](https://img.shields.io/gem/dt/i18n-js.svg)](https://rubygems.org/gems/i18n-js)
-
-Export [i18n](https://rubygems.org/gems/i18n) translations to JSON. A perfect
-fit if you want to export translations to JavaScript.
-
-Oh, you don't use Ruby? No problem! You can still use i18n-js and the
-[companion JavaScript package](https://npmjs.com/package/i18n-js).
+<p align="center">
+  <img width="250" height="58" src="https://github.com/fnando/i18n-js/raw/main/i18njs.png" alt="i18n.js">
+</p>
+
+<p align="center">
+  Export <a href="https://rubygems.org/gems/i18n">i18n</a> translations to JSON.
+  <br>
+  A perfect fit if you want to export translations to JavaScript.
+</p>
+
+<p align="center">
+  <small>
+    Oh, you don't use Ruby? No problem! You can still use i18n-js
+    <br>
+    and the 
+    <a href="https://www.npmjs.com/package/i18n-js/v/next">companion JavaScript package</a>.
+  </small>
+</p>
+
+<p align="center">
+  <a href="https://github.com/fnando/i18n-js"><img src="https://github.com/fnando/i18n-js/workflows/ruby-tests/badge.svg" alt="Tests"></a>
+  <a href="https://rubygems.org/gems/i18n-js"><img src="https://img.shields.io/gem/v/i18n-js.svg" alt="Gem"></a>
+  <a href="https://rubygems.org/gems/i18n-js"><img src="https://img.shields.io/gem/dt/i18n-js.svg" alt="Gem"></a>
+  <a href="https://tldrlegal.com/license/mit-license"><img src="https://img.shields.io/:License-MIT-blue.svg" alt="MIT License"></a>
+</p>
+
+![This branch contains the code for v4, our next major release.](https://messages-svg.herokuapp.com/warning.svg?message=This%20branch%20contains%20the%20code%20for%20v4%2C%20our%20next%20major%20release.)
 
 ## Installation
 
@@ -45,11 +60,16 @@ translations:
       - "!*.errors"
       - "!*.number.nth"
 
-  - file: app/frontend/locales/:locale.json
+  - file: app/frontend/locales/:locale.:digest.json
     patterns:
       - "*"
 ```
 
+The output path can use the following placeholders:
+
+- `:locale`: the language that's being exported.
+- `:digest`: the MD5 hex digest of the exported file.
+
 The Ruby API:
 
 ```ruby
@@ -72,6 +92,51 @@ both `--config` and `--require`.
 
 ## Automatically export translations
 
+### Using watchman
+
+Create a script at `bin/i18n-watch`.
+
+```bash
+#!/usr/bin/env bash
+
+root=`pwd`
+
+watchman watch-del "$root"
+watchman watch-project "$root"
+watchman trigger-del "$root" i18n
+
+watchman -j <<-JSON
+[
+  "trigger",
+  "$root",
+  {
+    "name": "i18n",
+    "expression": [
+      "anyof",
+      ["match", "config/locales/**/*.yml", "wholename"],
+      ["match", "config/i18n.yml", "wholename"]
+    ],
+    "command": ["i18n", "export"]
+  }
+]
+JSON
+
+# If you're running this through Foreman,
+# the uncomment the following lines:
+# while true; do
+#   sleep 1
+# done
+```
+
+Make it executable with `chmod +x bin/i18n-watch`. To watch for changes, run
+`./bin/i18n-watch`. If you're using Foreman, make sure you uncommented the lines
+that keep the process running (`while..`), and add something like the following
+line to your Procfile:
+
+```
+i18n: ./bin/i18n-watch
+```
+
 ### Using guard
 
 Install [guard](https://rubygems.org/packages/guard) and
@@ -89,7 +154,7 @@ guard(:"i18n-js",
 end
 ```
 
-If you files in a different location, the remember to configure file paths
+If your files are located in a different path, remember to configure file paths
 accordingly.
 
 Now you can run `guard start -i`.
@@ -115,6 +180,31 @@ You're done exporting files, now what? Well, go to
 [i18n](https://github.com/fnando/i18n) to discover how to use the NPM package
 that loads all the exported translation.
 
+### FAQ
+
+#### How can I export translations without having a database around?
+
+Some people may have a build process using something like Docker that don't
+necessarily have a database available. In this case, you may define your own
+loading file by using something like
+`i18n export --require ./config/i18n_export.rb`, where `i18n_export.rb` may look
+like this:
+
+```ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rails"
+require "active_support/railtie"
+require "action_view/railtie"
+
+I18n.load_path += Dir["./config/locales/**/*.yml"]
+```
+
+Notice that you may not need to load ActiveSupport and ActionView lines, or even
+may need to add additional requires for other libs. With this approach you have
+full control on what's going to be loaded.
+
 ## Maintainer
 
 - [Nando Vieira](https://github.com/fnando)

data/lib/i18n-js/cli/init_command.rb

@@ -23,7 +23,9 @@ module I18nJS
       end
 
       command do
-        file_path = File.expand_path(options[:config_file])
+        file_path = File.expand_path(
+          options.fetch(:config_file, "config/i18n.yml")
+        )
 
         if File.file?(file_path)
           ui.fail_with("ERROR: #{file_path} already exists!")

data/lib/i18n-js/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nJS
-  VERSION = "4.0.0.alpha2"
+  VERSION = "4.0.0.alpha3"
 end

data/lib/i18n-js.rb

@@ -44,8 +44,12 @@ module I18nJS
   def self.write_file(file_path, translations)
     FileUtils.mkdir_p(File.dirname(file_path))
 
+    contents = ::JSON.pretty_generate(translations)
+    digest = Digest::MD5.hexdigest(contents)
+    file_path = file_path.gsub(/:digest/, digest)
+
     File.open(file_path, "w") do |file|
-      file << ::JSON.pretty_generate(translations)
+      file << contents
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha2
+  version: 4.0.0.alpha3
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-28 00:00:00.000000000 Z
+date: 2022-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glob
@@ -161,6 +161,7 @@ files:
 - ".github/CODEOWNERS"
 - ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/config.yml"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/dependabot.yml"
@@ -176,6 +177,7 @@ files:
 - Rakefile
 - exe/i18n
 - i18n-js.gemspec
+- i18njs.png
 - lib/guard/i18n-js.rb
 - lib/guard/i18n-js/templates/Guardfile
 - lib/guard/i18n-js/version.rb
@@ -196,10 +198,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/i18n-js
   bug_tracker_uri: https://github.com/fnando/i18n-js/issues
-  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha2
-  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha2/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha2/README.md
-  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha2/LICENSE.md
+  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha3
+  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha3/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha3/README.md
+  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.0.alpha3/LICENSE.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -215,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.32
+rubygems_version: 3.3.17
 signing_key:
 specification_version: 4
 summary: Export i18n translations and use them on JavaScript.