status feature (#50)

* fix lint errors

* feat: status command

* add docs for status

* add release workflow

Author: kazupon

.eslintrc.js

@@ -7,6 +7,9 @@ module.exports = {
     jest: true
   },
   extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
     'plugin:vue-libs/recommended'
   ],
   plugins: [
@@ -18,7 +21,10 @@ module.exports = {
     sourceType: 'module'
   },
   rules: {
-    'no-unused-vars': 'off', // HACK: due to override with @typescript-eslint/no-unused-vars
-    '@typescript-eslint/no-unused-vars': [2, { 'vars': 'all', 'args': 'none' }]
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/member-delimiter-style': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/explicit-function-return-type': 'off',
+    'no-unused-vars': 'off' // HACK: due to duplicate with @typescript-eslint/no-unused-vars
   }
 }

.github/workflows/release.yml

@@ -0,0 +1,29 @@
+name: Release
+
+on:
+  pull_request:
+    types:
+      - closed
+
+jobs:
+  release:
+    name: Release
+    if: github.event.pull_request.merged == true && contains(github.event.pull_request.labels.*.name, 'release')
+    runs-on: Ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-node@v1
+        with:
+          registry-url: "https://registry.npmjs.org"
+      - run: git switch master
+      - run: |
+          if [ -f "yarn.lock" ]; then
+            yarn install
+          else
+            npm install
+          fi
+      - run: npm run release:trigger
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
+          SLACK_INCOMING_HOOK: ${{ secrets.SLACK_INCOMING_HOOK }}

README.md

@@ -49,12 +49,14 @@ yarn global vue-i18n-locale-message
 - API
   - squeeze the meta of locale messages from `i18n` custom block
   - infuse the meta of locale messages to `i18n` custom block
+  - get translation status from localization service
 - CLI
-  - 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
-  - diff locale messages between local and localization service
+  - squeeze: squeeze the locale messages from `i18n` custom block
+  - infuse: infuse the locale messages to `i18n` custom block
+  - push: push the locale messages to localization service
+  - pull: pull the locale mesagees from localization service
+  - diff: diff locale messages between local and localization service
+  - status: indicate translation status from localization service
 
 ## :rocket: Usages
 
@@ -138,6 +140,13 @@ vue-i18n-locale-message diff --provider=l10n-service-provider \
   --filename-match=^([\\w]*)\\.json
 ```
 
+#### Status
+```sh
+vue-i18n-locale-message status --provider=l10n-service-provider \
+  --conf=110n-service-provider-conf.json
+```
+
+
 ## :book: API: Specifications
 
 <p align="center"><img width="476px" height="544px" src="./assets/api-usage-image.png" alt="API Usage Image"></p>
@@ -166,18 +175,36 @@ Infuse the meta of locale messages to i18n custom block at single-file component
 
 `infuse` function will return new single-file components information that is updated with the single-file components information specified as `sources` and  the meta of locale message as `meta`.
 
+### status (options: TranslationStatusOptions): Promise<TranslationStatus[]>
+
+  * **Arguments:**
+    * `{options}
+      * `provider`: The target localization service provider, required, same `provider` option of `status` command
+      * `conf`: The json file configration of localization service provider, same `conf` option of `status` command
+      * `locales`: For some locales of translation status, same `locales` option of `status` command
+  * **Return:** `Promise<TranslationStatus[]>`
+
+
 ## :book: Provider: Specifications
 
 You can use the `push` or `pull` commands to push the locale message to the localization service as a resource for that service, and also to pull resources from the l10n service as the locale message.
 
 <p align="center"><img src="./assets/push-pull-command-image.png" alt="Push and Pull Image"></p>
 
-When you run `push`, `pull` and `diff` commands, you need the provider that implements the following.
+When you run the following commands,
+
+  - `push`
+  - `pull`
+  - `diff`
+  - `status`
+
+you need the provider that implements the following.
 
 - export provider factory function
 - provider factory function must return a provider object that have the following I/F:
   - `push` method
   - `pull` method
