refactor: move handleFlatJSON to vue-i18n-core/composer from core-base/resolver

Author: kazupon

packages/core-base/src/resolver.ts

@@ -1,4 +1,4 @@
-import { isObject, hasOwn } from '@intlify/shared'
+import { isObject } from '@intlify/shared'
 
 /** @VueI18nGeneral */
 export type Path = string
@@ -354,50 +354,3 @@ export function resolveValue(obj: unknown, path: Path): PathValue {
 
   return last
 }
-
-/**
- * Transform flat json in obj to normal json in obj
- */
-export function handleFlatJson(obj: unknown): unknown {
-  // check obj
-  if (!isObject(obj)) {
-    return obj
-  }
-
-  for (const key in obj as object) {
-    // check key
-    if (!hasOwn(obj, key)) {
-      continue
-    }
-
-    // handle for normal json
-    if (!key.includes(PathCharTypes.DOT)) {
-      // recursive process value if value is also a object
-      if (isObject(obj[key])) {
-        handleFlatJson(obj[key])
-      }
-    }
-    // handle for flat json, transform to normal json
-    else {
-      // go to the last object
-      const subKeys = key.split(PathCharTypes.DOT)
-      const lastIndex = subKeys.length - 1
-      let currentObj = obj
-      for (let i = 0; i < lastIndex; i++) {
-        if (!(subKeys[i] in currentObj)) {
-          currentObj[subKeys[i]] = {}
-        }
-        currentObj = currentObj[subKeys[i]]
-      }
-      // update last object value, delete old property
-      currentObj[subKeys[lastIndex]] = obj[key]
-      delete obj[key]
-      // recursive process value if value is also a object
-      if (isObject(currentObj[subKeys[lastIndex]])) {
-        handleFlatJson(currentObj[subKeys[lastIndex]])
-      }
-    }
-  }
-
-  return obj
-}

packages/core-base/test/resolver.test.ts

@@ -1,4 +1,4 @@
-import { parse, resolveValue, handleFlatJson } from '../src/resolver'
+import { parse, resolveValue } from '../src/resolver'
 
 test('parse', () => {
   expect(parse('a')).toEqual(['a'])
@@ -121,29 +121,3 @@ test('resolveValue', () => {
   // blanket middle
   expect(resolveValue({}, 'a.b.c[]d')).toEqual(null)
 })
-
-test('handleFlatJson', () => {
-  const obj = {
-    a: { a1: 'a1.value' },
-    'a.a2': 'a.a2.value',
-    'b.x': {
-      'b1.x': 'b1.x.value',
-      'b2.x': ['b2.x.value0', 'b2.x.value1'],
-      'b3.x': { 'b3.x': 'b3.x.value' }
-    }
-  }
-  const expectObj = {
-    a: {
-      a1: 'a1.value',
-      a2: 'a.a2.value'
-    },
-    b: {
-      x: {
-        b1: { x: 'b1.x.value' },
-        b2: { x: ['b2.x.value0', 'b2.x.value1'] },
-        b3: { x: { b3: { x: 'b3.x.value' } } }
-      }
-    }
-  }
-  expect(handleFlatJson(obj)).toEqual(expectObj)
-})

packages/vue-i18n-core/src/composer.ts

@@ -36,7 +36,6 @@ import {
   clearNumberFormat,
   fallbackWithLocaleChain,
   NOT_REOSLVED,
-  handleFlatJson,
   MessageFunction,
   setAdditionalMeta,
   DEFAULT_LOCALE
@@ -1716,6 +1715,53 @@ type GetLocaleMessagesOptions<Messages = {}> = {
   flatJson?: boolean
 }
 
+/**
+ * Transform flat json in obj to normal json in obj
+ */
+export function handleFlatJson(obj: unknown): unknown {
+  // check obj
+  if (!isObject(obj)) {
+    return obj
+  }
+
+  for (const key in obj as object) {
+    // check key
+    if (!hasOwn(obj, key)) {
+      continue
+    }
+
+    // handle for normal json
+    if (!key.includes('.')) {
+      // recursive process value if value is also a object
+      if (isObject(obj[key])) {
+        handleFlatJson(obj[key])
+      }
+    }
+    // handle for flat json, transform to normal json
+    else {
+      // go to the last object
+      const subKeys = key.split('.')
+      const lastIndex = subKeys.length - 1
+      let currentObj = obj
+      for (let i = 0; i < lastIndex; i++) {
+        if (!(subKeys[i] in currentObj)) {
+          currentObj[subKeys[i]] = {}
+        }
+        currentObj = currentObj[subKeys[i]]
+      }
+      // update last object value, delete old property
+      currentObj[subKeys[lastIndex]] = obj[key]
+      delete obj[key]
+      // recursive process value if value is also a object
+      if (isObject(currentObj[subKeys[lastIndex]])) {
+        handleFlatJson(currentObj[subKeys[lastIndex]])
+      }
+    }
+  }
+
+  return obj
+}
+
 export function getLocaleMessages<Messages = {}>(
   locale: Locale,
   options: GetLocaleMessagesOptions<Messages>

packages/vue-i18n-core/test/composer.test.ts

@@ -12,7 +12,8 @@ import {
   createComposer,
   MissingHandler,
   ComposerOptions,
-  VueMessageType
+  VueMessageType,
+  handleFlatJson
 } from '../src/composer'
 import {
   TransrateVNodeSymbol,
@@ -1699,4 +1700,30 @@ describe('root', () => {
   })
 })
 
+test('handleFlatJson', () => {
+  const obj = {
+    a: { a1: 'a1.value' },
+    'a.a2': 'a.a2.value',
+    'b.x': {
+      'b1.x': 'b1.x.value',
+      'b2.x': ['b2.x.value0', 'b2.x.value1'],
+      'b3.x': { 'b3.x': 'b3.x.value' }
+    }
+  }
+  const expectObj = {
+    a: {
+      a1: 'a1.value',
+      a2: 'a.a2.value'
+    },
+    b: {
+      x: {
+        b1: { x: 'b1.x.value' },
+        b2: { x: ['b2.x.value0', 'b2.x.value1'] },
+        b3: { x: { b3: { x: 'b3.x.value' } } }
+      }
+    }
+  }
+  expect(handleFlatJson(obj)).toEqual(expectObj)
+})
+
 /* eslint-enable @typescript-eslint/no-empty-function, @typescript-eslint/no-explicit-any */