support default value when --conf is omitted (#38)

* update README

* support default value when --conf is omitted

Author: kazupon

README.md

@@ -10,6 +10,14 @@ i18n locale messages management tool / library for vue-i18n
   <img src="https://c5.patreon.com/external/logo/become_a_patron_button.png" alt="Become a Patreon">
 </a>
 
+## :raising_hand: Motivations
+
+The big motivation is as follows.
+
+- :tired_face: Hard to integrate locale messages for localization services
+- :tired_face: Hard to maintain consistency of locale message keys (`eslint-plugin-vue-i18n` need it!)
+- :pray: Requested by 3rd vendor tools (`i18n-ally` and etc ...)
+
 ## :cd: Installation
 
 ### npm
@@ -45,6 +53,7 @@ yarn global vue-i18n-locale-message
   - squeeze the locale messages from `i18n` custom block
   - infuse the locale messages to `i18n` custom block
   - push the locale messages to localization service
+  - pull the locale mesagees from localization service
 
 ## :rocket: Usages
 
@@ -111,13 +120,13 @@ vue-i18n-locale-message push --provider=l10n-service-provider \
   --filename-match=^([\\w]*)\\.json
 ```
 
-## :raising_hand: Motivations
+#### pull
 
-The big motivation is as follows.
-
-- :tired_face: Hard to integrate locale messages for localization services
-- :tired_face: Hard to maintain consistency of locale message keys (`eslint-plugin-vue-i18n` need it!)
-- :pray: Requested by 3rd vendor tools (`i18n-ally` and etc ...)
+```sh
+vue-i18n-locale-message pull --provider=l10n-service-provider \
+  --conf=110n-service-provider-conf.json \
+  --output=./src/locales
+```
 
 ## :book: API: Specifications
 

src/commands/pull.ts

@@ -9,7 +9,12 @@ const debug = Debug('vue-i18n-locale-message:commands:pull')
 const mkdirPromisify = promisify(fs.mkdir)
 const writeFilePromisify = promisify(fs.writeFile)
 
-import { resolve, loadProvider, loadProviderConf, DEFUALT_CONF } from '../utils'
+import {
+  resolveProviderConf,
+  loadProvider,
+  loadProviderConf,
+  DEFUALT_CONF
+} from '../utils'
 import { ProviderPullResource, Locale, LocaleMessage } from '../../types'
 
 type PullOptions = {
@@ -35,7 +40,7 @@ export const builder = (args: Argv): Argv<PullOptions> => {
     .option('conf', {
       type: 'string',
       alias: 'c',
-      describe: 'the json file configration of localization service provider'
+      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('output', {
       type: 'string',
@@ -72,10 +77,8 @@ export const handler = async (args: Arguments<PullOptions>): Promise<unknown> =>
     return
   }
 
-  let conf = DEFUALT_CONF
-  if (args.conf) {
-    conf = loadProviderConf(resolve(args.conf))
-  }
+  const confPath = resolveProviderConf(args.provider, args.conf)
+  const conf = loadProviderConf(confPath) || DEFUALT_CONF
 
   try {
     const locales = args.locales?.split(',').filter(p => p) as Locale[] || []

src/commands/push.ts

@@ -1,6 +1,12 @@
 import { Arguments, Argv } from 'yargs'
 
-import { resolve, loadProvider, loadProviderConf, DEFUALT_CONF } from '../utils'
+import {
+  resolve,
+  resolveProviderConf,
+  loadProvider,
+  loadProviderConf,
+  DEFUALT_CONF
+} from '../utils'
 import path from 'path'
 import glob from 'glob'
 
@@ -37,7 +43,7 @@ export const builder = (args: Argv): Argv<PushOptions> => {
     .option('conf', {
       type: 'string',
       alias: 'c',
-      describe: 'the json file configration of localization service provider'
+      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',
@@ -76,17 +82,15 @@ export const handler = async (args: Arguments<PushOptions>): Promise<unknown> =>
     return
   }
 
-  let conf = DEFUALT_CONF
-  if (args.conf) {
-    conf = loadProviderConf(resolve(args.conf))
-  }
-
   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 resource
   try {
     resource = getProviderPushResource(args, conf.pushMode)

src/utils.ts

@@ -125,6 +125,15 @@ function resolveGlob (target: string) {
 
 export const DEFUALT_CONF = { provider: {}, pushMode: 'locale-message' } as ProviderConfiguration
 
+export function resolveProviderConf (provider: string, conf?: string) {
+  if (conf) {
+    return resolve(conf)
+  } else {
+    const parsed = path.parse(provider)
+    return resolve(process.cwd(), `${parsed.base}-conf.json`)
+  }
+}
+
 export function loadProvider (provider: string): ProviderFactory | null {
   let mod: ProviderFactory | null = null
   try {

test/commands/__mocks__/@scope/l10n-omit-service-provider.js

@@ -0,0 +1,7 @@
+{
+  "provider": {
+    "token": "yyy"
+  },
+  "pushMode": "file-path"
+}
+  

test/commands/l10n-omit-service-provider-conf.json

@@ -13,6 +13,17 @@ jest.mock('@scope/l10n-service-provider', () => {
 })
 import L10nServiceProvider from '@scope/l10n-service-provider'
 
+jest.mock('@scope/l10n-omit-service-provider', () => {
+  return jest.fn().mockImplementation(() => {
+    return { pull: jest.fn()
+      .mockImplementation(locales => {
+        return Promise.resolve({ ja: { hello: 'hello' }, en: { hello: 'こんにちわわわ！' }})
+      })
+    }
+  })
+})
+import L10nOmitServiceProvider from '@scope/l10n-omit-service-provider'
+
 // fs module
 jest.mock('fs', () => ({
   ...jest.requireActual('fs'),
@@ -24,17 +35,23 @@ import fs from 'fs'
 // --------------------
 // setup/teadown hooks
 
+const PROCESS_CWD_TARGET_PATH = path.resolve(__dirname)
+
+let orgCwd // for process.cwd mock
 let spyLog
 let spyError
 beforeEach(() => {
   spyLog = jest.spyOn(global.console, 'log')
   spyError = jest.spyOn(global.console, 'error')
+  orgCwd = process.cwd
+  process.cwd = jest.fn(() => PROCESS_CWD_TARGET_PATH) // mock: process.cwd
 })
 
 afterEach(() => {
   spyError.mockRestore()
   spyLog.mockRestore()
   jest.clearAllMocks()
+  process.cwd = orgCwd
 })
 
 // -----------
@@ -88,6 +105,24 @@ test('--conf option', async () => {
   })
 })
 
+test('--conf option omit', async () => {
+  // run
+  const pull = await import('../../src/commands/pull')
+  const cmd = yargs.command(pull)
+  await new Promise((resolve, reject) => {
+    cmd.parse(`pull --provider=@scope/l10n-omit-service-provider \
+      --output=./test/fixtures/locales \
+      --dry-run`, (err, argv, output) => {
+      err ? reject(err) : resolve(output)
+    })
+  })
+
+  expect(L10nOmitServiceProvider).toHaveBeenCalledWith({
+    provider: { token: 'yyy' },
+    pushMode: 'file-path'
+  })
+})
+
 test('--locales option', async () => {
   // setup mocks
   mockPull.mockImplementation(locales => Promise.resolve({ ja: {}, en: {}}))

test/commands/pull.test.ts

@@ -12,20 +12,33 @@ jest.mock('@scope/l10n-service-provider', () => {
 })
 import L10nServiceProvider from '@scope/l10n-service-provider'
 
+jest.mock('@scope/l10n-omit-service-provider', () => {
+  return jest.fn().mockImplementation(() => {
+    return { push: jest.fn() }
+  })
+})
+import L10nOmitServiceProvider from '@scope/l10n-omit-service-provider'
+
 // -------------------
 // setup/teadown hooks
 
+const PROCESS_CWD_TARGET_PATH = path.resolve(__dirname)
+
+let orgCwd // for process.cwd mock
 let spyLog
 let spyError
 beforeEach(() => {
   spyLog = jest.spyOn(global.console, 'log')
   spyError = jest.spyOn(global.console, 'error')
+  orgCwd = process.cwd
+  process.cwd = jest.fn(() => PROCESS_CWD_TARGET_PATH) // mock: process.cwd
 })
 
 afterEach(() => {
   spyError.mockRestore()
   spyLog.mockRestore()
   jest.clearAllMocks()
+  process.cwd = orgCwd
 })
 
 // ----------
@@ -136,6 +149,23 @@ test('--conf option', async () => {
   }, false)
 })
 
+test('--conf option omit', async () => {
+  // run
+  const TARGET_LOCALE = './test/fixtures/locales/en.json'
+  const push = await import('../../src/commands/push')
+  const cmd = yargs.command(push)
+  await new Promise((resolve, reject) => {
+    cmd.parse(`push --provider=@scope/l10n-omit-service-provider --target=${TARGET_LOCALE}`, (err, argv, output) => {
+      err ? reject(err) : resolve(output)
+    })
+  })
+
+  expect(L10nOmitServiceProvider).toHaveBeenCalledWith({
+    provider: { token: 'yyy' },
+    pushMode: 'file-path'
+  })
+})
+
 test('--target-paths option', async () => {
   // setup mocks
   mockPush.mockImplementation(resource => true)