+  - `status` method
 
 The type definition with TypeScript is as follows:
 
@@ -187,6 +214,14 @@ The type definition with TypeScript is as follows:
  */
 type ProviderFactory<T = {}> = (configration: ProviderConfiguration<T>) => Provider
 
+/**
+ *  Translation Status
+ */
+export type TranslationStatus = {
+  locale: Locale  // target locale
+  percentage: number  // translation percentage
+}
+
 /**
  *  Provider interface
  */
@@ -199,6 +234,10 @@ interface Provider {
    * pull the locale messages from localization service
    */
   pull (args: PullArguments): Promise<LocaleMessages>
+  /**
+   * indicate translation status from localization service
+   */
+  status (args: StatusArguments): Promise<TranslationStatus[]>
 }
 
 type CommonArguments = {
@@ -220,6 +259,13 @@ type PullArguments = {
   locales: Locale[] // locales that pull from localization service, if empty, you must pull the all locale messages
 } & CommonArguments
 
+/**
+ *  Provider Status Arguments
+ */
+export type StatusArguments = {
+  locales: Locale[] // locales that indicate translation status from localization service, if empty, you must indicate translation status all locales
+}
+
 /**
  *  ProviderConfiguration provider fields structure
  *    e.g.

package.json

@@ -92,7 +92,7 @@
     "build:watch": "tsc -p . --watch",
     "clean": "rm -rf ./coverage",
     "coverage": "opener coverage/lcov-report/index.html",
-    "lint": "eslint ./src ./test --ext .ts",
+    "lint": "eslint ./src ./test --ext .ts --ignore-pattern \"*.test.*\"",
     "release:prepare": "shipjs prepare",
     "release:trigger": "shipjs trigger",
     "test": "npm run lint && npm run test:types && npm run test:cover",

src/commands/infuse.ts

@@ -148,8 +148,8 @@ function getTargetLocaleMessages (messages: LocaleMessages, hierarchy: string[])
 
     const obj = messages[locale]
     if (obj) {
-      let o: any = obj
-      let prev: any = null
+      let o: any = obj // eslint-disable-line
+      let prev: any = null // eslint-disable-line
       const h = hierarchy.concat()
       while (h.length > 0) {
         const key = h.shift()

src/commands/squeeze.ts

@@ -70,7 +70,7 @@ function generate (meta: MetaLocaleMessage): LocaleMessages {
         if (block.messages[locale]) {
           const localeMessages = messages[locale]
           const localeBlockMessages = block.messages[locale]
-          let target: any = localeMessages
+          let target: any = localeMessages // eslint-disable-line
           const hierarchy = parsed.hierarchy.concat()
           while (hierarchy.length >= 0) {
             const key = hierarchy.shift()

src/commands/status.ts

@@ -0,0 +1,58 @@
+import { Arguments, Argv } from 'yargs'
+
+import { debug as Debug } from 'debug'
+const debug = Debug('vue-i18n-locale-message:commands:status')
+
+import { getTranslationStatus } from '../utils'
+import { TranslationStatusOptions } from '../../types'
+
+type StatusOptions = TranslationStatusOptions
+
+export const command = 'status'
+export const aliases = 'st'
+export const describe = 'indicate translation status from localization service'
+
+export const builder = (args: Argv): Argv<StatusOptions> => {
+  return args
+    .option('provider', {
+      type: 'string',
+      alias: 'p',
+      describe: 'the target localization service provider',
+      demandOption: true
+    })
+    .option('conf', {
+      type: 'string',
+      alias: 'c',
+      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('locales', {
+      type: 'string',
+      alias: 'l',
+      default: '',
+      describe: `option for some locales of translation status, you can also be specified multi locale with comma delimiter. if it's not specified indicate all locale translation status`
+    })
+}
+
+export const handler = async (args: Arguments<StatusOptions>): Promise<unknown> => {
+  try {
+    const { provider, conf, locales } = args
+    const status = await getTranslationStatus({ provider, conf, locales })
+    debug('raw status', status)
+    // TODO: should be refactored console outputing!
+    status.forEach(st => {
+      console.log(`${st.locale}: ${st.percentage} %`)
+    })
+  } catch (e) {
+    console.error('status fail', e)
+  }
+
+  return Promise.resolve()
+}
+
+export default {
+  command,
+  aliases,
+  describe,
+  builder,
+  handler
+}

src/index.ts

@@ -1,7 +1,9 @@
 import squeeze from './squeezer'
 import infuse from './infuser'
+import { getTranslationStatus as status } from './utils'
 
 export {
   squeeze,
-  infuse
+  infuse,
+  status
 }

src/infuser.ts

@@ -56,7 +56,7 @@ function buildContent (i18nBlocks: SFCI18nBlock[], raw: string, blocks: SFCBlock
       const i18nBlock = i18nBlocks[i18nBlockCounter]
       debug(`meta.lang = ${i18nBlock.lang}, block.lang = ${lang}, meta.locale = ${i18nBlock.locale}, block.locale = ${locale}`)
 
-      let messages: any = null
+      let messages: any = null // eslint-disable-line
       if (lang === i18nBlock.lang && locale === i18nBlock.locale) {
         if (locale) {
           messages = i18nBlock.messages[locale]

src/utils.ts

@@ -2,7 +2,14 @@ import { Arguments } from 'yargs'
 import { SFCDescriptor } from 'vue-template-compiler'
 import { SFCFileInfo, FormatOptions } from '../types'
 import { VueTemplateCompiler } from '@vue/component-compiler-utils/dist/types'
-import { LocaleMessages, ProviderFactory, ProviderConfiguration } from '../types'
+import {
+  Locale,
+  LocaleMessages,
+  ProviderFactory,
+  ProviderConfiguration,
+  TranslationStatusOptions,
+  TranslationStatus
+} from '../types'
 
 import { parse } from '@vue/component-compiler-utils'
 import * as compiler from 'vue-template-compiler'
@@ -73,6 +80,7 @@ export function parsePath (basePath: string, targetPath: string) {
   }
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function parseContent (content: string, lang: string): any {
   switch (lang) {
     case 'yaml':
@@ -86,6 +94,7 @@ export function parseContent (content: string, lang: string): any {
   }
 }
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
 export function stringifyContent (content: any, lang: string, options?: FormatOptions): string {
   const indent = options?.intend || 2
   const eof = options?.eof || '\n'
@@ -153,7 +162,7 @@ export function loadProvider (provider: string): ProviderFactory | null {
     } else {
       mod = m as ProviderFactory
     }
-  } catch (e) { }
+  } catch (e) { } // eslint-disable-line
   return mod
 }
 
@@ -162,7 +171,7 @@ export function loadProviderConf (confPath: string): ProviderConfiguration {
   try {
     // TODO: should validate I/F checking & dynamic importing
     conf = require(confPath) as ProviderConfiguration
-  } catch (e) { }
+  } catch (e) { } // eslint-disable-line
   return conf
 }
 
@@ -201,3 +210,18 @@ export function getLocaleMessages (args: Arguments<PushableOptions>): LocaleMess
 
   return messages
 }
+
+export async function getTranslationStatus (options: TranslationStatusOptions): Promise<TranslationStatus[]> {
+  const ProviderFactory = loadProvider(options.provider)
+  if (ProviderFactory === null) {
+    return Promise.reject(new Error(`Not found ${options.provider} provider`))
+  }
+
+  const confPath = resolveProviderConf(options.provider, options.conf)
+  const conf = loadProviderConf(confPath) || DEFUALT_CONF
+
+  const locales = options.locales?.split(',').filter(p => p) as Locale[] || []
+  const provider = ProviderFactory(conf)
+  const status = await provider.status({ locales })
+  return Promise.resolve(status)
+}