fix: change the return value of the diff API to an object (#181)

Author: shota-kizawa

src/commands/diff.ts

@@ -64,7 +64,7 @@ export const handler = async (args: Arguments<DiffOptions>): Promise<unknown> =>
       provider, conf, normalize, target, locale, targetPaths, filenameMatch
     })
 
-    if (ret) {
+    if (Object.keys(ret).length) {
       return Promise.reject(new DiffError('There are differences!'))
     }
     return Promise.resolve()

src/utils.ts

@@ -18,7 +18,8 @@ import {
   NamespaceDictionary,
   PushableOptions,
   DiffOptions,
-  PushOptions
+  PushOptions,
+  diffInfo
 } from '../types'
 
 // import modules
@@ -33,7 +34,7 @@ import deepmerge from 'deepmerge'
 import { promisify } from 'util'
 import type { Ignore } from 'ignore'
 import querystring from 'query-string'
-const { diffString } = require('json-diff') // NOTE: not provided type definition ...
+const jsonDiff = require('json-diff') // NOTE: not provided type definition ...
 
 import { debug as Debug } from 'debug'
 const debug = Debug('vue-i18n-locale-message:utils')
@@ -450,7 +451,7 @@ export function returnIgnoreInstance (ig: Ignore, ignoreFiles: string[]): void {
   })
 }
 
-export async function isDifferent (options: DiffOptions): Promise<boolean> {
+export async function isDifferent (options: DiffOptions): Promise<diffInfo> {
   const format = 'json'
   const ProviderFactory = loadProvider(options.provider)
 
@@ -472,13 +473,14 @@ export async function isDifferent (options: DiffOptions): Promise<boolean> {
   const locales = Object.keys(localeMessages) as Locale[]
   const serviceMessages = await provider.pull({ locales, dryRun: false, normalize: options.normalize, format })
 
-  const ret = diffString(serviceMessages, localeMessages)
+  const ret = jsonDiff.diffString(serviceMessages, localeMessages)
   console.log(ret)
 
   if (ret) {
-    return Promise.resolve(true)
+    const diffObj = jsonDiff.diff(serviceMessages, localeMessages)
+    return Promise.resolve(diffObj)
   } else {
-    return Promise.resolve(false)
+    return Promise.resolve({})
   }
 }
 

types/index.d.ts

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