feat: add the normalize option to the diff API. (#183)

* 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

Author: shota-kizawa

src/commands/diff.ts

@@ -1,7 +1,7 @@
 import { Arguments, Argv } from 'yargs'
 import { DiffError, fail } from './fails/diff'
 
-import { isDifferent } from '../utils'
+import { returnDiff } from '../utils'
 
 import { PushableOptions } from '../../types'
 
@@ -60,7 +60,7 @@ export const handler = async (args: Arguments<DiffOptions>): Promise<unknown> =>
   const { provider, conf, normalize, target, locale, targetPaths, filenameMatch } = args
 
   try {
-    const ret = await isDifferent({
+    const ret = await returnDiff({
       provider, conf, normalize, target, locale, targetPaths, filenameMatch
     })
 
@@ -69,7 +69,6 @@ export const handler = async (args: Arguments<DiffOptions>): Promise<unknown> =>
     }
     return Promise.resolve()
   } catch (e) {
-    console.error(e.message)
     return Promise.reject(e)
   }
 }

src/index.ts

@@ -2,7 +2,7 @@ import squeeze from './squeezer'
 import infuse from './infuser'
 import {
   getTranslationStatus as status,
-  isDifferent as diff,
+  returnDiff as diff,
   pushFunc as push
 } from './utils'
 

src/utils.ts

@@ -18,8 +18,8 @@ import {
   NamespaceDictionary,
   PushableOptions,
   DiffOptions,
-  PushOptions,
-  diffInfo
+  DiffInfo,
+  PushOptions
 } from '../types'
 
 // import modules
@@ -34,6 +34,7 @@ import deepmerge from 'deepmerge'
 import { promisify } from 'util'
 import type { Ignore } from 'ignore'
 import querystring from 'query-string'
+import { flatten, unflatten } from 'flat'
 const jsonDiff = require('json-diff') // NOTE: not provided type definition ...
 
 import { debug as Debug } from 'debug'
@@ -451,7 +452,7 @@ export function returnIgnoreInstance (ig: Ignore, ignoreFiles: string[]): void {
   })
 }
 
-export async function isDifferent (options: DiffOptions): Promise<diffInfo> {
+export async function returnDiff (options: DiffOptions): Promise<DiffInfo> {
   const format = 'json'
   const ProviderFactory = loadProvider(options.provider)
 
@@ -477,6 +478,18 @@ export async function isDifferent (options: DiffOptions): Promise<diffInfo> {
   console.log(ret)
 
   if (ret) {
+    if (options.normalize === 'flat') {
+      const flattenedServiceMessages = flatten(serviceMessages)
+      const flattenedlocaleMessages = flatten(localeMessages)
+      const flattenedDiffObj = jsonDiff.diff(flattenedServiceMessages, flattenedlocaleMessages)
+      return Promise.resolve(flattenedDiffObj)
+    }
+    if (options.normalize === 'hierarchy') {
+      const unflattenedServiceMessages = unflatten(serviceMessages, { object: true })
+      const unflattenedlocaleMessages = unflatten(localeMessages, { object: true })
+      const unflattenedDiffObj = jsonDiff.diff(unflattenedServiceMessages, unflattenedlocaleMessages)
+      return Promise.resolve(unflattenedDiffObj)
+    }
     const diffObj = jsonDiff.diff(serviceMessages, localeMessages)
     return Promise.resolve(diffObj)
   } else {

types/index.d.ts

@@ -224,12 +224,9 @@ export type DiffOptions = {
   normalize?: string
 } & PushableOptions
 
-export type diffInfo = {
-  __old?: any
-  __new?: any
-}
+export type DiffInfo = Record<string, any>
 
-declare function diff (options: DiffOptions): Promise<diffInfo>
+declare function diff (options: DiffOptions): Promise<DiffInfo>
 
 /**
  *  Provider factory function