breaking: change push interface (#44)

Author: kazupon

README.md

@@ -182,58 +182,45 @@ type ProviderFactory<T = {}> = (configration: ProviderConfiguration<T>) => Provi
  */
 interface Provider {
   /**
-   * push the resource to localization service
-   * @param resource the resource that push to localization service
-   * @param dryRun whether the CLI run as dryRun mode
+   * push the locale messsages to localization service
    */
-  push (resource: ProviderPushResource, dryRun: boolean): Promise<void>
+  push (args: PushArguments): 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 the locale messages from localization service
    */
-  pull (locales: Locale[], dryRun: boolean): Promise<ProviderPullResource>
+  pull (args: PullArguments): Promise<LocaleMessages>
 }
 
-/**
- *  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`.
- *  - 'locale-message':
- *    To use when the provider uses the locale message.
- *    When specified that mode, `ProviderPushResource` are passed from the CLI as `messaegs`.
- */
-type ProviderPushMode = 'file-path' | 'locale-message'
-
-type ProviderPushFileInfo = {
-  locale: Locale
-  path: string
+type CommonArguments = {
+  dryRun: boolean // whether the CLI run as dryRun mode
+  normalize?: string // normalization ways for locale messages or resource
 }
 
-type ProviderPushResource = {
-  mode: ProviderPushMode
-  files?: ProviderPushFileInfo[]
-  messages?: LocaleMessages
-}
+/**
+ *  Provider Push Arguments
+ */
+type PushArguments = {
+  messages: LocaleMessages // the locale messages that push to localization service
+} & CommonArguments
 
-type ProviderPullResource = LocaleMessages
+/**
+ *  Provider Pull Arguments
+ */
+type PullArguments = {
+  locales: Locale[] // locales that pull from localization service, if empty, you must pull the all locale messages
+} & CommonArguments
 
 /**
  *  ProviderConfiguration provider fields structure
  *    e.g.
  *    {
  *      "provider": {
  *        "token": "xxx"
- *      },
- *      "pushMode": "file-path"
+ *      }
  *    }
  */
 interface ProviderConfiguration<T = {}> {
   provider: { [key in keyof ProviderConfigurationValue<T>]: ProviderConfigurationValue<T>[key] }
-  pushMode: ProviderPushMode
 }
 
 type ProviderConfigurationValue<T = {}> = T & { [prop: string]: unknown }

src/commands/pull.ts

@@ -15,7 +15,7 @@ import {
   loadProviderConf,
   DEFUALT_CONF
 } from '../utils'
-import { ProviderPullResource, Locale, LocaleMessage } from '../../types'
+import { LocaleMessages, Locale, LocaleMessage } from '../../types'
 
 type PullOptions = {
   provider: string
@@ -91,7 +91,7 @@ export const handler = async (args: Arguments<PullOptions>): Promise<unknown> =>
     const locales = args.locales?.split(',').filter(p => p) as Locale[] || []
     const provider = ProviderFactory(conf)
     const resource = await provider.pull({ locales, dryRun, normalize })
-    await applyPullResource(args.output, resource, args.dryRun)
+    await applyPullLocaleMessages(args.output, resource, args.dryRun)
     // TODO: should refactor console message
     console.log('pull success')
   } catch (e) {
@@ -100,9 +100,9 @@ export const handler = async (args: Arguments<PullOptions>): Promise<unknown> =>
   }
 }
 
-async function applyPullResource (output: string, resource: ProviderPullResource, dryRun: boolean) {
-  const locales = Object.keys(resource) as Locale[]
-  debug('applyPullResource', resource, locales, dryRun)
+async function applyPullLocaleMessages (output: string, messages: LocaleMessages, dryRun: boolean) {
+  const locales = Object.keys(messages) as Locale[]
+  debug('applyPullLocaleMessages', messages, locales, dryRun)
   // wrap mkdir with dryRun
   const mkdir = async (output: string) => {
     return !dryRun
@@ -122,7 +122,7 @@ async function applyPullResource (output: string, resource: ProviderPullResource
   // run!
   await mkdir(output)
   for (const locale of locales) {
-    await writeFile(output, locale, resource[locale])
+    await writeFile(output, locale, messages[locale])
   }
 }
 

src/commands/push.ts

@@ -13,10 +13,7 @@ import glob from 'glob'
 import { debug as Debug } from 'debug'
 const debug = Debug('vue-i18n-locale-message:commands:push')
 
-import {
-  ProviderPushResource,
-  ProviderPushMode
-} from '../../types'
+import { LocaleMessages } from '../../types'
 
 type PushOptions = {
   provider: string
@@ -98,17 +95,17 @@ export const handler = async (args: Arguments<PushOptions>): Promise<unknown> =>
   const confPath = resolveProviderConf(args.provider, args.conf)
   const conf = loadProviderConf(confPath) || DEFUALT_CONF
 
-  let resource
+  let messages
   try {
-    resource = getProviderPushResource(args, conf.pushMode)
+    messages = getLocaleMessages(args)
   } catch (e) {
     console.log(e.message)
     return
   }
 
   try {
     const provider = ProviderFactory(conf)
-    await provider.push({ resource, dryRun, normalize })
+    await provider.push({ messages, dryRun, normalize })
     // TODO: should refactor console message
     console.log('push success')
   } catch (e) {
@@ -117,28 +114,14 @@ export const handler = async (args: Arguments<PushOptions>): Promise<unknown> =>
   }
 }
 
-function getProviderPushResource (args: Arguments<PushOptions>, mode: ProviderPushMode): ProviderPushResource {
-  const resource = { mode } as ProviderPushResource
-  debug(`getProviderPushResource: mode=${mode}`)
-
-  if (mode === 'locale-message') {
-    resource.messages = {}
-  } else { // 'file-path'
-    resource.files = []
-  }
+function getLocaleMessages (args: Arguments<PushOptions>): LocaleMessages {
+  let messages = {} as LocaleMessages
 
   if (args.target) {
     const targetPath = resolve(args.target)
     const parsed = path.parse(targetPath)
     const locale = args.locale ? args.locale : parsed.name
-    if (mode === 'locale-message') {
-      resource.messages = Object.assign(resource.messages, { [locale]: require(targetPath) })
-    } else { // 'file-path'
-      resource.files?.push({
-        locale,
-        path: targetPath
-      })
-    }
+    messages = Object.assign(messages, { [locale]: require(targetPath) })
   } else if (args.targetPaths) {
     const filenameMatch = args.filenameMatch
     if (!filenameMatch) {
@@ -155,14 +138,7 @@ function getProviderPushResource (args: Arguments<PushOptions>, mode: ProviderPu
         debug('regex match', match, fullPath)
         if (match && match[1]) {
           const locale = match[1]
-          if (mode === 'locale-message') {
-            resource.messages = Object.assign(resource.messages, { [locale]: require(fullPath) })
-          } else { // 'file-path'
-            resource.files?.push({
-              locale,
-              path: fullPath
-            })
-          }
+          messages = Object.assign(messages, { [locale]: require(fullPath) })
         } else {
           // TODO: should refactor console message
           console.log(`${fullPath} is not matched with ${filenameMatch}`)
@@ -171,7 +147,7 @@ function getProviderPushResource (args: Arguments<PushOptions>, mode: ProviderPu
     })
   }
 
-  return resource
+  return messages
 }
 
 export default {

test/commands/__mocks__/404-provider.js

@@ -1 +1 @@
-throw new Error('cannot find module')
+throw new Error('cannot find module')

test/commands/__mocks__/l10n-service-provider.js

@@ -3,7 +3,7 @@ class L10nServiceProvider {
     this._options = options
   }
 
-  async push (resource, dryRun) {
+  async push (messsages, dryRun) {
     return
   }
 

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

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

test/commands/pull.test.ts

@@ -100,8 +100,7 @@ test('--conf option', async () => {
   })
 
   expect(L10nServiceProvider).toHaveBeenCalledWith({
-    provider: { token: 'xxx' },
-    pushMode: 'file-path'
+    provider: { token: 'xxx' }
   })
 })
 
@@ -118,8 +117,7 @@ test('--conf option omit', async () => {
   })
 
   expect(L10nOmitServiceProvider).toHaveBeenCalledWith({
-    provider: { token: 'yyy' },
-    pushMode: 'file-path'
+    provider: { token: 'yyy' }
   })
 })
 

test/commands/push.test.ts

@@ -94,11 +94,8 @@ test('--target option', async () => {
   })
 
   expect(mockPush).toHaveBeenCalledWith({
-    resource: {
-      messages: {
-        en: { hello: 'world' }
-      },
-      mode: 'locale-message'
+    messages: {
+      en: { hello: 'world' }
     },
     dryRun: false,
     normalize: undefined
@@ -119,11 +116,8 @@ test('--locale option', async () => {
   })
 
   expect(mockPush).toHaveBeenCalledWith({
-    resource: {
-      messages: {
-        ja: { hello: '世界' }
-      },
-      mode: 'locale-message'
+    messages: {
+      ja: { hello: '世界' }
     },
     dryRun: false,
     normalize: undefined
@@ -145,16 +139,11 @@ test('--conf option', async () => {
   })
 
   expect(L10nServiceProvider).toHaveBeenCalledWith({
-    provider: { token: 'xxx' },
-    pushMode: 'file-path'
+    provider: { token: 'xxx' }
   })
   expect(mockPush).toHaveBeenCalledWith({
-    resource: {
-      files: [{
-        locale: 'en',
-        path: path.resolve(TARGET_LOCALE)
-      }],
-      mode: 'file-path'
+    messages: {
+      en: { hello: 'world' }
     },
     dryRun: false,
     normalize: undefined
@@ -173,8 +162,7 @@ test('--conf option omit', async () => {
   })
 
   expect(L10nOmitServiceProvider).toHaveBeenCalledWith({
-    provider: { token: 'yyy' },
-    pushMode: 'file-path'
+    provider: { token: 'yyy' }
   })
 })
 
@@ -192,20 +180,17 @@ test('--target-paths option', async () => {
   })
 
   expect(mockPush).toHaveBeenCalledWith({
-    resource: {
-      messages: {
-        en: {
-          hello: 'world'
-        },
-        lang: {
-          hello: '世界'
-        },
-        ja: {
-          hello: 'こんにちわわわ！',
-          world: 'ザ・ワールド'
-        }
+    messages: {
+      en: {
+        hello: 'world'
+      },
+      lang: {
+        hello: '世界'
       },
-      mode: 'locale-message'
+      ja: {
+        hello: 'こんにちわわわ！',
+        world: 'ザ・ワールド'
+      }
     },
     dryRun: false,
     normalize: undefined
@@ -242,11 +227,8 @@ test('--dry-run option', async () => {
   })
 
   expect(mockPush).toHaveBeenCalledWith({
-    resource: {
-      messages: {
-        ja: { hello: '世界' }
-      },
-      mode: 'locale-message'
+    messages: {
+      ja: { hello: '世界' }
     },
     dryRun: true,
     normalize: undefined
@@ -267,11 +249,8 @@ test('--normalize option', async () => {
   })
 
   expect(mockPush).toHaveBeenCalledWith({
-    resource: {
-      messages: {
-        ja: { hello: '世界' }
-      },
-      mode: 'locale-message'
+    messages: {
+      ja: { hello: '世界' }
     },
     dryRun: false,
     normalize: 'flat'

test/fixtures/conf/l10n-service-provider-conf.json

@@ -1,6 +1,5 @@
 {
   "provider": {
     "token": "xxx"
-  },
-  "pushMode": "file-path"
+  }
 }