refactor: flat option of diff API (#185)

* fix: change the return value of the diff API to an object

* feat: add the normalize option to the diff API.

* fix: diffInfo type definition

* fix: types of return value of diff API

* fix: return value of diff

* fix: delete warning of eslint

* fix: flat option of diff API

* fix: unit test of returnDiff

* refactor: delete unused test

Author: shota-kizawa

src/utils.ts

@@ -472,9 +472,12 @@ export async function returnDiff (options: DiffOptions): Promise<DiffInfo> {
 
   if (ret) {
     if (options.normalize === 'flat') {
-      const flattenedServiceMessages = flatten(serviceMessages)
-      const flattenedlocaleMessages = flatten(localeMessages)
-      const flattenedDiffObj = jsonDiff.diff(flattenedServiceMessages, flattenedlocaleMessages)
+      const flattenedDiffObj = {} as Record<Locale, Record<string, string>>
+      for (const locale in serviceMessages) {
+        flattenedDiffObj[locale] = jsonDiff.diff(
+          flatten(serviceMessages[locale]), flatten(localeMessages[locale])
+        )
+      }
       return Promise.resolve(flattenedDiffObj)
     }
     if (options.normalize === 'hierarchy') {

test/__snapshots__/utils.test.ts.snap

@@ -73,6 +73,32 @@ Object {
 }
 `;
 
+exports[`returnDiff: no normalize 1`] = `
+Object {
+  "en": Object {
+    "hello": Object {
+      "__new": "world",
+      "__old": "hello!",
+    },
+    "nest__deleted": Object {
+      "world": "world!",
+    },
+  },
+}
+`;
+
+exports[`returnDiff: normalize=flat 1`] = `
+Object {
+  "en": Object {
+    "hello": Object {
+      "__new": "world",
+      "__old": "hello!",
+    },
+    "nest.world__deleted": "world!",
+  },
+}
+`;
+
 exports[`splitLocaleMessages: basic usage 1`] = `
 Object {
   "navigation": Object {

test/utils.test.ts

@@ -10,7 +10,8 @@ import {
   reflectSFCDescriptor,
   getTranslationStatus,
   getExternalLocaleMessages,
-  splitLocaleMessages
+  splitLocaleMessages,
+  returnDiff
 } from '../src/utils'
 
 import ignore from 'ignore'
@@ -20,9 +21,10 @@ import ignore from 'ignore'
 
 // l10n service provider module
 const mockStatus = jest.fn()
+const mockPull = jest.fn()
 jest.mock('@scope/l10n-service-provider', () => {
   return jest.fn().mockImplementation(() => {
-    return { status: mockStatus }
+    return { status: mockStatus, pull: mockPull }
   })
 })
 import L10nServiceProvider from '@scope/l10n-service-provider'
@@ -136,3 +138,40 @@ test('splitLocaleMessages: no namespace', async () => {
   expect(sfc).toEqual(messages)
   expect(external).toBeUndefined()
 })
+
+test('returnDiff: no normalize', async() => {
+  mockPull.mockImplementation(() => Promise.resolve({
+    en: {
+      hello: 'hello!',
+      nest: {
+        world: 'world!'
+      }
+    }
+  }))
+  const diffMsg = await returnDiff({
+    provider: '@scope/l10n-service-provider',
+    conf: './test/fixtures/conf/l10n-service-provider-conf.json',
+    format: 'json',
+    target: './test/fixtures/locales/en.json'
+  })
+  expect(diffMsg).toMatchSnapshot()
+})
+
+test('returnDiff: normalize=flat', async() => {
+  mockPull.mockImplementation(() => Promise.resolve({
+    en: {
+      hello: 'hello!',
+      nest: {
+        world: 'world!'
+      }
+    }
+  }))
+  const diffMsg = await returnDiff({
+    provider: '@scope/l10n-service-provider',
+    conf: './test/fixtures/conf/l10n-service-provider-conf.json',
+    format: 'json',
+    target: './test/fixtures/locales/en.json',
+    normalize: 'flat'
+  })
+  expect(diffMsg).toMatchSnapshot()
+})

types/index.d.ts

@@ -224,7 +224,7 @@ export type DiffOptions = {
   normalize?: string
 } & PushableOptions
 
-export type DiffInfo = Record<string, any>
+export type DiffInfo = Record<Locale, Record<string, any>>
 
 declare function diff (options: DiffOptions): Promise<DiffInfo>