feat: bundle and namespace features (#78)

* refactor fail

* add utils tests

* bundle & namespace feature implementation

Author: kazupon

package.json

@@ -28,17 +28,19 @@
     "@vue/component-compiler-utils": "^3.0.0",
     "debug": "^4.1.1",
     "deep-diff": "^1.0.2",
+    "deepmerge": "^4.2.2",
     "flat": "^5.0.0",
     "glob": "^7.1.4",
     "js-yaml": "^3.13.1",
     "json-diff": "^0.5.4",
     "json5": "^2.1.0",
     "vue-template-compiler": "^2.6.10",
-    "yargs": "^15.0.0"
+    "yargs": "^15.1.0"
   },
   "devDependencies": {
     "@types/debug": "^4.1.4",
     "@types/deep-diff": "^1.0.0",
+    "@types/deepmerge": "^2.2.0",
     "@types/flat": "^0.0.28",
     "@types/glob": "^7.1.1",
     "@types/jest": "^24.0.24",

src/commands/diff.ts

@@ -1,5 +1,6 @@
 import { Arguments, Argv } from 'yargs'
 const { diffString } = require('json-diff') // NOTE: not provided type definition ...
+import { DiffError, fail } from './fails/diff'
 
 import {
   resolveProviderConf,
@@ -22,8 +23,6 @@ export const command = 'diff'
 export const aliases = 'df'
 export const describe = 'Diff locale messages between local and localization service'
 
-class DiffError extends Error {}
-
 export const builder = (args: Argv): Argv<DiffOptions> => {
   return args
     .option('provider', {
@@ -62,37 +61,22 @@ export const builder = (args: Argv): Argv<DiffOptions> => {
       alias: 'n',
       describe: 'option for the locale messages structure, you can specify the option, if you hope to normalize for the provider.'
     })
-    .fail((msg, err) => {
-      if (msg) {
-        // TODO: should refactor console message
-        console.error(msg)
-        process.exit(1)
-      } else {
-        if (err instanceof DiffError) {
-          // TODO: should refactor console message
-          console.warn(err.message)
-          process.exit(64)
-        } else {
-          // TODO: should refactor console message
-          console.error(err.message)
-          process.exit(1)
-        }
-      }
-    })
+    .fail(fail)
 }
 
 export const handler = async (args: Arguments<DiffOptions>): Promise<unknown> => {
   const { normalize } = args
   const format = 'json'
+
   const ProviderFactory = loadProvider(args.provider)
 
   if (ProviderFactory === null) {
-    throw new Error(`Not found ${args.provider} provider`)
+    return Promise.reject(new Error(`Not found ${args.provider} provider`))
   }
 
   if (!args.target && !args.targetPaths) {
     // TODO: should refactor console message
-    throw new Error('You need to specify either --target or --target-paths')
+    return Promise.reject(new Error('You need to specify either --target or --target-paths'))
   }
 
   const confPath = resolveProviderConf(args.provider, args.conf)
@@ -108,7 +92,7 @@ export const handler = async (args: Arguments<DiffOptions>): Promise<unknown> =>
   console.log(ret)
 
   if (ret) {
-    throw new DiffError('There are differences!')
+    return Promise.reject(new DiffError('There are differences!'))
   }
 
   return Promise.resolve()

src/commands/fails/diff.ts

@@ -0,0 +1,10 @@
+import { ExitCode } from './exitcode'
+import defineFail from './fail'
+
+export class DiffError extends Error {}
+export const fail = defineFail(DiffError, ExitCode.Difference)
+
+export default {
+  DiffError,
+  fail
+}

src/commands/fails/exitcode.ts

@@ -0,0 +1,6 @@
+export const enum ExitCode {
+  NotYetTranslation = 4,
+  UndefinedLocaleMessage = 5,
+  Difference = 64
+}
+

src/commands/fails/fail.ts

@@ -0,0 +1,29 @@
+import { ExitCode } from './exitcode'
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type Constructor<T> = { new (...args: any[]): T }
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function typeGuard<T> (o: any, className: Constructor<T>): o is T {
+  return o instanceof className
+}
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export default function defineFail (UserError: any, code: ExitCode) {
+  return (msg: string, err: Error) => {
+    if (msg) {
+      // TODO: should refactor console message
+      console.error(msg)
+      process.exit(1)
+    } else {
+      if (typeGuard(err, UserError)) {
+        // TODO: should refactor console message
+        console.warn(err.message)
+        process.exit(code)
+      } else {
+        // preserve statck! see the https://github.com/yargs/yargs/blob/master/docs/api.md#failfn
+        throw err
+      }
+    }
+  }
+}

src/commands/fails/list.ts

@@ -0,0 +1,10 @@
+import { ExitCode } from './exitcode'
+import defineFail from './fail'
+
+export class LocaleMessageUndefindError extends Error {}
+export const fail = defineFail(LocaleMessageUndefindError, ExitCode.UndefinedLocaleMessage)
+
+export default {
+  LocaleMessageUndefindError,
+  fail
+}

src/commands/fails/status.ts

@@ -0,0 +1,10 @@
+import { ExitCode } from './exitcode'
+import defineFail from './fail'
+
+export class TranslationStatusError extends Error {}
+export const fail = defineFail(TranslationStatusError, ExitCode.NotYetTranslation)
+
+export default {
+  TranslationStatusError,
+  fail
+}

src/commands/infuse.ts

@@ -1,13 +1,27 @@
 import { Arguments, Argv } from 'yargs'
 
-import { resolve, parsePath, readSFC } from '../utils'
+import {
+  resolve,
+  parsePath,
+  readSFC,
+  NamespaceDictionary,
+  loadNamespaceDictionary,
+  splitLocaleMessages
+} from '../utils'
+
 import infuse from '../infuser'
 import squeeze from '../squeezer'
 import fs from 'fs'
 import path from 'path'
 import { applyDiff } from 'deep-diff'
 import glob from 'glob'
-import { LocaleMessages, SFCFileInfo, MetaLocaleMessage, Locale } from '../../types'
+import {
+  Locale,
+  LocaleMessages,
+  SFCFileInfo,
+  MetaLocaleMessage,
+  MetaExternalLocaleMessages
+} from '../../types'
 
 import { debug as Debug } from 'debug'
 const debug = Debug('vue-i18n-locale-message:commands:infuse')
@@ -16,6 +30,9 @@ type InfuseOptions = {
   target: string
   locales: string
   match?: string
+  unbundleTo?: string
+  unbundleMatch?: string
+  namespace?: string
   dryRun: boolean
 }
 
@@ -42,6 +59,21 @@ export const builder = (args: Argv): Argv<InfuseOptions> => {
       alias: 'm',
       describe: 'option should be accepted a regex filenames, must be specified together --messages'
     })
+    .option('unbundleTo', {
+      type: 'string',
+      alias: 'u',
+      describe: `target path of external locale messages bundled with 'squeeze' command, can also be specified multi paths with comma delimiter`
+    })
+    .option('unbundleMatch', {
+      type: 'string',
+      alias: 'M',
+      describe: `option should be accepted regex filename of external locale messages, must be specified if it's directory path of external locale messages with --unbundle-to`
+    })
+    .option('namespace', {
+      type: 'string',
+      alias: 'n',
+      describe: 'file path that defines the namespace for external locale messages bundled together'
+    })
     .option('dryRun', {
       type: 'boolean',
       alias: 'd',
@@ -50,15 +82,38 @@ export const builder = (args: Argv): Argv<InfuseOptions> => {
     })
 }
 
-export const handler = (args: Arguments<InfuseOptions>): void => {
+export const handler = async (args: Arguments<InfuseOptions>) => {
   const targetPath = resolve(args.target)
   const messagesPath = resolve(args.locales)
+
+  let nsDictionary = {} as NamespaceDictionary
+  try {
+    if (args.namespace) {
+      nsDictionary = await loadNamespaceDictionary(args.namespace)
+    }
+  } catch (e) {
+    console.warn('cannot load namespace dictionary')
+  }
+  debug('namespace dictionary:', nsDictionary)
+
   const sources = readSFC(targetPath)
   const messages = readLocaleMessages(messagesPath, args.match)
+
+  const { sfc, external } = splitLocaleMessages(messages, nsDictionary, args.unbundleTo, args.unbundleMatch)
+  debug('sfc', sfc)
+  debug('external', external)
+
   const meta = squeeze(targetPath, sources)
-  apply(messages, meta)
+  apply(sfc, meta)
   const newSources = infuse(targetPath, sources, meta)
-  if (!args.dryRun) writeSFC(newSources)
+
+  if (!args.dryRun) {
+    writeSFC(newSources)
+  }
+
+  if (!args.dryRun && external) {
+    writeExternalLocaleMessages(external)
+  }
 }
 
 function readLocaleMessages (targetPath: string, matchRegex?: string): LocaleMessages {
@@ -186,6 +241,13 @@ function writeSFC (sources: SFCFileInfo[]) {
   })
 }
 
+function writeExternalLocaleMessages (meta: MetaExternalLocaleMessages[]) {
+  // TODO: async implementation
+  meta.forEach(({ path, messages }) => {
+    fs.writeFileSync(path, JSON.stringify(messages, null, 2))
+  })
+}
+
 export default {
   command,
   aliases,

src/commands/list.ts

@@ -5,6 +5,8 @@ import fs from 'fs'
 import { promisify } from 'util'
 import { Arguments, Argv } from 'yargs'
 
+import { LocaleMessageUndefindError, fail } from './fails/list'
+
 import {
   resolve,
   getLocaleMessages
@@ -36,8 +38,6 @@ const debug = Debug('vue-i18n-locale-message:commands:list')
 
 const writeFile = promisify(fs.writeFile)
 
-class LocaleMessageUndefindError extends Error {}
-
 export const command = 'list'
 export const aliases = 'lt'
 export const describe = 'List undefined fields in locale messages'
@@ -77,29 +77,14 @@ export const builder = (args: Argv): Argv<ListOptions> => {
       default: 2,
       describe: `option for indent of locale message, if you need to adjust with --define option`
     })
-    .fail((msg, err) => {
-      if (msg) {
-        // TODO: should refactor console message
-        console.error(msg)
-        process.exit(1)
-      } else {
-        if (err instanceof LocaleMessageUndefindError) {
-          // TODO: should refactor console message
-          console.warn(err.message)
-          process.exit(5)
-        } else {
-          if (err) throw err
-        }
-      }
-    })
+    .fail(fail)
 }
 
 export const handler = async (args: Arguments<ListOptions>): Promise<unknown> => {
   const { locale, define } = args
   if (!args.target && !args.targetPaths) {
     // TODO: should refactor console message
-    console.error('You need to specify either --target or --target-paths')
-    return
+    return Promise.reject(new Error('You need to specify either --target or --target-paths'))
   }
 
   const localeMessages = getLocaleMessages(args)
@@ -134,7 +119,7 @@ export const handler = async (args: Arguments<ListOptions>): Promise<unknown> =>
   })
 
   if (!define && !valid) {
-    return Promise.reject(new LocaleMessageUndefindError('there are undefined fields in the target locale messages, you can define with --define option'))
+    return Promise.reject(new LocaleMessageUndefindError('There are undefined fields in the target locale messages, you can define with --define option'))
   }
 
   const unflattedLocaleMessages = {} as LocaleMessages