improve process.exit(1) when the translation is not finished yet (#63)

Author: kazupon

src/commands/status.ts

@@ -12,6 +12,8 @@ export const command = 'status'
 export const aliases = 'st'
 export const describe = 'indicate translation status from localization service'
 
+class TranslationStatusError extends Error {}
+
 export const builder = (args: Argv): Argv<StatusOptions> => {
   return args
     .option('provider', {
@@ -31,22 +33,34 @@ export const builder = (args: Argv): Argv<StatusOptions> => {
       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`
     })
+    .fail((msg, err) => {
+      if (msg) {
+        console.error(msg)
+        process.exit(1)
+      } else {
+        if (err instanceof TranslationStatusError) {
+          console.warn(err.message)
+          process.exit(1)
+        } else {
+          if (err) throw err
+        }
+      }
+    })
 }
 
 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)
-  }
+  // try {
+  const { provider, conf, locales } = args
+  debug(`status args: provider=${provider}, conf=${conf}, locales=${locales}`)
+  const status = await getTranslationStatus({ provider, conf, locales })
+  debug('raw status', status)
+  console.table(status)
+
+  const completes = status.filter(st => st.percentage < 100)
 
-  return Promise.resolve()
+  return completes.length > 0
+    ? Promise.reject(new TranslationStatusError('Translation work in progress'))
+    : Promise.resolve('Translation done')
 }
 
 export default {

test/commands/status.test.ts

@@ -18,47 +18,75 @@ import L10nServiceProvider from '@scope/l10n-service-provider'
 const PROCESS_CWD_TARGET_PATH = path.resolve(__dirname)
 
 let orgCwd // for process.cwd mock
+let orgExit // for process.exit 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
+  process.exit = jest.fn((code => { return 'exit!' as never })) // mock: process.exit
 })
 
 afterEach(() => {
   spyError.mockRestore()
   spyLog.mockRestore()
   jest.clearAllMocks()
+  process.exit = orgExit
   process.cwd = orgCwd
 })
 
 // -----------
 // test cases
 
 test('require options', async () => {
+  // run
+  const status = await import('../../src/commands/status')
+  const cmd = yargs.command(status)
+  await new Promise((resolve, reject) => {
+    cmd.parse(`status`, (err, argv, output) => {
+      err ? reject(err) : resolve(output)
+    })
+  })
+
+  // verify
+  expect(spyError).toBeCalled()
+  expect(process.exit).toHaveBeenCalledWith(1)
+})
+
+test('getTranslationStatus: done', async () => {
+  // setup mocking ...
+  const mockStatusValue = [{
+    locale: 'en',
+    percentage: 100
+  }, {
+    locale: 'ja',
+    percentage: 100
+  }]
+  mockStatus.mockImplementation(({ locales }) => Promise.resolve(mockStatusValue))
+
+  // run
   const status = await import('../../src/commands/status')
   const cmd = yargs.command(status)
-  try {
-    await new Promise((resolve, reject) => {
-      cmd.parse(`status`, (err, argv, output) => {
-        err ? reject(err) : resolve(output)
-      })
+  await new Promise((resolve, reject) => {
+    cmd.parse(`status --provider=@scope/l10n-service-provider`, (err, argv, output) => {
+      err ? reject(err) : resolve(output)
     })
-  } catch (e) {
-    expect(e).toMatchObject({ name: 'YError' })
-  }
+  })
+
+  // verify
+  expect(process.exit).not.toBeCalled()
 })
 
-test('getTranslationStatus: success', async () => {
-  // setup mocks
+test('getTranslationStatus: wip', async () => {
+  // setup mocking ...
   const mockStatusValue = [{
     locale: 'en',
-    percentage: 24.2
+    percentage: 72.4
   }, {
     locale: 'ja',
-    percentage: 100.0
+    percentage: 100
   }]
   mockStatus.mockImplementation(({ locales }) => Promise.resolve(mockStatusValue))
 
@@ -70,4 +98,8 @@ test('getTranslationStatus: success', async () => {
       err ? reject(err) : resolve(output)
     })
   })
+
+  // verify
+  // NOTE: cannot detect process.exit calling ...
+  // expect(process.exit).toHaveBeenCalledWith(1)
 })