Merge branch 'master' of https://github.com/nyavro/i18nPlugin

nyavro · Aug 6, 2020 · 48f62cc · 48f62cc
2 parents 81497d0 + d376045
commit 48f62cc
Show file tree

Hide file tree

Showing 21 changed files with 195 additions and 70 deletions.
diff --git a/README.md b/README.md
@@ -13,7 +13,7 @@
 Intellij idea i18next support plugin
 
 ## Features
- ### Annotations
+   ### Annotations
 
 -   Annotates correct i18n keys:
 
@@ -36,12 +36,31 @@ Intellij idea i18next support plugin
     ![Reference to plural value](docs/img/p5.png)
 
 
- ### Navigation
+    ### Navigation
 
 -   I18nPlugin provides navigation from key to its declaration in Json resource    
 
-    ![Reference to plural value](docs/img/p6.png)
+    ![Navigation from key to translation](docs/img/p6.png)
 
 -   and to partially resolved keys:
 
-    ![Reference to plural value](docs/img/p7.png)
+    ![Navigation from partially resolved](docs/img/p7.png)
+
+   ### Hints
+
+-   In the case of a single translation matching to given key the translation displayed as a hint (Ctrl + hover):
+
+    ![Single translatin hint](docs/gif/translation-as-hint.gif)
+
+   ### Configuration options 
+   (File->Tools->I18n plugin configuration) 
+
+-   Default namespace
+
+    Configure up to 100 default namespace translation files. 
+    Multiple default namespaces separated by comma, semicolon or whitespace:
+
+        first;second third,fourth
+
+    will resolve translations in files first.json, second.json, third.json, fourth.json
+
diff --git a/docs/gif/translation-as-hint.gif b/docs/gif/translation-as-hint.gif
diff --git a/examples/simple/asset/en/sample.json b/examples/simple/asset/en/sample.json
@@ -2,6 +2,7 @@
   "ROOT": {
     "Key1": {
       "key2": "value1174",
+      "key21": "value1174",
       "key31": "vvv"
     },
     "Key41": "The answer is 41!"

diff --git a/examples/simple/src/Modules/Test.ts b/examples/simple/src/Modules/Test.ts
@@ -8,7 +8,7 @@ class Test {
     static render(unknownInCompileTime: string) {
         const i18n = new I18n();
 
-        console.log('sample:ROOT.Key1.key2');                                          //Simple case resolved
+        console.log('sample:ROOT.Key1.key21');                                          //Simple case resolved
         console.log('sample:missing.whole.composite.key');                              //Unresolved whole key
         console.log('sample:ROOT.missing.composite.key');                               //Unresolved part of the key
         console.log('MissingFile:Ex.Sub.Val');                                          //Unresolved File

diff --git a/examples/vue-i18n-files-simple/package-lock.json b/examples/vue-i18n-files-simple/package-lock.json
diff --git a/examples/vue-i18n-js-config-simple/package-lock.json b/examples/vue-i18n-js-config-simple/package-lock.json
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/completion/JsCompletionContributor.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/completion/JsCompletionContributor.kt
@@ -2,4 +2,7 @@ package com.eny.i18n.plugin.ide.completion
 
 import com.eny.i18n.plugin.language.js.JsCallContext
 
+/**
+ * Completion contributor for JS dialects
+ */
 class JsCompletionContributor: CompositeKeyCompletionContributor(JsCallContext())
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/completion/PhpCompletionContributor.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/completion/PhpCompletionContributor.kt
@@ -2,4 +2,7 @@ package com.eny.i18n.plugin.ide.completion
 
 import com.eny.i18n.plugin.language.php.PhpCallContext
 
+/**
+ * PHP Completion contributor
+ */
 class PhpCompletionContributor: CompositeKeyCompletionContributor(PhpCallContext())
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/completion/VueCompletionContributor.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/completion/VueCompletionContributor.kt
@@ -2,4 +2,7 @@ package com.eny.i18n.plugin.ide.completion
 
 import com.eny.i18n.plugin.language.vue.VueCallContext
 
+/**
+ * Completion contributor for Vue
+ */
 class VueCompletionContributor: CompositeKeyCompletionContributor(VueCallContext())
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/hint/HintProvider.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/hint/HintProvider.kt
@@ -0,0 +1,13 @@
+package com.eny.i18n.plugin.ide.hint
+
+import com.eny.i18n.plugin.utils.unQuote
+import com.intellij.lang.documentation.DocumentationProvider
+import com.intellij.psi.PsiElement
+
+/**
+ * Shows key's translation as a hint.
+ * Works for very simple case only - when there is exactly one translation corresponding to key.
+ */
+class HintProvider : DocumentationProvider {
+    override fun getQuickNavigateInfo(element: PsiElement?, originalElement: PsiElement?): String? = element?.text?.unQuote()
+}
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/references/code/JsReferenceContributor.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/references/code/JsReferenceContributor.kt
@@ -2,4 +2,7 @@ package com.eny.i18n.plugin.ide.references.code
 
 import com.eny.i18n.plugin.language.js.JsReferenceAssistant
 
+/**
+ * JS dialect reference contributor
+ */
 class JsReferenceContributor: ReferenceContributorBase(JsReferenceAssistant())
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/references/code/PhpReferenceContributor.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/references/code/PhpReferenceContributor.kt
@@ -2,4 +2,7 @@ package com.eny.i18n.plugin.ide.references.code
 
 import com.eny.i18n.plugin.language.php.PhpReferenceAssistant
 
+/**
+ * PHP dialect reference contributor
+ */
 class PhpReferenceContributor: ReferenceContributorBase(PhpReferenceAssistant())
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/references/code/VueReferenceContributor.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/references/code/VueReferenceContributor.kt
@@ -2,4 +2,7 @@ package com.eny.i18n.plugin.ide.references.code
 
 import com.eny.i18n.plugin.language.vue.VueReferenceAssistant
 
+/**
+ * Vue dialect reference contributor
+ */
 class VueReferenceContributor: ReferenceContributorBase(VueReferenceAssistant())
diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/settings/Config.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/settings/Config.kt
@@ -5,6 +5,9 @@ import com.eny.i18n.plugin.utils.whenMatches
 import com.intellij.openapi.project.Project
 import com.intellij.psi.search.GlobalSearchScope
 
+/**
+ * Configuration holder
+ */
 data class Config (
     val searchInProjectOnly: Boolean = true,
     val nsSeparator: String = ":",
@@ -22,11 +25,18 @@ data class Config (
     val yamlContentGenerationEnabled: Boolean = true
 ) {
 
+    private val MAX_DEFAULT_NAMESPACES = 100
+
     /**
      * Gets list of default namespaces
      */
     fun defaultNamespaces(): List<String> =
-        defaultNs.whenMatches {it.isNotBlank()}.default(Config().defaultNs).split("[;|,\\s]".toRegex()).filter {it.isNotBlank()}
+        defaultNs
+            .whenMatches {it.isNotBlank()}
+            .default(Config().defaultNs)
+            .split("[;|,\\s]".toRegex())
+            .filter{it.isNotBlank()}
+            .take(MAX_DEFAULT_NAMESPACES)
 
     /**
      * Gets project's search scope

diff --git a/src/main/kotlin/com/eny/i18n/plugin/ide/settings/Settings.kt b/src/main/kotlin/com/eny/i18n/plugin/ide/settings/Settings.kt
@@ -51,6 +51,9 @@ class Settings : PersistentStateComponent<Settings> {
 
     internal var yamlContentGenerationEnabled = default.yamlContentGenerationEnabled
 
+    /**
+     * Returns plugin configuration
+     */
     fun config(): Config {
         if (ApplicationManager.getApplication().isHeadlessEnvironment) {
             synchronized(this) {