Localization Language Feature

core/source/Locale.mint

@@ -0,0 +1,19 @@
+module Locale {
+  /* Sets the current locale. */
+  fun set (locale : String) : Bool {
+    `_L.set(#{locale})`
+  }
+
+  /* Returns the current locale. */
+  fun get : Maybe(String) {
+    `
+    (() => {
+      if (_L.locale) {
+        return #{Maybe::Just(`_L.locale`)}
+      } else {
+        return #{Maybe::Nothing}
+      }
+    })()
+    `
+  }
+}

documentation/Language/Locale.md

@@ -0,0 +1,47 @@
+# Locale
+
+This feature of the language allows specifing localization tokens and values for languages indentified by [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) codes.
+
+```mint
+locale en {
+  ui: {
+    buttons: {
+      ok: "OK"
+    }
+  }
+}
+
+locale hu {
+  ui: {
+    buttons: {
+      ok: "Rendben"
+    }
+  }
+}
+```
+
+A locale consists of a tree structure where the keys are lowercase identifiers and the values are expressions.
+
+To localize a value you need to use the locale token:
+
+```
+:ui.buttons.ok
+```
+
+or if it's a function if can be called:
+
+```
+:ui.buttons.ok(param1, param2)
+```
+
+To get and set the current locale the `Locale` module can be used:
+
+```
+Locale.set("en")
+Locale.get() // Maybe::Just("en")
+```
+
+Every translation is typed checked:
+
+* all translations of the same key must have the same type
+* locale keys must have translations in every defined language

spec/compilers/locale_key

@@ -0,0 +1,25 @@
+locale en {
+  test: "Hello"
+}
+
+component Main {
+  fun render : String {
+    :test
+  }
+}
+--------------------------------------------------------------------------------
+class A extends _C {
+  componentWillUnmount() {
+    _L._unsubscribe(this);
+  }
+
+  componentDidMount() {
+    _L._subscribe(this);
+  }
+
+  render() {
+    return _L.t("test");
+  }
+};
+
+A.displayName = "Main";

spec/formatters/locale

@@ -0,0 +1,11 @@
+locale en {
+  ui: {
+    button: {
+      ok: "OK"
+    }
+  }
+}
+--------------------------------------------------------------------------------
+locale en {
+  ui: { button: { ok: "OK" } }
+}

spec/formatters/locale_key

@@ -0,0 +1,23 @@
+locale en {
+  ui: {
+    button: {
+      ok: "OK"
+    }
+  }
+}
+
+component Main {
+  fun render : String {
+    :ui.button.ok
+  }
+}
+--------------------------------------------------------------------------------
+locale en {
+  ui: { button: { ok: "OK" } }
+}
+
+component Main {
+  fun render : String {
+    :ui.button.ok
+  }
+}

spec/language_server/ls_spec.cr

@@ -5,7 +5,7 @@ def clean_json(workspace : Workspace, path : String)
 end
 
 Dir
-  .glob("./spec/language_server/{definition,hover}/**/*")
+  .glob("./spec/language_server/{definition,hover,semantic_tokens}/**/*")
   .select! { |file| File.file?(file) }
   .sort!
   .each do |file|

spec/language_server/semantic_tokens/record

@@ -0,0 +1,87 @@
+/* Some comment. */
+record Article {
+  id : Number,
+  description : String,
+  title : String
+}
+-----------------------------------------------------------------file test.mint
+{
+  "id": 0,
+  "method": "initialize",
+  "params": {
+    "capabilities": {
+      "textDocument": {
+        "semanticTokens": {
+          "dynamicRegistration": false,
+          "tokenTypes": ["property"]
+        }
+      }
+    }
+  }
+}
+-------------------------------------------------------------------------request
+{
+  "jsonrpc": "2.0",
+  "id": 1,
+  "params": {
+    "textDocument": {
+      "uri": "file://#{root_path}/test.mint"
+    }
+  },
+  "method": "textDocument/semanticTokens/full"
+}
+-------------------------------------------------------------------------request
+{
+  "jsonrpc": "2.0",
+  "result": {
+    "data": [
+      0,
+      0,
+      20,
+      5,
+      0,
+      1,
+      0,
+      6,
+      4,
+      0,
+      0,
+      7,
+      7,
+      1,
+      0,
+      1,
+      2,
+      2,
+      6,
+      0,
+      0,
+      5,
+      6,
+      1,
+      0,
+      1,
+      2,
+      11,
+      6,
+      0,
+      0,
+      14,
+      6,
+      1,
+      0,
+      1,
+      2,
+      5,
+      6,
+      0,
+      0,
+      8,
+      6,
+      1,
+      0
+    ]
+  },
+  "id": 1
+}
+------------------------------------------------------------------------response

