feat: API for push (#175)

* feat: api for push

* fix: README

* refactor

Author: shota-kizawa

README.md

@@ -50,6 +50,7 @@ yarn global add vue-i18n-locale-message
   - infuse the meta of locale messages to `i18n` custom block
   - get translation status from localization service
   - diff locale messages between local and localization service
+  - push the locale messages to localization service
 - CLI
   - squeeze: squeeze the locale messages from `i18n` custom block
   - infuse: infuse the locale messages to `i18n` custom block

src/commands/diff.ts

@@ -59,15 +59,19 @@ export const builder = (args: Argv): Argv<DiffOptions> => {
 export const handler = async (args: Arguments<DiffOptions>): Promise<unknown> => {
   const { provider, conf, normalize, target, locale, targetPaths, filenameMatch } = args
 
-  const ret = await returnDiff({
-    provider, conf, normalize, target, locale, targetPaths, filenameMatch
-  })
+  try {
+    const ret = await returnDiff({
+      provider, conf, normalize, target, locale, targetPaths, filenameMatch
+    })
 
-  if (ret) {
-    return Promise.reject(new DiffError('There are differences!'))
+    if (ret) {
+      return Promise.reject(new DiffError('There are differences!'))
+    }
+    return Promise.resolve()
+  } catch (e) {
+    console.error(e.message)
+    return Promise.reject(e)
   }
-
-  return Promise.resolve()
 }
 
 export default {

src/commands/push.ts

@@ -1,23 +1,7 @@
 import { Arguments, Argv } from 'yargs'
-import querystring from 'query-string'
 
-import {
-  resolveProviderConf,
-  loadProvider,
-  loadProviderConf,
-  DEFUALT_CONF,
-  getLocaleMessages
-} from '../utils'
-
-import { PushableOptions } from '../../types'
-
-type PushOptions = {
-  provider: string
-  conf?: string
-  normalize?: string
-  dryRun: boolean
-  providerArgs?: string
-} & PushableOptions
+import { pushFunc } from '../utils'
+import { PushOptions } from '../../types'
 
 export const command = 'push'
 export const aliases = 'ph'
@@ -75,36 +59,14 @@ export const builder = (args: Argv): Argv<PushOptions> => {
 }
 
 export const handler = async (args: Arguments<PushOptions>): Promise<unknown> => {
-  const { dryRun, normalize, providerArgs } = 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
+  const { provider, conf, normalize, dryRun, providerArgs, target, locale, targetPaths, filenameMatch } = args
 
   try {
-    const messages = getLocaleMessages(args)
-    const provider = ProviderFactory(conf)
-    await provider.push({
-      messages, dryRun, normalize,
-      providerArgs: providerArgs !== undefined ? querystring.parse(providerArgs) : undefined
-    })
+    await pushFunc({ provider, conf, normalize, dryRun, providerArgs, target, locale, targetPaths, filenameMatch })
     // TODO: should refactor console message
     console.log('push success')
-  } catch (e) {
-    // TODO: should refactor console message
-    console.error('push fail:', e.message)
+  } catch {
+    return
   }
 }
 

src/commands/status.ts

@@ -39,15 +39,20 @@ export const builder = (args: Argv): Argv<StatusOptions> => {
 export const handler = async (args: Arguments<StatusOptions>): Promise<unknown> => {
   const { provider, conf, locales } = args
   debug(`status args: provider=${provider}, conf=${conf}, locales=${locales}`)
-  const status = await getTranslationStatus({ provider, conf, locales })
-  debug('raw status', status)
-  console.table(status)
+  try {
+    const status = await getTranslationStatus({ provider, conf, locales })
+    debug('raw status', status)
+    console.table(status)
 
-  const completes = status.filter(st => st.percentage < 100)
+    const completes = status.filter(st => st.percentage < 100)
 
-  return completes.length > 0
-    ? Promise.reject(new TranslationStatusError('Translation work in progress'))
-    : Promise.resolve('Translation done')
+    return completes.length > 0
+      ? Promise.reject(new TranslationStatusError('Translation work in progress'))
+      : Promise.resolve('Translation done')
+  } catch (e) {
+    console.error(e.message)
+    return Promise.reject(e)
+  }
 }
 
 export default {

src/utils.ts

@@ -17,7 +17,8 @@ import {
   RawLocaleMessage,
   NamespaceDictionary,
   PushableOptions,
-  DiffOptions
+  DiffOptions,
+  PushOptions
 } from '../types'
 
 // import modules
@@ -31,6 +32,7 @@ import yaml from 'js-yaml'
 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 ...
 
 import { debug as Debug } from 'debug'
@@ -479,3 +481,36 @@ export async function returnDiff (options: DiffOptions): Promise<boolean> {
     return Promise.resolve(false)
   }
 }
+
+export async function pushFunc (options: PushOptions): Promise<unknown> {
+  const ProviderFactory = loadProvider(options.provider)
+
+  if (ProviderFactory === null) {
+    // TODO: should refactor message
+    console.error(`Not found ${options.provider} provider`)
+    return Promise.reject()
+  }
+
+  if (!options.target && !options.targetPaths) {
+    // TODO: should refactor message
+    console.error(`You need to specify either --target or --target-paths`)
+    return Promise.reject()
+  }
+
+  const confPath = resolveProviderConf(options.provider, options.conf)
+  const conf = loadProviderConf(confPath) || DEFUALT_CONF
+
+  try {
+    const messages = getLocaleMessages(options)
+    const provider = ProviderFactory(conf)
+    await provider.push({
+      messages, dryRun: options.dryRun, normalize: options.normalize,
+      providerArgs: options.providerArgs !== undefined ? querystring.parse(options.providerArgs) : undefined
+    })
+  } catch (e) {
+    // TODO: should refactor message
+    console.error('push fail:', e.message)
+    return Promise.reject()
+  }
+  return Promise.resolve()
+}

test/commands/push.test.ts

@@ -66,7 +66,7 @@ test('--provider: not found', async () => {
       err ? reject(err) : resolve(output)
     })
   })
-  expect(spyLog).toHaveBeenCalledWith('Not found ./404-provider.js provider')
+  expect(spyError).toHaveBeenCalledWith('Not found ./404-provider.js provider')
 })
 
 test('not specified --target and --targetPaths', async () => {
@@ -77,7 +77,7 @@ test('not specified --target and --targetPaths', async () => {
       err ? reject(err) : resolve(output)
     })
   })
-  expect(spyLog).toHaveBeenCalledWith('You need to specify either --target or --target-paths')
+  expect(spyError).toHaveBeenCalledWith('You need to specify either --target or --target-paths')
 })
 
 test('--target option', async () => {

types/index.d.ts

@@ -195,14 +195,26 @@ declare function status (options: TranslationStatusOptions): Promise<Translation
 /**
  *  pushable options
  */
- export type PushableOptions = {
+export type PushableOptions = {
   target?: string
   locale?: string
   targetPaths?: string
   filenameMatch?: string
   format?: string
 }
 
+/**
+ *  push locale Message to l10n service
+ */
+export type PushOptions = {
+  provider: string
+  conf?: string
+  normalize?: string
+  dryRun: boolean
+  providerArgs?: string
+} & PushableOptions
+declare function push (options: PushOptions): Promise<unknown>
+
 /**
  *  Diff
  */