bajo 0.2.14 → 0.2.16

package/boot/attach-helper.js

@@ -2,14 +2,9 @@ import buildHelper from './lib/build-helper.js'
 import logger from './lib/logger.js'
 import print from './lib/print.js'
 import fs from 'fs-extra'
-import dayjs from 'dayjs'
-import utc from 'dayjs/plugin/utc.js'
-import customParseFormat from 'dayjs/plugin/customParseFormat.js'
 import deepFreeze from 'deep-freeze-strict'
 import currentLoc from './helper/current-loc.js'
-
-dayjs.extend(utc)
-dayjs.extend(customParseFormat)
+import dayjs from './lib/dayjs.js'
 
 export default async function () {
   this.bajo.helper = await buildHelper.call(this, `${currentLoc(import.meta).dir}/helper`)
@@ -17,9 +12,9 @@ export default async function () {
     if (shallow) Object.freeze(o)
     else deepFreeze(o)
   }
+  this.bajo.helper.dayjs = dayjs
   this.bajo.helper.print = print.call(this)
   this.bajo.helper.log = logger.call(this)
-  this.bajo.helper.dayjs = dayjs
   this.bajo.helper.setImmediate = function () {
     return new Promise((resolve) => {
       setImmediate(() => resolve())

package/boot/helper/parse-object.js

@@ -0,0 +1,38 @@
+import { isPlainObject, isArray, isNumber } from 'lodash-es'
+import ms from 'ms'
+import dayjs from '../lib/dayjs.js'
+import isSet from './is-set.js'
+
+function parseDur (val) {
+  return isNumber(val) ? val : ms(val)
+}
+
+function parseDt (val) {
+  const dt = dayjs(val)
+  if (!dt.isValid()) throw Error(`Unparsed date/time '${val}'`)
+  return dt.toDate()
+}
+
+function parseObject (obj, silent = true) {
+  const keys = Object.keys(obj)
+  keys.forEach(k => {
+    const v = obj[k]
+    if (isPlainObject(v)) obj[k] = parseObject(v)
+    else if (isArray(v)) {
+      v.forEach((i, idx) => {
+        if (isPlainObject(i)) obj[k][idx] = parseObject(i)
+      })
+    } else if (isSet(v)) {
+      try {
+        if (k.slice(-3) === 'Dur') obj[k] = parseDur(v)
+        if (k.slice(-2) === 'Dt') obj[k] = parseDt(v)
+      } catch (err) {
+        obj[k] = undefined
+        if (!silent) throw err
+      }
+    }
+  })
+  return obj
+}
+
+export default parseObject

package/boot/helper/read-config.js

@@ -1,6 +1,7 @@
 import path from 'path'
 import resolvePath from './resolve-path.js'
 import readJson from './read-json.js'
+import parseObject from './parse-object.js'
 import { find, map, isEmpty } from 'lodash-es'
 import error from './error.js'
 import fg from 'fast-glob'
@@ -12,22 +13,22 @@ async function readConfig (file, { pattern, globOptions = {}, ignoreError, defVa
   ext = ext.toLowerCase()
   if (['.mjs', '.js'].includes(ext)) {
     const { handler } = find(this.bajo.configHandlers, { ext })
-    return await handler.call(this, file)
+    return parseObject(await handler.call(this, file))
   }
   if (ext === '.json') return await readJson(file)
   if (!['', '.*'].includes(ext)) {
     const item = find(this.bajo.configHandlers, { ext })
     if (!item) {
       if (!ignoreError) throw error.call(this, 'Can\'t parse \'%s\'', file, { code: 'BAJO_CONFIG_NO_PARSER' })
-      return defValue
+      return parseObject(defValue)
     }
-    return item.handler.call(this, file)
+    return parseObject(item.handler.call(this, file))
   }
   const item = pattern ?? `${fname}.{${map(map(this.bajo.configHandlers, 'ext'), k => k.slice(1)).join(',')}}`
   const files = await fg(item, globOptions)
   if (files.length === 0) {
     if (!ignoreError) throw error.call(this, 'No config file found', { code: 'BAJO_CONFIG_FILE_NOT_FOUND' })
-    return defValue
+    return parseObject(defValue)
   }
   let config = defValue
   for (const f of files) {
@@ -40,7 +41,7 @@ async function readConfig (file, { pattern, globOptions = {}, ignoreError, defVa
     config = await item.handler.call(this, f)
     if (!isEmpty(config)) break
   }
-  return config
+  return parseObject(config)
 }
 
 export default readConfig

package/boot/helper/read-json.js

@@ -1,11 +1,12 @@
 import fs from 'fs-extra'
 import { isEmpty } from 'lodash-es'
+import parseObject from './parse-object.js'
 
 const readJson = (file, thrownNotFound) => {
   if (!fs.existsSync(file) && thrownNotFound) throw new Error('File \'%s\' not found', file)
   let resp = fs.readFileSync(file, 'utf8')
   if (isEmpty(resp)) resp = '{}'
-  return JSON.parse(resp)
+  return parseObject(JSON.parse(resp))
 }
 
 export default readJson

package/boot/helper/save-as-download.js

@@ -10,7 +10,7 @@ async function saveAsDownload (file, obj, printSaved = true) {
   const dir = path.dirname(fname)
   if (!fs.existsSync(dir)) fs.ensureDirSync(dir)
   await fs.writeFile(fname, obj, 'utf8')
-  if (printSaved) print.bora('Saved as \'%s\'', path.resolve(fname), { skipSilence: true }).succeed()
+  if (printSaved) print.succeed('Saved as \'%s\'', path.resolve(fname), { skipSilence: true })
   return fname
 }
 

package/boot/helper/sec-to-hms.js

@@ -1,15 +1,24 @@
-// taken from: https://stackoverflow.com/questions/1322732/convert-seconds-to-hh-mm-ss-with-javascript
+import { padStart } from 'lodash-es'
 
-function secToHms (secs) {
+// based on: https://stackoverflow.com/questions/1322732/convert-seconds-to-hh-mm-ss-with-javascript
+
+function secToHms (secs, ms) {
+  let remain
+  if (ms) {
+    remain = secs % 1000
+    secs = Math.floor(secs / 1000)
+  }
   const secNum = parseInt(secs, 10)
   const hours = Math.floor(secNum / 3600)
   const minutes = Math.floor(secNum / 60) % 60
   const seconds = secNum % 60
 
-  return [hours, minutes, seconds]
+  let hms = [hours, minutes, seconds]
     .map(v => v < 10 ? '0' + v : v)
     .filter((v, i) => v !== '00' || i > 0)
     .join(':')
+  if (ms) hms += '+' + padStart(remain, 3, '0')
+  return hms
 }
 
 export default secToHms

package/boot/helper/spinner.js

@@ -0,0 +1,9 @@
+import { Print } from '../lib/print.js'
+
+function spinner (options) {
+  const print = new Print(options)
+  print.setScope(this)
+  return print
+}
+
+export default spinner

package/boot/index.js

@@ -49,8 +49,8 @@ async function boot (cwd) {
   // boot complete
   const { runHook, log } = scope.bajo.helper
   await runHook('bajo:bootComplete')
-  const elapsed = (new Date() - scope.bajo.runAt).toLocaleString()
-  log.info('Boot process completed in %sms', elapsed)
+  const elapsed = new Date() - scope.bajo.runAt
+  log.info('Boot process completed in %s', scope.bajo.helper.secToHms(elapsed, true))
   // run tool
   await runTool.call(scope)
   return scope

package/boot/lib/dayjs.js

@@ -0,0 +1,8 @@
+import dayjs from 'dayjs'
+import utc from 'dayjs/plugin/utc.js'
+import customParseFormat from 'dayjs/plugin/customParseFormat.js'
+
+dayjs.extend(utc)
+dayjs.extend(customParseFormat)
+
+export default dayjs

package/boot/lib/print.js

@@ -1,82 +1,141 @@
-import bora from './bora.js'
 import Sprintf from 'sprintf-js'
-import { isPlainObject, get, isEmpty } from 'lodash-es'
+import ora from 'ora'
+import { isPlainObject, get } from 'lodash-es'
 import defaultsDeep from '../helper/defaults-deep.js'
-import getPluginName from '../helper/get-plugin-name.js'
 
 const { sprintf } = Sprintf
 
-class Print {
-  constructor (scope) {
-    this.scope = scope
+export class Print {
+  constructor (opts = {}) {
+    this.opts = opts
+    this.startTime = null
   }
 
-  _prep (params) {
-    const [msg, ...args] = params
+  setOpts (args = []) {
+    const { getConfig } = this.scope.bajo.helper
+    const config = getConfig()
     let opts = {}
     if (isPlainObject(args.slice(-1)[0])) opts = args.pop()
-    opts = defaultsDeep(opts, { type: 'bora', exit: false, skipSilent: false })
-    this.opts = opts
-    this.opts.ns = this.opts.ns ?? ['bajoI18N']
-    this.opts.pkg = this.opts.pkg ?? getPluginName.call(this.scope, 2)
-    this.args = args
-    this.msg = msg
+    this.opts.isLog = !config.tool
+    if (this.opts.isLog) this.opts.isEnabled = false
+    this.opts.isSilent = !!(config.silent || this.opts.isSilent)
+    this.opts = defaultsDeep(opts, this.opts)
   }
 
-  formatMsg (params) {
-    this._prep(params)
-    if (isEmpty(this.msg)) return ''
-    const transHandler = get(this, 'scope.bajo.transHandler')
-    const dayjs = get(this, 'scope.bajo.helper')
-    if (transHandler) this.msg = transHandler.call(this, { msg: this.msg, params: this.args, options: this.opts })
-    else this.msg = sprintf(this.msg, ...this.args)
-    if (this.opts.showDatetime && dayjs) this.msg = `[${dayjs().toISOString()}] ${this.msg}`
-    return this.msg
+  setScope (scope) {
+    this.scope = scope
+    const { dayjs } = this.scope.bajo.helper
+    this.startTime = dayjs()
+    this.setOpts()
+    this.ora = ora(this.opts)
   }
 
-  __ (...params) {
-    return this.formatMsg(params)
+  setText (text, ...args) {
+    // const { dayjs } = this.scope.bajo.helper
+    text = this.__(text, ...args)
+    this.setOpts(args)
+    const prefixes = []
+    const texts = []
+    // if (this.opts.showDatetime) prefixes.push('[' + dayjs().toISOString() + ']')
+    if (this.opts.showCounter) texts.push('[' + this.getElapsed() + ']')
+    if (prefixes.length > 0) this.ora.prefixText = this.ora.prefixText + prefixes.join(' ')
+    if (texts.length > 0) text = texts.join(' ') + ' ' + text
+    if (this.opts.isLog) this.info(text, ...args)
+    else this.ora.text = text
+    return this
   }
 
-  output (params, boraMethod = 'succeed', logMethod = 'info', consoleMethod = 'log') {
-    this.formatMsg(params)
-    if (isEmpty(this.msg)) return ''
-    switch (this.opts.type) {
-      case 'bora': bora.call(this.scope, this.opts.ns, this.opts)[boraMethod](this.msg, ...this.args); break
-      case 'log': this.scope.bajo.helper.log[logMethod](this.msg, ...this.args, this.opts); break
-      default: console[consoleMethod](this.msg)
+  __ (text, ...args) {
+    if (text) {
+      const i18n = get(this, 'scope.bajoI18N.instance')
+      if (i18n) {
+        if (isPlainObject(args[0])) text = i18n.t(text, args[0])
+        else text = i18n.t(text, { ns: this.ns, postProcess: 'sprintf', sprintf: args })
+      } else text = sprintf(text, ...args)
     }
-    if (this.opts.exit) process.exit()
+    return text
   }
 
-  fail (...params) {
-    this.output(params, 'fail', 'error', 'error')
+  getElapsed (unit = 'hms') {
+    const { dayjs, secToHms } = this.scope.bajo.helper
+    const u = unit === 'hms' ? 'second' : unit
+    const elapsed = dayjs().diff(this.startTime, u)
+    return unit === 'hms' ? secToHms(elapsed) : elapsed
   }
 
-  succeed (...params) {
-    this.output(params, 'succeed', 'info')
+  start (text, ...args) {
+    this.setOpts(args)
+    if (this.opts.isLog) {
+      this.ora.start()
+      this.info(text, ...args)
+      return this
+    }
+    this.setText(text, ...args)
+    this.ora.start()
+    return this
   }
 
-  warn (...params) {
-    this.output(params, 'warn', 'warn')
+  stop () {
+    this.ora.stop()
+    return this
   }
 
-  info (...params) {
-    this.output(params, 'info')
+  succeed (text, ...args) {
+    const { log } = this.scope.bajo.helper
+    if (this.opts.isLog) return log.info(text, ...args)
+    this.setText(text, ...args)
+    this.ora.succeed()
+    return this
   }
 
-  fatal (...params) {
-    this.output(params, 'fatal', 'error', 'error')
-    process.exit(1)
+  fail (text, ...args) {
+    const { log } = this.scope.bajo.helper
+    if (this.opts.isLog) return log.error(text, ...args)
+    this.setText(text, ...args)
+    this.ora.fail()
+    return this
+  }
+
+  warn (text, ...args) {
+    const { log } = this.scope.bajo.helper
+    if (this.opts.isLog) return log.warn(text, ...args)
+    this.setText(text, ...args)
+    this.ora.warn()
+    return this
   }
 
-  bora (...params) {
-    let ns = getPluginName.call(this.scope, 2)
-    if (ns === 'bajo') ns = 'bajoI18N'
-    return bora.call(this.scope, ns, ...params)
+  info (text, ...args) {
+    const { log } = this.scope.bajo.helper
+    if (this.opts.isLog) return log.info(text, ...args)
+    this.setText(text, ...args)
+    this.ora.info()
+    return this
+  }
+
+  clear () {
+    this.ora.clear()
+    return this
+  }
+
+  render () {
+    this.ora.render()
+    return this
+  }
+
+  fatal (text, ...args) {
+    const { log } = this.scope.bajo.helper
+    if (this.opts.isLog) {
+      log.fatal(text, ...args)
+      process.exit(1)
+    }
+    this.setText(text, ...args)
+    this.ora.fail()
+    process.exit(1)
   }
 }
 
-export default function () {
-  return new Print(this)
+export default function (options) {
+  const print = new Print(options)
+  print.setScope(this)
+  return print
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bajo",
-  "version": "0.2.14",
+  "version": "0.2.16",
   "description": "A framework to build a giant monstrous app rapidly",
   "main": "boot/index.js",
   "scripts": {
@@ -38,6 +38,7 @@
     "fs-extra": "^11.1.1",
     "global-modules-path": "^3.0.0",
     "lodash-es": "^4.17.21",
+    "ms": "^2.1.3",
     "nanoid": "^4.0.2",
     "node-fetch": "^3.3.1",
     "omit-deep": "^0.3.0",

package/boot/lib/bora.js

@@ -1,113 +0,0 @@
-import Sprintf from 'sprintf-js'
-import ora from 'ora'
-import { last, isPlainObject, get, isString } from 'lodash-es'
-
-const { sprintf } = Sprintf
-
-class Bora {
-  constructor (ns, ...args) {
-    this.ns = ns
-    const l = last(args)
-    let opts = {}
-    if (isPlainObject(l)) opts = args.pop()
-    this.opts = opts
-    this.ora = ora(this.opts)
-    this.args = args
-    this.startTime = null
-  }
-
-  setScope (scope) {
-    this.scope = scope
-    const { getConfig, dayjs } = this.scope.bajo.helper
-    this.startTime = dayjs()
-    const config = getConfig()
-    let silent = !!config.silent
-    if (this.opts.skipSilent) silent = false
-    this.ora.isSilent = silent
-    const [text, ...params] = this.args
-    this.setText(text, ...params)
-  }
-
-  setText (text, ...args) {
-    const { dayjs } = this.scope.bajo.helper
-    if (isString(text)) {
-      const i18n = get(this, 'scope.bajoI18N.instance')
-      if (i18n) {
-        if (isPlainObject(args[0])) text = i18n.t(text, args[0])
-        else text = i18n.t(text, { ns: this.ns, postProcess: 'sprintf', sprintf: args })
-      } else text = sprintf(text, ...args)
-      let opts = last(args)
-      if (!isPlainObject(opts)) opts = {}
-      const texts = []
-      if (this.opts.showDatetime || opts.showDatetime) texts.push('[' + dayjs().toISOString() + ']')
-      if (this.opts.showCounter || opts.showCounter) texts.push('[' + this.getElapsed() + ']')
-      texts.push(text)
-      this.ora.text = texts.join(' ')
-    }
-    return this
-  }
-
-  getElapsed (unit = 'hms') {
-    const { dayjs, secToHms } = this.scope.bajo.helper
-    const u = unit === 'hms' ? 'second' : unit
-    const elapsed = dayjs().diff(this.startTime, u)
-    return unit === 'hms' ? secToHms(elapsed) : elapsed
-  }
-
-  start (text, ...args) {
-    this.setText(text, ...args)
-    this.ora.start()
-    return this
-  }
-
-  stop () {
-    this.ora.stop()
-    return this
-  }
-
-  succeed (text, ...args) {
-    this.setText(text, ...args)
-    this.ora.succeed()
-    return this
-  }
-
-  fail (text, ...args) {
-    this.setText(text, ...args)
-    this.ora.fail()
-    return this
-  }
-
-  warn (text, ...args) {
-    this.setText(text, ...args)
-    this.ora.warn()
-    return this
-  }
-
-  info (text, ...args) {
-    this.setText(text, ...args)
-    this.ora.info()
-    return this
-  }
-
-  clear () {
-    this.ora.clear()
-    return this
-  }
-
-  render () {
-    this.ora.render()
-    return this
-  }
-
-  fatal (text, ...args) {
-    this.setText(text, ...args)
-    this.ora.fail()
-    process.exit(1)
-  }
-}
-
-export default function (ns, ...args) {
-  const bora = new Bora(ns, ...args)
-  bora.setScope(this)
-  return bora
-}