i18n-js 4.0.1 → 4.2.0

data/lib/i18n-js/lint.ts

@@ -0,0 +1,196 @@
+import { readFileSync, statSync } from "fs";
+import * as ts from "typescript";
+import { glob } from "glob";
+
+type ScopeInfo = {
+  type: "default" | "scope" | "base";
+  location: string;
+  base: string | null;
+  full: string;
+  scope: string;
+};
+
+function location(node: ts.Node, append: string = ":") {
+  const sourceFile = node.getSourceFile();
+  let { line, character } = sourceFile.getLineAndCharacterOfPosition(
+    node.getStart(sourceFile)
+  );
+
+  line += 1;
+  character += 1;
+  const file = sourceFile.fileName;
+  const location = `${file}:${line}:${character}`;
+
+  return `${location}${append}`;
+}
+
+const callExpressions = ["t", "i18n.t", "i18n.translate"];
+
+function tsKind(node: ts.Node) {
+  const keys = Object.keys(ts.SyntaxKind);
+  const values = Object.values(ts.SyntaxKind);
+
+  return keys[values.indexOf(node.kind)];
+}
+
+function getTranslationScopesFromFile(filePath: string) {
+  const scopes: ScopeInfo[] = [];
+
+  const sourceFile = ts.createSourceFile(
+    filePath,
+    readFileSync(filePath).toString(),
+    ts.ScriptTarget.ES2015,
+    true
+  );
+
+  inspect(sourceFile);
+
+  return scopes;
+
+  function inspect(node: ts.Node) {
+    const next = () => {
+      ts.forEachChild(node, inspect);
+    };
+
+    if (node.kind !== ts.SyntaxKind.CallExpression) {
+      return next();
+    }
+
+    const expr = node.getChildAt(0).getText();
+    const text = JSON.stringify(node.getText(sourceFile));
+
+    if (!callExpressions.includes(expr)) {
+      return next();
+    }
+
+    const syntaxList = node.getChildAt(2);
+
+    if (!syntaxList.getText().trim()) {
+      return next();
+    }
+
+    const scopeNode = syntaxList.getChildAt(0) as ts.StringLiteral;
+    const optionsNode = syntaxList.getChildAt(2) as ts.ObjectLiteralExpression;
+
+    if (scopeNode.kind !== ts.SyntaxKind.StringLiteral) {
+      return next();
+    }
+
+    if (
+      optionsNode &&
+      optionsNode.kind !== ts.SyntaxKind.ObjectLiteralExpression
+    ) {
+      return next();
+    }
+
+    if (!optionsNode) {
+      scopes.push({
+        type: "scope",
+        scope: scopeNode.text,
+        base: null,
+        full: scopeNode.text,
+        location: location(node, ""),
+      });
+      return next();
+    }
+
+    scopes.push(...getScopes(scopeNode, optionsNode));
+  }
+
+  function mapProperties(node: ts.ObjectLiteralExpression): {
+    name: string;
+    value: ts.Node;
+  }[] {
+    return node.properties.map((p) => ({
+      name: (p.name as ts.Identifier).escapedText.toString(),
+      value: p.getChildAt(2),
+    }));
+  }
+
+  function getScopes(
+    scopeNode: ts.StringLiteral,
+    node: ts.ObjectLiteralExpression
+  ): ScopeInfo[] {
+    const suffix = scopeNode.text;
+
+    const result: ScopeInfo[] = [];
+    const properties = mapProperties(node);
+
+    if (
+      properties.length === 0 ||
+      !properties.some((p) => p.name === "scope")
+    ) {
+      result.push({
+        type: "scope",
+        scope: suffix,
+        base: null,
+        full: suffix,
+        location: location(scopeNode, ""),
+      });
+    }
+
+    properties.forEach((property) => {
+      if (
+        property.name === "scope" &&
+        property.value.kind === ts.SyntaxKind.StringLiteral
+      ) {
+        const base = (property.value as ts.StringLiteral).text;
+
+        result.push({
+          type: "base",
+          scope: suffix,
+          base,
+          full: `${base}.${suffix}`,
+          location: location(scopeNode, ""),
+        });
+      }
+
+      if (
+        property.name === "defaults" &&
+        property.value.kind === ts.SyntaxKind.ArrayLiteralExpression
+      ) {
+        const op = property.value as ts.ArrayLiteralExpression;
+        const values = op.getChildAt(1);
+        const objects = (
+          values
+            .getChildren()
+            .filter(
+              (n) => n.kind === ts.SyntaxKind.ObjectLiteralExpression
+            ) as ts.ObjectLiteralExpression[]
+        ).map(mapProperties);
+
+        objects.forEach((object) => {
+          object.forEach((prop) => {
+            if (
+              prop.name === "scope" &&
+              prop.value.kind === ts.SyntaxKind.StringLiteral
+            ) {
+              const text = (prop.value as ts.StringLiteral).text;
+
+              result.push({
+                type: "default",
+                scope: text,
+                base: null,
+                full: text,
+                location: location(prop.value, ""),
+              });
+            }
+          });
+        });
+      }
+    });
+
+    return result;
+  }
+}
+
+const patterns = (
+  process.argv[2] ??
+  "!(node_modules)/**/*.js:!(node_modules)/**/*.ts:!(node_modules)/**/*.jsx:!(node_modules)/**/*.tsx"
+).split(":");
+const files = patterns.flatMap((pattern) => glob.sync(pattern));
+const scopes = files
+  .filter((filePath) => statSync(filePath).isFile())
+  .flatMap((path) => getTranslationScopesFromFile(path));
+
+console.log(JSON.stringify(scopes, null, 2));

