--format option feature (#52)

Author: kazupon

src/commands/pull.ts

@@ -23,6 +23,7 @@ type PullOptions = {
   output: string
   locales?: string
   normalize?: string
+  format: string
   dryRun: boolean
 }
 
@@ -60,6 +61,12 @@ export const builder = (args: Argv): Argv<PullOptions> => {
       alias: 'n',
       describe: 'option for the locale messages structure, you can specify the option, if you hope to normalize for the provider.'
     })
+    .option('format', {
+      type: 'string',
+      alias: 'f',
+      default: 'json',
+      describe: 'option for the locale messages format, default `json`'
+    })
     .option('dryRun', {
       type: 'boolean',
       alias: 'd',
@@ -69,7 +76,7 @@ export const builder = (args: Argv): Argv<PullOptions> => {
 }
 
 export const handler = async (args: Arguments<PullOptions>): Promise<unknown> => {
-  const { dryRun, normalize } = args
+  const { dryRun, normalize, format } = args
   const ProviderFactory = loadProvider(args.provider)
 
   if (ProviderFactory === null) {
@@ -90,7 +97,7 @@ 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 messages = await provider.pull({ locales, dryRun, normalize })
+    const messages = await provider.pull({ locales, dryRun, normalize, format })
     await applyPullLocaleMessages(args.output, messages, args.dryRun)
     // TODO: should refactor console message
     console.log('pull success')

test/commands/pull.test.ts

@@ -139,6 +139,7 @@ test('--locales option', async () => {
 
   expect(mockPull).toHaveBeenCalledWith({
     locales: ['en', 'ja', 'fr'],
+    format: 'json',
     dryRun: true,
     normalize: undefined
   })
@@ -184,7 +185,31 @@ test('--normalize option', async () => {
 
   expect(mockPull).toHaveBeenCalledWith({
     locales: [],
+    format: 'json',
     dryRun: false,
     normalize: 'hierarchy'
   })
 })
+
+test('--format option', async () => {
+  // setup mocks
+  mockPull.mockImplementation(({ locales }) => Promise.resolve({ ja: {}, en: {}}))
+
+  // run
+  const pull = await import('../../src/commands/pull')
+  const cmd = yargs.command(pull)
+  await new Promise((resolve, reject) => {
+    cmd.parse(`pull --provider=@scope/l10n-service-provider \
+      --output=./test/fixtures/locales \
+      --format=xliff`, (err, argv, output) => {
+      err ? reject(err) : resolve(output)
+    })
+  })
+
+  expect(mockPull).toHaveBeenCalledWith({
+    locales: [],
+    format: 'xliff',
+    dryRun: false,
+    normalize: undefined
+  })
+})

types/index.d.ts

@@ -212,6 +212,7 @@ export type PushArguments = {
  */
 export type PullArguments = {
   locales: Locale[] // locales that pull from localization service, if empty, you must pull all locale messages
+  format: string // locale messages format
 } & CommonArguments
 
 /**