* fix issue #30

long1eu · long1eu · commit 97cecd8a9a96 · 2018-12-14T13:20:04.000+02:00
* add string key inspection
diff --git a/README.md b/README.md
@@ -75,8 +75,6 @@ Flutter internalization only depends on a small subset of the ARB format. Each .
 
 <b>The first English file is generated for you(/res/values/strings_en.arb).</b> Every arb file depends on this one. If you have an a string in the German arb file(/res/values/strings_de.arb) that has an ID that is <b>not found</b> in the English file, it would not be listed. So you must be sure to first have the strings in the English file and then add other translations.
 
-Do not add white spaces or illegal characters in your IDs. They should match this RegEx <b>[a-zA-Z]</b> <span style="color: rgb(0, 0, 0); font-family: &quot;Source Sans Pro&quot;, &quot;Helvetica Neue&quot;, Helvetica, Arial, sans-serif; font-size: 16px; font-style: normal; font-variant-ligatures: normal; font-variant-caps: normal; font-weight: normal; letter-spacing: normal; orphans: 2; text-align: left; text-indent: 0px; text-transform: none; white-space: normal; widows: 2; word-spacing: 0px; -webkit-text-stroke-width: 0px; background-color: rgb(255, 255, 255); text-decoration-style: initial; text-decoration-color: initial; display: inline !important; float: none;">for now</span>. The IDE doesn't worn you if your ID doesn't match.
-
 To add a new arb file right click on <b>values</b> folder and select <b>New</b> -><b> Arb </b><b>File</b>. Then pick your language from the list, and region if necessary.
 
 #### 1. Referencing the values
@@ -105,7 +103,7 @@ The value for this resource ID is retrieved with a parametrized method instead o
 
 #### 3. Plurals
 