data/lib/i18n-js/listen.rb

@@ -8,6 +8,7 @@ module I18nJS
   def self.listen(
     config_file: Rails.root.join("config/i18n.yml"),
     locales_dir: Rails.root.join("config/locales"),
+    run_on_start: true,
     options: {}
   )
     return unless Rails.env.development?
@@ -19,7 +20,7 @@ module I18nJS
 
     self.started = true
 
-    locales_dirs = Array(locales_dir)
+    locales_dirs = Array(locales_dir).map {|path| File.expand_path(path) }
 
     relative_paths =
       [config_file, *locales_dirs].map {|path| relative_path(path) }
@@ -27,7 +28,7 @@ module I18nJS
     debug("Watching #{relative_paths.inspect}")
 
     listener(config_file, locales_dirs.map(&:to_s), options).start
-    I18nJS.call(config_file: config_file)
+    I18nJS.call(config_file: config_file) if run_on_start
   end
 
   def self.relative_path(path)

data/lib/i18n-js/plugin.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "schema"
+
+module I18nJS
+  def self.plugins
+    @plugins ||= []
+  end
+
+  def self.register_plugin(plugin)
+    plugins << plugin
+    plugin.setup
+  end
+
+  def self.plugin_files
+    Gem.find_files("i18n-js/*_plugin.rb")
+  end
+
+  def self.load_plugins!
+    plugin_files.each do |path|
+      require path
+    end
+  end
+
+  class Plugin
+    # This method is responsible for transforming the translations. The
+    # translations you'll receive may be already be filtered by other plugins
+    # and by the default filtering itself. If you need to access the original
+    # translations, use `I18nJS.translations`.
+    #
+    # Make sure you always check whether your plugin is active before
+    # transforming translations; otherwise, opting out transformation won't be
+    # possible.
+    def self.transform(translations:, config:) # rubocop:disable Lint/UnusedMethodArgument
+      translations
+    end
+
+    # In case your plugin accepts configuration, this is where you must validate
+    # the configuration, making sure only valid keys and type is provided.
+    # If the configuration contains invalid data, then you must raise an
+    # exception using something like
+    # `raise I18nJS::Schema::InvalidError, error_message`.
+    def self.validate_schema(config:)
+    end
+
+    # This method must set up the basic plugin configuration, like adding the
+    # config's root key in case your plugin accepts configuration (defined via
+    # the config file).
+    #
+    # If you don't add this key, the linter will prevent non-default keys from
+    # being added to the configuration file.
+    def self.setup
+    end
+
+    # This method is called whenever `I18nJS.call(**kwargs)` finishes exporting
+    # JSON files based on your configuration.
+    #
+    # You can use it to further process exported files, or generate new files
+    # based on the translations that have been exported.
+    #
+    # Make sure you always check whether your plugin is active before
+    # processing files; otherwise, opting out won't be possible.
+    def self.after_export(files:, config:)
+    end
+  end
+end