spec/parsers/locale_key_spec.cr

@@ -0,0 +1,11 @@
+require "../spec_helper"
+
+describe "Locale" do
+  subject locale_key
+
+  expect_ignore "comp"
+  expect_ignore "asd"
+  expect_ignore ":"
+
+  expect_ok ":ui.button.ok"
+end

spec/parsers/locale_spec.cr

@@ -0,0 +1,16 @@
+require "../spec_helper"
+
+describe "Locale" do
+  subject locale
+
+  expect_ignore "comp"
+  expect_ignore "asd"
+
+  expect_error "locale", Mint::Parser::LocaleExpectedLanguage
+  expect_error "locale{", Mint::Parser::LocaleExpectedLanguage
+  expect_error "locale ", Mint::Parser::LocaleExpectedLanguage
+  expect_error "locale en", Mint::Parser::LocaleExpectedOpeningBracket
+  expect_error "locale en {", Mint::Parser::LocaleExpectedClosingBracket
+
+  expect_ok "locale en { a: \"\" }"
+end

spec/type_checking/locale_key

@@ -0,0 +1,43 @@
+locale en {
+  test: ""
+}
+
+component Main {
+  fun render : String {
+    :test
+  }
+}
+-------------------------------------------------------------TranslationMissing
+component Main {
+  fun render : String {
+    :test
+  }
+}
+-------------------------------------------------------TranslationNotTranslated
+locale en {
+  test: ""
+}
+
+locale hu {
+
+}
+
+component Main {
+  fun render : String {
+    :test
+  }
+}
+------------------------------------------------------------TranslationMismatch
+locale en {
+  test: ""
+}
+
+locale hu {
+  test: 0
+}
+
+component Main {
+  fun render : String {
+    :test
+  }
+}

src/all.cr

@@ -57,6 +57,8 @@ require "./documentation_generator/**"
 require "./documentation_generator"
 require "./documentation_server"
 
+require "./semantic_tokenizer"
+
 require "./test_runner/**"
 require "./test_runner"
 

src/ast.cr

@@ -30,15 +30,21 @@ module Mint
                        If |
                        Js
 
-    getter components, modules, records, stores, routes, providers
-    getter suites, enums, comments, nodes, unified_modules
+    getter components, modules, records, stores, routes, providers, operators
+    getter suites, enums, comments, nodes, keywords, locales
 
-    def initialize(@records = [] of RecordDefinition,
+    getter unified_modules, unified_locales
+
+    def initialize(@operators = [] of Tuple(Int32, Int32),
+                   @keywords = [] of Tuple(Int32, Int32),
+                   @records = [] of RecordDefinition,
                    @unified_modules = [] of Module,
+                   @unified_locales = [] of Locale,
                    @components = [] of Component,
                    @providers = [] of Provider,
                    @comments = [] of Comment,
                    @modules = [] of Module,
+                   @locales = [] of Locale,
                    @routes = [] of Routes,
                    @suites = [] of Suite,
                    @stores = [] of Store,
@@ -74,6 +80,7 @@ module Mint
       @comments.concat ast.comments
       @modules.concat ast.modules
       @records.concat ast.records
+      @locales.concat ast.locales
       @stores.concat ast.stores
       @routes.concat ast.routes
       @suites.concat ast.suites
@@ -108,6 +115,18 @@ module Mint
             )
           end
 
+      @unified_locales =
+        @locales
+          .group_by(&.language)
+          .map do |_, locales|
+            Locale.new(
+              input: Data.new(input: "", file: ""),
+              fields: locales.flat_map(&.fields),
+              language: locales.first.language,
+              comment: nil,
+              from: 0,
+              to: 0)
+          end
       self
     end
   end

src/ast/component.cr

@@ -3,7 +3,8 @@ module Mint
     class Component < Node
       getter properties, connects, styles, states, comments
       getter functions, gets, uses, name, comment, refs, constants
-      getter? global
+
+      getter? global, locales
 
       def initialize(@refs : Array(Tuple(Variable, Node)),
                      @properties : Array(Property),
@@ -16,6 +17,7 @@ module Mint
                      @comment : Comment?,
                      @gets : Array(Get),
                      @uses : Array(Use),
+                     @locales : Bool,
                      @global : Bool,
                      @name : TypeId,
                      @input : Data,

src/ast/directives/highlight.cr

@@ -0,0 +1,15 @@
+module Mint
+  class Ast
+    module Directives
+      class Highlight < Node
+        getter content
+
+        def initialize(@content : Block,
+                       @input : Data,
+                       @from : Int32,
+                       @to : Int32)
+        end
+      end
+    end
+  end
+end