feat: i18n (#3)

Author: kazupon

README.md

@@ -2,8 +2,6 @@
 
 CLI Tooling for i18n development
 
-> WIP :construction:
-
 ## :cd: Installation
 
 ### npm
@@ -20,13 +18,28 @@ yarn global @intlify/cli
 
 ## :rocket: Usage
 
-TODO:
+```
+Usage: intlify <command> [options]
+
+Commands:
+  intlify compile  compile the i18n resources                          [aliases: cp]
+
+Options:
+  --help     Show help                                                 [boolean]
+  --version  Show version number                                       [boolean]
+```
 
 ## :handshake: API
 
 About details, See the [API References](https://github.com/intlify/cli/blob/master/api.md)
 
 
+## :globe_with_meridians: I18n
+
+Intlify cli is supporting for I18n.
+
+If you would like to localiize Intlify CLI, you can contribute i18n resource to [locales](https://github.com/intlify/cli/blob/master/locales) directory.
+
 ## :scroll: Changelog
 Details changes for each release are documented in the [CHANGELOG.md](https://github.com/intlify/cli/blob/master/CHANGELOG.md).
 

locales/en.json

@@ -0,0 +1,10 @@
+{
+  "Usage: $0 <command> [options]": "Usage: $0 <command> [options]",
+  "compile the i18n resources": "compile the i18n resources",
+  "the i18n resource source path": "the i18n resource source path",
+  "the compiled i18n resource output path": "the compiled i18n resource output path",
+  "Success compilation: {source} -> {output}": "Success compilation: {source} -> {output}",
+  "{source}: Ignore compilation due to not supported '{ext}'": "{source}: Ignore compilation due to not supported '{ext}'",
+  "Warning compilation: {source} -> {output}, {msg}": "Warning compilation: {source} -> {output}, {msg}",
+  "Error compilation: {source} -> {output}, {msg}": "Error compilation: {source} -> {output}, {msg}"
+}

locales/ja.json

@@ -0,0 +1,10 @@
+{
+  "Usage: $0 <command> [options]": "使い方: $0 <command> [options]",
+  "compile the i18n resources": "i18nリソースのコンパイル",
+  "the i18n resource source path": "i18n リソースのソースパス",
+  "the compiled i18n resource output path": "コンパイルされた i18n リソースの出力先パス",
+  "Success compilation: {source} -> {output}": "コンパイル成功: {source} -> {output}",
+  "{source}: Ignore compilation due to not supported '{ext}'": "{source}: '{ext}' がサポートされていないためコンパルを無視します",
+  "Warning compilation: {source} -> {output}, {msg}": "コンパイル警告: {source} -> {output}, {msg}",
+  "Error compilation: {source} -> {output}, {msg}": "コンパイルエラー: {source} -> {output}, {msg}"
+}

src/cli.ts

@@ -1,18 +1,21 @@
 import * as yargs from 'yargs'
+import { initI18n, t } from './i18n'
+;(async () => {
+  await initI18n()
+  yargs
+    .usage(t('Usage: $0 <command> [options]'))
+    .commandDir('./commands')
+    .demandCommand()
+    .help()
+    .version().argv
 
-yargs
-  .usage('Usage: $0 <command> [options]')
-  .commandDir('./commands')
-  .demandCommand()
-  .help()
-  .version().argv
+  process.on('uncaughtException', err => {
+    console.error(`uncaught exception: ${err}\n`)
+    process.exit(1)
+  })
 
-process.on('uncaughtException', err => {
-  console.error(`uncaught exception: ${err}\n`)
-  process.exit(1)
-})
-
-process.on('unhandledRejection', (reason, p) => {
-  console.error('unhandled rejection at:', p, 'reason:', reason)
-  process.exit(1)
-})
+  process.on('unhandledRejection', (reason, p) => {
+    console.error('unhandled rejection at:', p, 'reason:', reason)
+    process.exit(1)
+  })
+})()

src/commands/compile.ts

@@ -1,8 +1,10 @@
 import path from 'path'
 import chalk from 'chalk'
-import { Arguments, Argv } from 'yargs'
 import { debug as Debug } from 'debug'
 import { CompileErrorCodes, compile } from '../api'
+import { t } from '../i18n'
+
+import type { Arguments, Argv } from 'yargs'
 
 const debug = Debug('@intlify/cli:compile')
 
@@ -13,20 +15,20 @@ type CompileOptions = {
 
 export const command = 'compile'
 export const aliases = 'cp'
-export const describe = 'compile the i18n resources'
+export const describe = t('compile the i18n resources')
 
 export const builder = (args: Argv): Argv<CompileOptions> => {
   return args
     .option('source', {
       type: 'string',
       alias: 's',
-      describe: 'the source i18n resource path',
+      describe: t('the i18n resource source path'),
       demandOption: true
     })
     .option('output', {
       type: 'string',
       alias: 'o',
-      describe: 'the compiled i18n resource output path'
+      describe: t('the compiled i18n resource output path')
     })
 }
 
@@ -37,7 +39,13 @@ export const handler = async (
     args.output != null ? path.resolve(__dirname, args.output) : process.cwd()
   const ret = await compile(args.source, output, {
     onCompile: (source: string, output: string): void => {
-      console.log(chalk.green(`success compilation: ${source} -> ${output}`))
+      console.log(
+        chalk.green(
+          t('Success compilation: {source} -> {output}', {
+            named: { source, output }
+          })
+        )
+      )
     },
     onError: (
       code: number,
@@ -50,18 +58,28 @@ export const handler = async (
           const parsed = path.parse(source)
           console.warn(
             chalk.yellow(
-              `${source}: Ignore compilation due to not supported '${parsed.ext}'`
+              t("{source}: Ignore compilation due to not supported '{ext}'", {
+                named: { ext: parsed.ext }
+              })
             )
           )
           break
         case CompileErrorCodes.INTERNAL_COMPILE_WARNING:
           console.log(
-            chalk.yellow(`warning compilation: ${source} -> ${output}, ${msg}`)
+            chalk.yellow(
+              t('Warning compilation: {source} -> {output}, {msg}', {
+                named: { source, output, msg }
+              })
+            )
           )
           break
         case CompileErrorCodes.INTERNAL_COMPILE_ERROR:
           console.log(
-            chalk.green(`error compilation: ${source} -> ${output}, ${msg}`)
+            chalk.green(
+              t('Error compilation: {source} -> {output}, {msg}', {
+                named: { source, output, msg }
+              })
+            )
           )
           break
         default:

src/i18n.ts

@@ -0,0 +1,80 @@
+import path from 'path'
+import { promises as fs } from 'fs'
+import { isString } from '@intlify/shared'
+import { createCoreContext, translate } from '@intlify/core'
+import { debug as Debug } from 'debug'
+import i18nResourceSchema from '../locales/en.json'
+
+import type {
+  Locale,
+  LocaleMessages,
+  LocaleMessageDictionary,
+  TranslateOptions,
+  CoreContext
+} from '@intlify/core'
+
+const debug = Debug('@intlify/cli:i18n')
+const DEFAULT_LOCALE = 'en-US'
+
+let resources: LocaleMessages | null = null
+let context: CoreContext<unknown, unknown, unknown, string> | null = null
+
+async function loadI18nResources(): Promise<LocaleMessages> {
+  const dirents = await fs.readdir(path.resolve(__dirname, '../../locales'), {
+    withFileTypes: true
+  })
+  return dirents.reduce(async (acc, dir) => {
+    if (dir.isFile()) {
+      const data = await fs.readFile(
+        path.resolve(__dirname, '../../locales', dir.name),
+        { encoding: 'utf-8' }
+      )
+      const { name } = path.parse(dir.name)
+      debug('load i18n resource', name, data)
+      const messages = await acc
+      messages[name] = JSON.parse(data) as LocaleMessageDictionary
+    }
+    return acc
+  }, Promise.resolve({} as LocaleMessages))
+}
+
+export function getLocale(env?: Record<string, unknown>): Locale {
+  env = env || process.env
+  const raw =
+    ((env.LC_ALL || env.LC_MESSAGES || env.LANG || env.LANGUAGE) as string) ||
+    DEFAULT_LOCALE
+  debug('getLocale', raw)
+  return raw.replace(/\.UTF\-8/g, '').replace(/_/g, '-')
+}
+
+export function t<Key extends keyof typeof i18nResourceSchema>(
+  key: Key,
+  options?: TranslateOptions
+): string {
+  if (context == null) {
+    console.error(
+      'cannot initialize CoreContext with @intlify/core createCoreContext'
+    )
+    return key
+  }
+  const ret = translate(context, key, options)
+  return isString(ret) ? ret : key
+}
+
+export async function initI18n() {
+  try {
+    resources = await loadI18nResources()
+    context = createCoreContext({
+      locale: getLocale(),
+      fallbackLocale: DEFAULT_LOCALE,
+      fallbackWarn: false,
+      missingWarn: false,
+      warnHtmlMessage: false,
+      fallbackFormat: true,
+      messages: resources
+    })
+  } catch (e) {
+    debug('load i18n resource errors', e.message)
+    throw e
+  }
+}

test/i18n.test.ts

@@ -0,0 +1,44 @@
+import { getLocale } from '../src/i18n'
+
+let ORG_ENV = {}
+
+beforeEach(() => {
+  jest.resetModules()
+  ORG_ENV = process.env
+  process.env = {}
+})
+
+afterEach(() => {
+  process.env = ORG_ENV
+})
+
+describe('getLocale', () => {
+  test('default', () => {
+    expect(getLocale()).toEqual('en-US')
+  })
+
+  test('LC_ALL', () => {
+    process.env['LC_ALL'] = 'ja_JP'
+    expect(getLocale()).toEqual('ja-JP')
+  })
+
+  test('LC_MESSAGES', () => {
+    process.env['LC_MESSAGES'] = 'ja_JP'
+    expect(getLocale()).toEqual('ja-JP')
+  })
+
+  test('LANG', () => {
+    process.env['LANG'] = 'ja_JP'
+    expect(getLocale()).toEqual('ja-JP')
+  })
+
+  test('LANGUAGE', () => {
+    process.env['LANGUAGE'] = 'ja_JP'
+    expect(getLocale()).toEqual('ja-JP')
+  })
+
+  test('BCP-47', () => {
+    process.env['LC_ALL'] = 'ja-JP'
+    expect(getLocale()).toEqual('ja-JP')
+  })
+})