-Plural translations can be provided for several quantities: 0, 1, 2, "few", "many", "other". The variations are identified by a resource ID suffix which must be one of "Zero", "One", "Two", "Few", "Many", "Other". The "Other" variation is used when none of the other quantities apply. All plural resources must include a resource with the "Other" suffix. For example the English translations ('material_en.arb') for selectedRowCountTitle in the [Material Library Localizations](https://github.com/flutter/flutter/tree/master/packages/flutter_localizations/lib/src/l10n) are:
+Plural translations can be provided for several quantities: 0, 1, 2, "few", "many", "other". The variations are identified by a resource ID suffix which must be one of "Zero", "One", "Two", "Few", "Many", "Other" (case insensitive). The "Other" variation is used when none of the other quantities apply. All plural resources must include a resource with the "Other" suffix. For example the English translations ('material_en.arb') for selectedRowCountTitle in the [Material Library Localizations](https://github.com/flutter/flutter/tree/master/packages/flutter_localizations/lib/src/l10n) are:
 
     {
         "selectedRowCountTitleZero": "No items selected",
@@ -126,6 +124,24 @@ or
 
 <pre>S.of(context).selectedRowCountTitle("$selectedRowCount")</pre>
 
+### NOTES:
+* The plugin also supports `${variable}` notation. Use this when the parser does not catch the parameters properly. For example:
+    ```json
+    {"tabLabel": "탭 $tabCount개 중 $tabIndex번째"}
+    ```
+    will generate 
+    ```dart
+    String tabLabel(String tabCount개, String tabIndex번째) => "탭 $tabCount개 중 $tabIndex번째";
+    ```
+    Witch contains invalid Dart fields. In this case you should use 
+    ```json
+    {"tabLabel": "탭 ${tabCount}개 중 ${tabIndex}번째"}
+    ```
+
+* Also you can escape the `$` sign with `\` 
+    ```json
+    {"checkout_message": "You have to pay \$$price"}
+    ```
 # Issues
 
 There are some performance improvements and bug fixes that this plugin could use, so feel free to PR.
diff --git a/build.gradle b/build.gradle
@@ -4,7 +4,7 @@ plugins {
 }
 
 group 'eu.long1.flutter'
-version '0.1.1'
+version '0.2.1'
 
 repositories {
     mavenCentral()
diff --git a/src/main/kotlin/eu/long1/flutter/i18n/inspections/JsonKeysInspector.kt b/src/main/kotlin/eu/long1/flutter/i18n/inspections/JsonKeysInspector.kt
@@ -7,31 +7,33 @@ import com.intellij.codeInspection.ex.BaseLocalInspectionTool
 import com.intellij.json.psi.JsonProperty
 import com.intellij.json.psi.JsonStringLiteral
 import com.intellij.psi.PsiFile
-import com.intellij.psi.util.PsiTreeUtil
 import eu.long1.flutter.i18n.arb.ArbFileType
 
 class JsonKeysInspector : BaseLocalInspectionTool() {
 
     override fun checkFile(file: PsiFile, manager: InspectionManager, isOnTheFly: Boolean): Array<ProblemDescriptor>? {
         if (!isOnTheFly) return null
         if (file.fileType == ArbFileType) {
-            return PsiTreeUtil.findChildrenOfType(file, JsonProperty::class.java).mapNotNull {
-                val key = (it.nameElement as JsonStringLiteral).value
-                if (!keyPattern.containsMatchIn(key)) {
-                    manager.createProblemDescriptor(
-                        it.nameElement,
-                        displayName,
-                        isOnTheFly,
-                        null,
-                        ProblemHighlightType.GENERIC_ERROR
-                    )
-                } else null
-            }.toTypedArray()
+            return file.children.first().children.filterIsInstance<JsonProperty>()
+                .filter { !it.name.startsWith("@") }
+                .mapNotNull {
+                    val key = (it.nameElement as JsonStringLiteral).value
+
+                    if (!key.startsWith('@') && !keyPattern.containsMatchIn(key)) {
+                        manager.createProblemDescriptor(
+                            it.nameElement,
+                            displayName,
+                            isOnTheFly,
+                            null,
+                            ProblemHighlightType.GENERIC_ERROR
+                        )
+                    } else null
+                }.toTypedArray()
         }
         return null
     }
 
-    override fun getDisplayName(): String = "The string key must be a valid Dart field name."
+    override fun getDisplayName(): String = "The string key can start with a letter or underscore (_), followed by any combination of those characters plus digits."
 
     override fun getGroupDisplayName(): String = "Flutter I18n"
 
diff --git a/src/main/kotlin/eu/long1/flutter/i18n/workers/I18nFileGenerator.kt b/src/main/kotlin/eu/long1/flutter/i18n/workers/I18nFileGenerator.kt
@@ -16,6 +16,7 @@ import eu.long1.flutter.i18n.arb.ArbFileType
 import eu.long1.flutter.i18n.files.FileHelpers
 import java.util.regex.Pattern
 
+
 class I18nFileGenerator(private val project: Project) {
 
     private val psiManager = PsiManager.getInstance(project)
@@ -37,10 +38,12 @@ class I18nFileGenerator(private val project: Project) {
         val builder = StringBuilder()
         builder.append(i18nFileImports)
         builder.append("// ignore_for_file: non_constant_identifier_names\n// ignore_for_file: camel_case_types\n// ignore_for_file: prefer_single_quotes\n\n")
+        builder.append("//This file is automatically generated. DO NOT EDIT, all your changes would be lost.\n")
         appendSClass(data["en"]!!, builder)
 
+        val className = "\$en"
         data.keys.forEach {
-            if (it == "en") builder.append("class en extends S {\n  const en();\n}\n\n")
+            if (it == "en") builder.append("class $className extends S {\n  const $className();\n}\n\n")
             else appendLangClass(it, data, builder)
         }
 
@@ -100,12 +103,11 @@ class I18nFileGenerator(private val project: Project) {
         ids -= parametrized
 
 
-        builder.append(
-            "class $lang extends S {\n" +
-            "  const $lang();\n\n" +
+        var className = "\$$lang"
 
-            "  @override\n" +
-            "  TextDirection get textDirection => TextDirection.${if (rtl.contains(lang.split("_")[0])) "rtl" else "ltr"};\n\n"
+        builder.append(
+            "class $className extends S {\n  const $className();\n\n  " +
+                    "@override\n  TextDirection get textDirection => TextDirection.${if (rtl.contains(lang.split("_")[0])) "rtl" else "ltr"};\n\n"
         )
 
         ids.forEach { appendStringMethod(it, langMap[it]!!, builder) }
@@ -116,13 +118,10 @@ class I18nFileGenerator(private val project: Project) {
 
         //for hebrew iw=he
         if (lang.startsWith("iw")) {
+            className = "\$he_IL"
             builder.append(
-                "class he_IL extends $lang {\n" +
-                "  const he_IL();\n\n" +
-
-                "  @override\n" +
-                "  TextDirection get textDirection => TextDirection.rtl;\n" +
-                "}"
+                "class $className extends \$$lang {\n const $className();\n\n   " +
+                        "@override\n  TextDirection get textDirection => TextDirection.rtl;\n\n}"
             )
         }
     }
@@ -143,18 +142,13 @@ class I18nFileGenerator(private val project: Project) {
 
         builder.append(delegateClassResolution)
         map.keys.forEach {
+
+
             //for hebrew iw=he
             if (it.startsWith("iw")) {
-                builder.append(
-                    "        case \"iw_IL\":\n" +
-                    "        case \"he_IL\":\n" +
-                    "          return SynchronousFuture<S>(const he_IL());\n"
-                )
+                builder.append("        case \"iw_IL\":\n      case \"he_IL\":\n          return SynchronousFuture<S>(const \$he_IL());\n")
             } else {
-                builder.append(
-                    "        case \"$it\":\n" +
-                    "          return SynchronousFuture<S>(const $it());\n"
-                )
+                builder.append("        case \"$it\":\n          return SynchronousFuture<S>(const \$$it());\n")
             }
         }
 
@@ -206,6 +200,7 @@ class I18nFileGenerator(private val project: Project) {
         id: String, countsList: ArrayList<String>, valuesMap: HashMap<String, String>,
         builder: StringBuilder, isOverride: Boolean = true
     ) {
+
         val zero = countsList.contains("zero")
         val one = countsList.contains("one")
         val two = countsList.contains("two")
@@ -214,10 +209,13 @@ class I18nFileGenerator(private val project: Project) {
 
 
         val otherValue = valuesMap["${id}Other"] ?: valuesMap["${id}other"] ?: return
-        val parameterName: String = {
-            PARAMETER_MATCHER.reset(otherValue).find()
-            normalizeParameter(PARAMETER_MATCHER.group())
-        }()
+        val parameterName: String =
+            if (PARAMETER_MATCHER.reset(otherValue).find()) {
+                normalizeParameter(PARAMETER_MATCHER.group())
+            } else {
+                "param"
+            }
+
 
         if (isOverride) {
             builder.append("  @override\n")
@@ -321,27 +319,23 @@ class I18nFileGenerator(private val project: Project) {
     private fun getStringFromFile(file: PsiFile): HashMap<String, String>? {
         if (PsiTreeUtil.findChildOfType(file, PsiErrorElement::class.java) != null) return null
         val langMap = HashMap<String, String>()
-        PsiTreeUtil.findChildrenOfType(file, JsonProperty::class.java).forEach {
-            langMap[it.name] = it.value?.text!!.drop(1).dropLast(1)
-        }
+
+        file.children.first().children.filterIsInstance<JsonProperty>()
+            .filter { !it.name.startsWith("@") }
+            .forEach { langMap[it.name] = it.value?.text!!.drop(1).dropLast(1) }
         return langMap
     }
 
     companion object {
         private val PARAMETER_MATCHER =
             Pattern.compile(
-                "(?<!\\\\)\\$\\{?[^}\\p{Punct}\\p{Space}\\p{sc=Han}\\p{sc=Hiragana}\\p{sc=Katakana}–]*}?"
+                "(?<!\\\\)\\\$\\{?(.+?]*\\b)}?"
             )
-            .matcher("")
+                .matcher("")
 
         // @formatter:off
         private const val i18nFileImports =
-            """/////////////////////////////////////////////////////////////
-// AUTO-GENERATED FILE – YOUR CHANGES WILL BE OVERWRITTEN! //
-// PLUGIN WEBSITE: https://github.com/long1eu/flutter_i18n //
-/////////////////////////////////////////////////////////////
-
-import 'dart:async';
+            """import 'dart:async';
 
 import 'package:flutter/foundation.dart';
 import 'package:flutter/material.dart';
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -1,7 +1,7 @@
 <idea-plugin>
     <id>FlutterI18n</id>
     <name>Flutter i18n</name>
-    <version>0.1.3</version>
+    <version>0.2.1</version>
     <vendor email="home@long1.eu">long1eu</vendor>
     <depends>com.intellij.modules.json</depends>
     <depends>com.intellij.modules.lang</depends>
@@ -14,7 +14,15 @@
     </description>
 
     <change-notes><![CDATA[
-    <p><strong><span style="font-size: 18px;">0.1.3 - 2018.3</span></strong></p>
+    <p><strong><span style="font-size: 18px;">0.2</span></strong></p>
+    <ul>
+    <li><b>Braking change</b> - Lang classes are prefixed by $ sign. If you user them directly you should update them or use `S.of(context)`</li>
+    <li>fix icelandic class</li>
+    <li>add arb key checker, now the IDE will raise an error if you try to set an illegal key</li>
+    <li>escape parameter in form of ${variable}</li>
+    </ul>
+
+    <p><strong><span style="font-size: 18px;">0.1.1 - 2018.1</span></strong></p>
     <ul>
     <li>fix plurals searching</li>
     </ul>
@@ -76,7 +84,7 @@
     </change-notes>
 
 
-    <idea-version since-build="183" until-build="183.*"/>
+    <idea-version since-build="181" until-build="181.*"/>
 
     <extensions defaultExtensionNs="com.intellij">
         <postStartupActivity implementation="eu.long1.flutter.i18n.workers.Initializer"/>

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ plugins {`
`4`	`4`	`}`
`5`	`5`
`6`	`6`	`group 'eu.long1.flutter'`
`7`		`-version '0.1.1'`
	`7`	`+version '0.2.1'`
`8`	`8`
`9`	`9`	`repositories {`
`10`	`10`	`mavenCentral()`