data/lib/i18n-js/schema.rb

@@ -4,14 +4,28 @@ module I18nJS
   class Schema
     InvalidError = Class.new(StandardError)
 
-    ROOT_KEYS = %i[translations check].freeze
-    REQUIRED_ROOT_KEYS = %i[translations].freeze
-    REQUIRED_CHECK_KEYS = %i[ignore].freeze
+    REQUIRED_LINT_TRANSLATIONS_KEYS = %i[ignore].freeze
+    REQUIRED_LINT_SCRIPTS_KEYS = %i[ignore patterns].freeze
     REQUIRED_TRANSLATION_KEYS = %i[file patterns].freeze
     TRANSLATION_KEYS = %i[file patterns].freeze
 
+    def self.root_keys
+      @root_keys ||= Set.new(%i[
+        translations
+        lint_translations
+        lint_scripts
+        check
+      ])
+    end
+
+    def self.required_root_keys
+      @required_root_keys ||= Set.new(%i[translations])
+    end
+
     def self.validate!(target)
-      new(target).validate!
+      schema = new(target)
+      schema.validate!
+      I18nJS.plugins.each {|plugin| plugin.validate_schema(config: target) }
     end
 
     attr_reader :target
@@ -23,20 +37,36 @@ module I18nJS
     def validate!
       expect_type(:root, target, Hash, target)
 
-      expect_required_keys(REQUIRED_ROOT_KEYS, target)
-      reject_extraneous_keys(ROOT_KEYS, target)
+      expect_required_keys(self.class.required_root_keys, target)
+      reject_extraneous_keys(self.class.root_keys, target)
       validate_translations
-      validate_check
+      validate_lint_translations
+      validate_lint_scripts
     end
 
-    def validate_check
-      return unless target.key?(:check)
+    def validate_lint_translations
+      key = :lint_translations
 
-      check = target[:check]
+      return unless target.key?(key)
 
-      expect_type(:check, check, Hash, target)
-      expect_required_keys(REQUIRED_CHECK_KEYS, check)
-      expect_type(:ignore, check[:ignore], Array, check)
+      config = target[key]
+
+      expect_type(key, config, Hash, target)
+      expect_required_keys(REQUIRED_LINT_TRANSLATIONS_KEYS, config)
+      expect_type(:ignore, config[:ignore], Array, config)
+    end
+
+    def validate_lint_scripts
+      key = :lint_scripts
+
+      return unless target.key?(key)
+
+      config = target[key]
+
+      expect_type(key, config, Hash, target)
+      expect_required_keys(REQUIRED_LINT_SCRIPTS_KEYS, config)
+      expect_type(:ignore, config[:ignore], Array, config)
+      expect_type(:patterns, config[:patterns], Array, config)
     end
 
     def validate_translations
@@ -63,6 +93,15 @@ module I18nJS
       raise InvalidError, "#{error_message}#{node_json}"
     end
 
+    def expect_enabled_config(config_key, value)
+      return if [TrueClass, FalseClass].include?(value.class)
+
+      actual_type = value.class
+
+      reject "Expected #{config_key}.enabled to be a boolean; " \
+             "got #{actual_type} instead"
+    end
+
     def expect_type(attribute, value, expected_type, payload)
       return if value.is_a?(expected_type)
 
@@ -94,7 +133,7 @@ module I18nJS
 
     def reject_extraneous_keys(allowed_keys, value)
       keys = value.keys.map(&:to_sym)
-      extraneous = keys - allowed_keys
+      extraneous = keys.to_a - allowed_keys.to_a
 
       return if extraneous.empty?
 

data/lib/i18n-js/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module I18nJS
-  VERSION = "4.0.1"
+  VERSION = "4.2.0"
 end

