feat: new config "keystyle"

Author: antfu

package.json

@@ -233,6 +233,16 @@
         "vue-i18n-ally.ignoredLocales": {
           "type": "array",
           "description": "%config.ignored_locales%"
+        },
+        "vue-i18n-ally.keystyle": {
+          "type": "string",
+          "enum": [
+            "auto",
+            "nested",
+            "flat"
+          ],
+          "default": "auto",
+          "description": "%config.keystyle%"
         }
       }
     }

package.nls.json

@@ -22,6 +22,7 @@
   "config.source_language": "Source language for machine translation",
   "config.display_language": "Displaying language",
   "config.ignored_locales": "Locale codes to be ingored",
+  "config.keystyle": "Locale key style",
   "misc.not_exists": "🔴Not exist",
   "refactor.extract_text": "Extract text to vue-i18n locales",
   "prompt.config_locales_auto_success": "Locales path auto set to \"{0}\".",
@@ -41,5 +42,10 @@
   "prompt.translation_saved": "Translation saved.",
   "prompt.failed_to_locale_key": "Failed to locale key \"{0}\".",
   "prompt.edit_key_in_locale": "{1} | Editing key \"{0}\"",
-  "prompt.enter_new_keypath": "Enter the new keypath"
+  "prompt.enter_new_keypath": "Enter the new keypath",
+  "prompt.keystyle_flat": "Flat style",
+  "prompt.keystyle_flat_example": "for example: { \"a.b.c\": \"...\" }",
+  "prompt.keystyle_nested": "Nested style",
+  "prompt.keystyle_nested_example": "for example: { \"a\": { \"b\": { \"c\": \"...\" } } }",
+  "prompt.keystyle_select": "Which kind of key style do you use to organize your locales?"
 }

src/core/Errors.ts

@@ -3,7 +3,8 @@ export enum ErrorType {
   translating_unknown_error,
   translating_empty_source_value,
   filepath_not_specified,
-  unsupported_file_type
+  unsupported_file_type,
+  keystyle_not_set
 }
 
 export class AllyError extends Error {

src/core/Global.ts

@@ -7,8 +7,10 @@ import { YamlParser } from '../parsers/YamlParser'
 import { JavascriptParser } from '../parsers/JavascriptParser'
 import { ConfigLocalesGuide } from '../commands/configLocales'
 import { extname } from 'path'
+import i18n from '../i18n'
 
 const configPrefix = 'vue-i18n-ally'
+export type KeyStyle = 'auto' | 'nested' | 'flat'
 
 export class Global {
   private static _loaders: Record<string, LocaleLoader> = {}
@@ -190,6 +192,38 @@ export class Global {
     this._onDidChangeLoader.fire(this.loader)
   }
 
+  static get keyStyle (): KeyStyle {
+    return (Global.getConfig('keystyle') || 'auto') as KeyStyle
+  }
+
+  static set keyStyle (value: KeyStyle) {
+    Global.setConfig('keystyle', value, false)
+  }
+
+  static async requestKeyStyle (): Promise<KeyStyle | undefined> {
+    if (this.keyStyle !== 'auto')
+      return this.keyStyle
+
+    const result = await window.showQuickPick([{
+      value: 'nested',
+      label: i18n.t('prompt.keystyle_nested'),
+      description: i18n.t('prompt.keystyle_nested_example'),
+    }, {
+      value: 'flat',
+      label: i18n.t('prompt.keystyle_flat'),
+      description: i18n.t('prompt.keystyle_flat_example'),
+    }], {
+      placeHolder: i18n.t('prompt.keystyle_select'),
+    })
+
+    if (!result) {
+      this.keyStyle = 'nested'
+      return 'nested'
+    }
+    this.keyStyle = result.value as KeyStyle
+    return result.value as KeyStyle
+  }
+
   static toggleLocaleVisibility (locale: string, visible?: boolean) {
     const ignored = this.ignoredLocales
     if (visible == null)

src/core/LocaleLoader.ts

@@ -303,11 +303,15 @@ export class LocaleLoader extends Disposable {
     if (!parser)
       throw new AllyError(ErrorType.unsupported_file_type, ext)
 
-    let original: object = {}
+    let original: any = {}
     if (existsSync(filepath))
       original = await parser.load(filepath)
 
-    _.set(original, pending.keypath, pending.value)
+    const keyStyle = await Global.requestKeyStyle()
+    if (keyStyle === 'flat')
+      original[pending.keypath] = pending.value
+    else
+      _.set(original, pending.keypath, pending.value)
 
     await parser.save(filepath, original)
   }