feat: support multi-language with EN and zh-CN

Author: chengpeiquan

config.json

@@ -1,4 +1,5 @@
 {
+  "lang": "zh",
   "authors": [
     "程沛权",
     "chengpeiquan"
@@ -9,11 +10,13 @@
   ],
   "repos": [
     "D:\\Project\\npm-project\\vue-picture-cropper",
-    "D:\\Project\\npm-project\\vite-plugin-banner"
+    "D:\\Project\\npm-project\\vue-baidu-analytics",
+    "D:\\Project\\npm-project\\vue-cnzz-analytics"
   ],
   "format": {
     "vue-picture-cropper": "Vue Picture Cropper",
-    "vite-plugin-banner": "Vite Plugin Banner"
+    "vue-baidu-analytics": "Vue Baidu Analytics",
+    "vue-cnzz-analytics": "Vue CNZZ Analytics"
   },
   "includes": [
     "feat",

src/index.js

@@ -10,23 +10,32 @@ function start() {
   try {
     const config = getConfig()
     if (!config) return
-    const { authors, dateRange, repos, format, includes, excludes } = config
+    const { lang, authors, dateRange, repos, format, includes, excludes } =
+      config
+    const isEN = lang === 'en'
     const startTime = dateRange[0]
     const endTime = dateRange[1]
     const result = {}
-    console.log(`正在分析 ${repos.length} 个仓库的 Log ，请耐心等待…`)
 
-    // 创建正则
+    console.log(
+      isEN
+        ? `Analyzing the Log of ${repos.length} repo${
+            repos.length > 1 ? 's' : ''
+          }, please be patient...`
+        : `正在分析 ${repos.length} 个仓库的 Log ，请耐心等待…`
+    )
+
+    // Create regular expression
     const reg = {
       author: new RegExp(authors.join('|'), 'gim'),
       include: new RegExp(includes.join('|'), 'gim'),
       exclude: new RegExp(excludes.join('|'), 'gim'),
     }
 
-    // 遍历仓库
+    // The reports use repo to split paragraphs
     const allLogs = []
     repos.forEach((repo) => {
-      // 获取仓库名称
+      // Get the repo name
       const repoName = getRepoName(repo, format)
       if (!result[repoName]) {
         result[repoName] = {
@@ -40,15 +49,15 @@ function start() {
         }
       }
 
-      // 要执行的命令
+      // Create CMDs
       const cmds = [
         `cd ${resolve(repo)}`,
         'git pull',
         `git log --pretty=format:"%an|||%ae|||%s|||'%h|||%ad"`,
       ]
       const cmd = cmds.join(' && ')
 
-      // 获取Git操作记录
+      // Get commit records from git repo
       const res = execSync(cmd)
       const str = String(res)
       const logs = str
@@ -57,16 +66,16 @@ function start() {
         .filter((log) => reg.include.test(log))
         .filter((log) => !reg.exclude.test(log))
 
-      // 合并记录
+      // Meger all logs
       logs.forEach((log) => allLogs.push(`${repoName}|||${log}`))
     })
 
-    // 去重
+    // Deduplicate
     const uniqueLogs = [...new Set(allLogs)]
 
-    // 提取目标数据
+    // Get target data
     const targetList = uniqueLogs
-      .map((log) => formatLog(log))
+      .map((log) => formatLog({ log, isEN }))
       .filter((log) => {
         const { unix } = log
         return unix >= startTime && unix <= endTime
@@ -75,14 +84,14 @@ function start() {
         return a.unix - b.unix
       })
 
-    // 归类
+    // Classify
     targetList.forEach((item) => {
       const { repo, type } = item
       result[repo][type].push(item)
     })
 
-    // 写入报告
-    saveReport(result)
+    // Save
+    saveReport({ result, isEN })
   } catch (e) {
     confirmExit(e)
   }

src/libs/confirmExit.js

@@ -1,10 +1,12 @@
 /**
- * 退出确认
+ * Confirm Exit
+ * @param {string} msg - The message to displayed on console.
+ * @param {boolean} isEN - Check whether the language is English.
  */
-module.exports = function (msg) {
+module.exports = function ({ msg, isEN }) {
   console.log('')
   console.log(msg)
-  console.log(`按下任意键退出…`)
+  console.log(isEN ? `Press any key to exit…` : `按下任意键退出…`)
   process.stdin.setRawMode(true)
   process.stdin.resume()
   process.stdin.on('data', process.exit.bind(process, 0))

src/libs/formatCommit.js

@@ -1,33 +1,42 @@
-module.exports = function (commit) {
-  // 提交类型
+/**
+ * Format Commit
+ * @param {object} commit - A commit object
+ * @param {boolean} isEN - Check whether the language is English.
+ * @returns
+ *  type: the commit type
+ *  category: the text about commit type
+ *  msg: the commit message
+ */
+module.exports = function ({ commit, isEN }) {
+  // Get the text according to the type
   let type = 'chore'
-  let category = '代码优化'
+  let category = isEN ? 'Chores' : '其他优化'
   if (commit.startsWith('feat')) {
     type = 'feat'
-    category = '功能开发'
+    category = isEN ? 'Features' : '功能开发'
   }
   if (commit.startsWith('fix')) {
     type = 'fix'
-    category = 'BUG修复'
+    category = isEN ? 'Bug Fixes' : 'BUG修复'
   }
   if (commit.startsWith('docs')) {
     type = 'docs'
-    category = '完善文档'
+    category = isEN ? 'Documentation' : '完善文档'
   }
   if (commit.startsWith('style')) {
     type = 'style'
-    category = '优化样式'
+    category = isEN ? 'Optimized Style' : '优化样式'
   }
   if (commit.startsWith('refactor')) {
     type = 'refactor'
-    category = '代码重构'
+    category = isEN ? 'Refactored' : '代码重构'
   }
   if (commit.startsWith('test')) {
     type = 'test'
-    category = '测试用例'
+    category = isEN ? 'Test Cases' : '测试用例'
   }
 
-  // 截取提交内容
+  // Extract messages from the commit log
   let msg = commit
   const index = commit.indexOf(':')
   if (index > -1) {

src/libs/formatLog.js

@@ -1,14 +1,23 @@
 const dayjs = require('dayjs')
 const formatCommit = require('./formatCommit')
 
-module.exports = function (log) {
+/**
+ * Format Log
+ * @param {string} log - The line content from log
+ * @param {boolean} isEN - Check whether the language is English.
+ * @returns An object about log
+ */
+module.exports = function ({ log, isEN }) {
   const arr = String(log).split('|||')
   return {
     repo: arr[0] || '',
     author: arr[1] || '',
     email: arr[2] || '',
     commit: arr[3] || '',
-    ...formatCommit(arr[3]),
+    ...formatCommit({
+      commit: arr[3],
+      isEN,
+    }),
     hash: arr[4].replace(/'/, '#') || '',
     time: dayjs(arr[5]).format('YYYY-MM-DD HH:mm:ss'),
     unix: dayjs(arr[5]).unix() * 1000,

src/libs/getConfig.js

@@ -4,28 +4,49 @@ const { cwd } = require('process')
 const dayjs = require('dayjs')
 const confirmExit = require('./confirmExit')
 
+/**
+ * Get Config
+ * @description Format content from configuration file and check validity.
+ * @tips The `dateRange` will be transformed from `string[]` to `number[]`
+ * @returns An object from the configuration file
+ */
 module.exports = function () {
+  let isEN = true
+
   try {
+    // Read content from configuration file
     const configFile = resolve(`${cwd()}/config.json`)
     const configStr = readFileSync(configFile)
     if (!configStr) {
       return null
     }
 
-    // 格式化配置
     const config = JSON.parse(configStr)
     const { dateRange } = config
 
-    // 校验数据
+    // Check validity
     const keys = Object.keys(config)
     for (let i = 0; i < keys.length; i++) {
       const key = keys[i]
       const value = config[key]
 
-      // 格式化是个对象
+      // Check language, Set the default language to English
+      if (key === 'lang') {
+        if (!['en', 'zh'].includes(value)) {
+          config['lang'] = 'en'
+        }
+      }
+      isEN = config['lang'] === 'en'
+
+      // Check object
       if (key === 'format') {
         if (Object.prototype.toString.call(value) !== '[object Object]') {
-          confirmExit(`${key} 必须是一个 { [key: string]: string } 对象`)
+          confirmExit({
+            msg: isEN
+              ? `${key} must be an object as { [key: string]: string }`
+              : `${key} 必须是一个 { [key: string]: string } 对象`,
+            isEN,
+          })
           return null
         }
 
@@ -34,35 +55,61 @@ module.exports = function () {
             Object.hasOwnProperty.call(value, k) &&
             typeof value[k] !== 'string'
           ) {
-            confirmExit(`${key} 的 ${k} 的值必须是一个 string 字符串`)
+            confirmExit({
+              msg: isEN
+                ? `The value of ${k} of ${key} must be a string`
+                : `${key} 的 ${k} 的值必须是一个 string 字符串`,
+              isEN,
+            })
             return null
           }
         }
       }
-      // 其他都是数组
-      else {
+
+      // Check array
+      if (
+        ['authors', 'dateRange', 'repos', 'includes', 'excludes'].includes(key)
+      ) {
         if (!Array.isArray(value)) {
-          confirmExit(`${key} 必须是一个 string[] 数组`)
+          confirmExit({
+            msg: isEN
+              ? `${key} must be a string[] array`
+              : `${key} 必须是一个 string[] 数组`,
+            isEN,
+          })
           return null
         }
         if (['authors', 'repos'].includes(key) && !value.length) {
-          confirmExit(`${key} 不能为空`)
+          confirmExit({
+            msg: isEN ? `${key} cannot be empty` : `${key} 不能为空`,
+            isEN,
+          })
           return null
         }
         if (value.length) {
           for (let e = 0; e < value.length; e++) {
             if (typeof value[e] !== 'string') {
-              confirmExit(`${key} 的每个 item 都必须是 string 格式`)
+              confirmExit({
+                msg: isEN
+                  ? `Each item of ${key} must be a string`
+                  : `${key} 的每个 item 都必须是 string 格式`,
+                isEN,
+              })
               return null
             }
           }
         }
       }
     }
 
-    // 处理起止日期
+    // Handle start date and end date, transform to timestamp
     if (dateRange.length && dateRange.length !== 2) {
-      confirmExit(`dateRange 只能有 2 个值，[开始日期, 结束日期]`)
+      confirmExit({
+        msg: isEN
+          ? `dateRange can only have 2 values, [start date, end date]`
+          : `dateRange 只能有 2 个值，[开始日期, 结束日期]`,
+        isEN,
+      })
       return null
     }
     let startTime = dayjs().startOf('day').unix() * 1000
@@ -75,7 +122,10 @@ module.exports = function () {
 
     return config
   } catch (e) {
-    confirmExit(e)
+    confirmExit({
+      msg: e,
+      isEN,
+    })
     return null
   }
 }

src/libs/getRepoName.js

@@ -1,5 +1,11 @@
 const { resolve, sep } = require('path')
 
+/**
+ * Get Repo Name
+ * @param {*} repoDir - The item in configuration `config.repos`
+ * @param {*} format - The configuration `config.format`
+ * @returns The repository name
+ */
 module.exports = function (repoDir, format) {
   const arr = resolve(repoDir).split(sep)
   if (!arr.length) {