data/lib/i18n-js.rb

@@ -6,9 +6,13 @@ require "yaml"
 require "glob"
 require "fileutils"
 require "optparse"
+require "erb"
+require "set"
+require "digest/md5"
 
 require_relative "i18n-js/schema"
 require_relative "i18n-js/version"
+require_relative "i18n-js/plugin"
 
 module I18nJS
   MissingConfigError = Class.new(StandardError)
@@ -19,19 +23,31 @@ module I18nJS
             "you must set either `config_file` or `config`"
     end
 
-    config = Glob::SymbolizeKeys.call(config || YAML.load_file(config_file))
+    load_plugins!
+
+    config = Glob::SymbolizeKeys.call(config || load_config_file(config_file))
+
     Schema.validate!(config)
     exported_files = []
 
     config[:translations].each do |group|
-      exported_files += export_group(group)
+      exported_files += export_group(group, config)
+    end
+
+    plugins.each do |plugin|
+      plugin.after_export(files: exported_files.dup, config: config)
     end
 
     exported_files
   end
 
-  def self.export_group(group)
+  def self.export_group(group, config)
     filtered_translations = Glob.filter(translations, group[:patterns])
+    filtered_translations =
+      plugins.reduce(filtered_translations) do |buffer, plugin|
+        plugin.transform(translations: buffer, config: config)
+      end
+
     output_file_path = File.expand_path(group[:file])
     exported_files = []
 
@@ -70,4 +86,9 @@ module I18nJS
       translations
     end
   end
+
+  def self.load_config_file(config_file)
+    erb = ERB.new(File.read(config_file))
+    YAML.safe_load(erb.result(binding))
+  end
 end

data/package.json

@@ -0,0 +1,10 @@
+{
+  "dependencies": {
+    "esbuild": "^0.16.2",
+    "glob": "^8.0.3",
+    "typescript": "^4.9.4"
+  },
+  "scripts": {
+    "compile": "esbuild lib/i18n-js/lint.ts --bundle --platform=node --outfile=lib/i18n-js/lint.js --target=node16"
+  }
+}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i18n-js
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.2.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-25 00:00:00.000000000 Z
+date: 2022-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: glob
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-meta
   requirement: !ruby/object:Gem::Requirement
@@ -176,6 +190,7 @@ files:
 - MIGRATING_FROM_V3_TO_V4.md
 - README.md
 - Rakefile
+- bin/release
 - exe/i18n
 - i18n-js.gemspec
 - lib/guard/i18n-js.rb
@@ -187,11 +202,20 @@ files:
 - lib/i18n-js/cli/command.rb
 - lib/i18n-js/cli/export_command.rb
 - lib/i18n-js/cli/init_command.rb
+- lib/i18n-js/cli/lint_scripts_command.rb
+- lib/i18n-js/cli/lint_translations_command.rb
+- lib/i18n-js/cli/plugins_command.rb
 - lib/i18n-js/cli/ui.rb
 - lib/i18n-js/cli/version_command.rb
+- lib/i18n-js/embed_fallback_translations_plugin.rb
+- lib/i18n-js/export_files_plugin.rb
+- lib/i18n-js/lint.js
+- lib/i18n-js/lint.ts
 - lib/i18n-js/listen.rb
+- lib/i18n-js/plugin.rb
 - lib/i18n-js/schema.rb
 - lib/i18n-js/version.rb
+- package.json
 homepage: https://github.com/fnando/i18n-js
 licenses:
 - MIT
@@ -199,10 +223,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.1
-  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.0.1/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.0.1/README.md
-  license_uri: https://github.com/fnando/i18n-js/tree/v4.0.1/LICENSE.md
+  source_code_uri: https://github.com/fnando/i18n-js/tree/v4.2.0
+  changelog_uri: https://github.com/fnando/i18n-js/tree/v4.2.0/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/i18n-js/tree/v4.2.0/README.md
+  license_uri: https://github.com/fnando/i18n-js/tree/v4.2.0/LICENSE.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -218,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Export i18n translations and use them on JavaScript.