support --normalize option (#39)

* add nomalize option

* update type definition and add tests

Author: kazupon

src/commands/pull.ts

@@ -22,6 +22,7 @@ type PullOptions = {
   conf?: string
   output: string
   locales?: string
+  normalize?: string
   dryRun: boolean
 }
 
@@ -54,6 +55,11 @@ export const builder = (args: Argv): Argv<PullOptions> => {
       default: '',
       describe: `option for some locales of locale messages, you can also be specified multi locale with comma delimiter. if it's not specified pull all 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.'
+    })
     .option('dryRun', {
       type: 'boolean',
       alias: 'd',
@@ -83,7 +89,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 resource = await provider.pull(locales, args.dryRun)
+    const resource = await provider.pull(locales, args.dryRun, args.normalize)
     await applyPullResource(args.output, resource, args.dryRun)
     // TODO: should refactor console message
     console.log('pull success')

src/commands/push.ts

@@ -25,6 +25,7 @@ type PushOptions = {
   locale?: string
   targetPaths?: string
   filenameMatch?: string
+  normalize?: string
   dryRun: boolean
 }
 
@@ -65,6 +66,11 @@ export const builder = (args: Argv): Argv<PushOptions> => {
       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.'
+    })
     .option('dryRun', {
       type: 'boolean',
       alias: 'd',
@@ -101,7 +107,7 @@ export const handler = async (args: Arguments<PushOptions>): Promise<unknown> =>
 
   try {
     const provider = ProviderFactory(conf)
-    await provider.push(resource, args.dryRun)
+    await provider.push(resource, args.dryRun, args.normalize)
     // TODO: should refactor console message
     console.log('push success')
   } catch (e) {

test/commands/pull.test.ts

@@ -139,7 +139,7 @@ test('--locales option', async () => {
     })
   })
 
-  expect(mockPull).toHaveBeenCalledWith(['en', 'ja', 'fr'], true)
+  expect(mockPull).toHaveBeenCalledWith(['en', 'ja', 'fr'], true, undefined)
 })
 
 test('--output option', async () => {
@@ -164,3 +164,21 @@ test('--output option', async () => {
   expect(mockFS.mkdir.mock.calls[0][0]).toEqual(OUTPUT_FULL_PATH)
   expect(mockFS.mkdir.mock.calls[0][1]).toEqual({ recursive: true })
 })
+
+test('--normalize 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 \
+      --normalize=hierarchy`, (err, argv, output) => {
+      err ? reject(err) : resolve(output)
+    })
+  })
+
+  expect(mockPull).toHaveBeenCalledWith([], false, 'hierarchy')
+})

test/commands/push.test.ts

@@ -98,7 +98,7 @@ test('--target option', async () => {
       en: { hello: 'world' }
     },
     mode: 'locale-message'
-  }, false)
+  }, false, undefined)
 })
 
 test('--locale option', async () => {
@@ -119,7 +119,7 @@ test('--locale option', async () => {
       ja: { hello: '世界' }
     },
     mode: 'locale-message'
-  }, false)
+  }, false, undefined)
 })
 
 test('--conf option', async () => {
@@ -146,7 +146,7 @@ test('--conf option', async () => {
       path: path.resolve(TARGET_LOCALE)
     }],
     mode: 'file-path'
-  }, false)
+  }, false, undefined)
 })
 
 test('--conf option omit', async () => {
@@ -193,7 +193,7 @@ test('--target-paths option', async () => {
       }
     },
     mode: 'locale-message'
-  }, false)
+  }, false, undefined)
 })
 
 test('not specified --filename-match', async () => {
@@ -230,5 +230,26 @@ test('--dry-run option', async () => {
       ja: { hello: '世界' }
     },
     mode: 'locale-message'
-  }, true)
+  }, true, undefined)
+})
+
+test('--normalize option', async () => {
+  // setup mocks
+  mockPush.mockImplementation(resource => false)
+
+  // run
+  const push = await import('../../src/commands/push')
+  const cmd = yargs.command(push)
+  await new Promise((resolve, reject) => {
+    cmd.parse(`push --provider=@scope/l10n-service-provider --target=./test/fixtures/locales/lang.json --locale=ja --normalize=flat`, (err, argv, output) => {
+      err ? reject(err) : resolve(output)
+    })
+  })
+
+  expect(mockPush).toHaveBeenCalledWith({
+    messages: {
+      ja: { hello: '世界' }
+    },
+    mode: 'locale-message'
+  }, false, 'flat')
 })

types/index.d.ts

@@ -170,19 +170,19 @@ export interface Provider {
    * @param resource the resource that push to localization service
    * @param dryRun whether the CLI run as dryRun mode
    */
-  push (resource: ProviderPushResource, dryRun: boolean): Promise<void>
+  push (resource: ProviderPushResource, dryRun: boolean, normalize?: string): Promise<void>
   /**
    * pull the resource from localization service
    * @param locales locales that pull from localization service, if empty, you must pull the all locale messages
    * @param dryRun whether the CLI run as dryRun mode
    * @returns the resource of localization service
    */
-  pull (locales: Locale[], dryRun: boolean): Promise<ProviderPullResource>
+  pull (locales: Locale[], dryRun: boolean, normalize?: string): Promise<ProviderPullResource>
 }
 
 /**
- *  mode that can be processed with provider push  
- *  - 'file-path': 
+ *  mode that can be processed with provider push
+ *  - 'file-path':
  *    To use when the provider uses the locale message directly from the file.
  *    for example, used for file uploading.
  *    When specified that mode, `ProviderPushResource` are passed from the CLI as `files`.