diff command feature (#46)

* feat: diff command

* update docs

Author: kazupon

README.md

@@ -54,6 +54,7 @@ yarn global vue-i18n-locale-message
   - infuse the locale messages to `i18n` custom block
   - push the locale messages to localization service
   - pull the locale mesagees from localization service
+  - diff locale messages between local and localization service
 
 ## :rocket: Usages
 
@@ -128,6 +129,15 @@ vue-i18n-locale-message pull --provider=l10n-service-provider \
   --output=./src/locales
 ```
 
+#### Diff
+
+```sh
+vue-i18n-locale-message diff --provider=l10n-service-provider \
+  --conf=110n-service-provider-conf.json \
+  --target-paths=./src/locales/*.json \
+  --filename-match=^([\\w]*)\\.json
+```
+
 ## :book: API: Specifications
 
 <p align="center"><img width="476px" height="544px" src="./assets/api-usage-image.png" alt="API Usage Image"></p>
@@ -162,7 +172,7 @@ You can use the `push` or `pull` commands to push the locale message to the loca
 
 <p align="center"><img src="./assets/push-pull-command-image.png" alt="Push and Pull Image"></p>
 
-When you run `push` or `pull` commands, you need the provider that implements the following.
+When you run `push`, `pull` and `diff` commands, you need the provider that implements the following.
 
 - export provider factory function
 - provider factory function must return a provider object that have the following I/F:

package.json

@@ -31,6 +31,7 @@
     "glob": "^7.1.4",
     "js-yaml": "^3.13.1",
     "json5": "^2.1.0",
+    "json-diff": "^0.5.4",
     "vue-template-compiler": "^2.6.10",
     "yargs": "^15.0.0"
   },

src/commands/diff.ts

@@ -0,0 +1,109 @@
+import { Arguments, Argv } from 'yargs'
+import { diffString } from 'json-diff'
+
+import {
+  resolveProviderConf,
+  loadProvider,
+  loadProviderConf,
+  DEFUALT_CONF,
+  getLocaleMessages,
+  PushableOptions
+} from '../utils'
+
+import { Locale } from '../../types'
+
+type DiffOptions = {
+  provider: string
+  conf?: string
+  normalize?: string
+} & PushableOptions
+
+export const command = 'diff'
+export const aliases = 'df'
+export const describe = 'Diff locale messages between local and localization service'
+
+export const builder = (args: Argv): Argv<DiffOptions> => {
+  return args
+    .option('provider', {
+      type: 'string',
+      alias: 'p',
+      describe: 'the target localization service provider',
+      demandOption: true
+    })
+    .option('conf', {
+      type: 'string',
+      alias: 'c',
+      describe: 'the json file configration of localization service provider. If omitted, use the suffix file name with `-conf` for provider name of --provider (e.g. <provider>-conf.json).'
+    })
+    .option('target', {
+      type: 'string',
+      alias: 't',
+      describe: 'target path that locale messages file is stored, default push with the filename of target path as locale'
+    })
+    .option('locale', {
+      type: 'string',
+      alias: 'l',
+      describe: `option for the locale of locale messages file specified with --target, if it's specified single-file`
+    })
+    .option('targetPaths', {
+      type: 'string',
+      alias: 'T',
+      describe: 'target directory paths that locale messages files is stored, Can also be specified multi paths with comma delimiter'
+    })
+    .option('filenameMatch', {
+      type: 'string',
+      alias: 'm',
+      describe: `option should be accepted a regex filenames, must be specified together --targets if it's directory path of locale messages`
+    })
+    .option('normalize', {
+      type: 'string',
+      alias: 'n',
+      describe: 'option for the locale messages structure, you can specify the option, if you hope to normalize for the provider.'
+    })
+}
+
+export const handler = async (args: Arguments<DiffOptions>): Promise<unknown> => {
+  const { normalize } = args
+  const ProviderFactory = loadProvider(args.provider)
+
+  if (ProviderFactory === null) {
+    // TODO: should refactor console message
+    console.log(`Not found ${args.provider} provider`)
+    return
+  }
+
+  if (!args.target && !args.targetPaths) {
+    // TODO: should refactor console message
+    console.log('You need to specify either --target or --target-paths')
+    return
+  }
+
+  const confPath = resolveProviderConf(args.provider, args.conf)
+  const conf = loadProviderConf(confPath) || DEFUALT_CONF
+
+  let localeMessages
+  try {
+    localeMessages = getLocaleMessages(args)
+  } catch (e) {
+    console.log(e.message)
+    return
+  }
+
+  try {
+    const provider = ProviderFactory(conf)
+    const locales = Object.keys(localeMessages) as Locale[]
+    const serviceMessages = await provider.pull({ locales, dryRun: false, normalize })
+    console.log(diffString(localeMessages, serviceMessages))
+  } catch (e) {
+    // TODO: should refactor console message
+    console.error('diff fail', e)
+  }
+}
+
+export default {
+  command,
+  aliases,
+  describe,
+  builder,
+  handler
+}

src/commands/pull.ts

@@ -90,8 +90,8 @@ export const handler = async (args: Arguments<PullOptions>): Promise<unknown> =>
   try {
     const locales = args.locales?.split(',').filter(p => p) as Locale[] || []
     const provider = ProviderFactory(conf)
-    const resource = await provider.pull({ locales, dryRun, normalize })
-    await applyPullLocaleMessages(args.output, resource, args.dryRun)
+    const messages = await provider.pull({ locales, dryRun, normalize })
+    await applyPullLocaleMessages(args.output, messages, args.dryRun)
     // TODO: should refactor console message
     console.log('pull success')
   } catch (e) {

src/commands/push.ts

@@ -1,30 +1,20 @@
 import { Arguments, Argv } from 'yargs'
 
 import {
-  resolve,
   resolveProviderConf,
   loadProvider,
   loadProviderConf,
-  DEFUALT_CONF
+  DEFUALT_CONF,
+  getLocaleMessages,
+  PushableOptions
 } from '../utils'
-import path from 'path'
-import glob from 'glob'
-
-import { debug as Debug } from 'debug'
-const debug = Debug('vue-i18n-locale-message:commands:push')
-
-import { LocaleMessages } from '../../types'
 
 type PushOptions = {
   provider: string
   conf?: string
-  target?: string
-  locale?: string
-  targetPaths?: string
-  filenameMatch?: string
   normalize?: string
   dryRun: boolean
-}
+} & PushableOptions
 
 export const command = 'push'
 export const aliases = 'ph'
@@ -114,42 +104,6 @@ export const handler = async (args: Arguments<PushOptions>): Promise<unknown> =>
   }
 }
 
-function getLocaleMessages (args: Arguments<PushOptions>): LocaleMessages {
-  let messages = {} as LocaleMessages
-
-  if (args.target) {
-    const targetPath = resolve(args.target)
-    const parsed = path.parse(targetPath)
-    const locale = args.locale ? args.locale : parsed.name
-    messages = Object.assign(messages, { [locale]: require(targetPath) })
-  } else if (args.targetPaths) {
-    const filenameMatch = args.filenameMatch
-    if (!filenameMatch) {
-      // TODO: should refactor console message
-      throw new Error('You need to specify together --filename-match')
-    }
-    const targetPaths = args.targetPaths.split(',').filter(p => p)
-    targetPaths.forEach(targetPath => {
-      const globedPaths = glob.sync(targetPath).map(p => resolve(p))
-      globedPaths.forEach(fullPath => {
-        const parsed = path.parse(fullPath)
-        const re = new RegExp(filenameMatch, 'ig')
-        const match = re.exec(parsed.base)
-        debug('regex match', match, fullPath)
-        if (match && match[1]) {
-          const locale = match[1]
-          messages = Object.assign(messages, { [locale]: require(fullPath) })
-        } else {
-          // TODO: should refactor console message
-          console.log(`${fullPath} is not matched with ${filenameMatch}`)
-        }
-      })
-    })
-  }
-
-  return messages
-}
-
 export default {
   command,
   aliases,

src/utils.ts

@@ -1,7 +1,8 @@
+import { Arguments } from 'yargs'
 import { SFCDescriptor } from 'vue-template-compiler'
 import { SFCFileInfo, FormatOptions } from '../types'
 import { VueTemplateCompiler } from '@vue/component-compiler-utils/dist/types'
-import { ProviderFactory, ProviderConfiguration } from '../types'
+import { LocaleMessages, ProviderFactory, ProviderConfiguration } from '../types'
 
 import { parse } from '@vue/component-compiler-utils'
 import * as compiler from 'vue-template-compiler'
@@ -14,6 +15,13 @@ import yaml from 'js-yaml'
 import { debug as Debug } from 'debug'
 const debug = Debug('vue-i18n-locale-message:utils')
 
+export type PushableOptions = {
+  target?: string
+  locale?: string
+  targetPaths?: string
+  filenameMatch?: string
+}
+
 const ESC: { [key in string]: string } = {
   '<': '&lt;',
   '>': '&gt;',
@@ -123,7 +131,7 @@ function resolveGlob (target: string) {
   return glob.sync(`${target}/**/*.vue`)
 }
 
-export const DEFUALT_CONF = { provider: {}, pushMode: 'locale-message' } as ProviderConfiguration
+export const DEFUALT_CONF = { provider: {}} as ProviderConfiguration
 
 export function resolveProviderConf (provider: string, conf?: string) {
   if (conf) {
@@ -157,3 +165,39 @@ export function loadProviderConf (confPath: string): ProviderConfiguration {
   } catch (e) { }
   return conf
 }
+
+export function getLocaleMessages (args: Arguments<PushableOptions>): LocaleMessages {
+  let messages = {} as LocaleMessages
+
+  if (args.target) {
+    const targetPath = resolve(args.target)
+    const parsed = path.parse(targetPath)
+    const locale = args.locale ? args.locale : parsed.name
+    messages = Object.assign(messages, { [locale]: require(targetPath) })
+  } else if (args.targetPaths) {
+    const filenameMatch = args.filenameMatch
+    if (!filenameMatch) {
+      // TODO: should refactor console message
+      throw new Error('You need to specify together --filename-match')
+    }
+    const targetPaths = args.targetPaths.split(',').filter(p => p)
+    targetPaths.forEach(targetPath => {
+      const globedPaths = glob.sync(targetPath).map(p => resolve(p))
+      globedPaths.forEach(fullPath => {
+        const parsed = path.parse(fullPath)
+        const re = new RegExp(filenameMatch, 'ig')
+        const match = re.exec(parsed.base)
+        debug('regex match', match, fullPath)
+        if (match && match[1]) {
+          const locale = match[1]
+          messages = Object.assign(messages, { [locale]: require(fullPath) })
+        } else {
+          // TODO: should refactor console message
+          console.log(`${fullPath} is not matched with ${filenameMatch}`)
+        }
+      })
+    })
+  }
+
+  return messages
+}

test/commands/__snapshots__/diff.test.ts.snap

@@ -0,0 +1,48 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`--locale option 1`] = `
+" {
+   en: {
++    nest: {
++      world: \\"world!\\"
++    }
+-    hello: \\"世界\\"
++    hello: \\"hello!\\"
+   }
+ }
+"
+`;
+
+exports[`--target option 1`] = `
+" {
+   ja: {
+-    world: \\"ザ・ワールド\\"
++    nest: {
++      world: \\"世界！\\"
++    }
+-    hello: \\"こんにちわわわ！\\"
++    hello: \\"こんにちは！\\"
+   }
+ }
+"
+`;
+
+exports[`--target-paths option 1`] = `
+" {
+-  ja: {
+-    hello: \\"こんにちわわわ！\\"
+-    world: \\"ザ・ワールド\\"
+-  }
+-  lang: {
+-    hello: \\"世界\\"
+-  }
+   en: {
++    nest: {
++      world: \\"world!\\"
++    }
+-    hello: \\"world\\"
++    hello: \\"hello!\\"
+   }
+ }
+"
+`;