bajo 0.3.10 → 1.0.1

package/boot/lib/print.js

@@ -1,138 +0,0 @@
-import Sprintf from 'sprintf-js'
-import ora from 'ora'
-import { isPlainObject, get } from 'lodash-es'
-import defaultsDeep from '../helper/defaults-deep.js'
-
-const { sprintf } = Sprintf
-
-export class Print {
-  constructor (opts = {}) {
-    this.opts = opts
-    this.startTime = null
-  }
-
-  setOpts (args = []) {
-    const { getConfig } = this.scope.bajo.helper
-    const config = getConfig()
-    let opts = {}
-    if (isPlainObject(args.slice(-1)[0])) opts = args.pop()
-    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)
-  }
-
-  setScope (scope) {
-    this.scope = scope
-    const { dayjs } = this.scope.bajo.helper
-    this.startTime = dayjs()
-    this.setOpts()
-    this.ora = ora(this.opts)
-  }
-
-  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
-  }
-
-  __ (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)
-    }
-    return text
-  }
-
-  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.setOpts(args)
-    if (this.opts.isLog) {
-      this.ora.start()
-      this.info(text, ...args)
-      return this
-    }
-    this.setText(text, ...args)
-    this.ora.start()
-    return this
-  }
-
-  stop () {
-    this.ora.stop()
-    return this
-  }
-
-  succeed (text, ...args) {
-    const { log } = this.scope.bajo.helper
-    if (this.opts.isLog) return log.debug(text, ...args)
-    this.setText(text, ...args)
-    this.ora.succeed()
-    return this
-  }
-
-  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
-  }
-
-  info (text, ...args) {
-    const { log } = this.scope.bajo.helper
-    if (this.opts.isLog) return log.debug(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) return log.fatal(text, ...args)
-    this.setText(text, ...args)
-    this.ora.fail()
-    process.kill(process.pid, 'SIGINT')
-  }
-}
-
-export default function (options) {
-  const print = new Print(options)
-  print.setScope(this)
-  return print
-}

package/boot/plugins/attach-helper.js

@@ -1,20 +0,0 @@
-import buildHelper from '../lib/build-helper.js'
-import { keys } from 'lodash-es'
-
-async function runner (plugin, pkg) {
-  const { log, freeze } = this.bajo.helper
-  const dir = pkg === 'app' ? (this.bajo.config.dir.base + '/app') : this.bajo.helper.getModuleDir(pkg)
-  this[plugin].helper = await buildHelper.call(this, `${dir}/bajo/helper`, pkg)
-  freeze(this[plugin].helper, true)
-  log.trace('Attach helper: %s (%d)', plugin, keys(this[plugin].helper).length)
-}
-
-async function attachHelper () {
-  const { log, eachPlugins } = this.bajo.helper
-  log.debug('Attach helpers')
-  await eachPlugins(async function ({ plugin, pkg }) {
-    await runner.call(this, plugin, pkg)
-  })
-}
-
-export default attachHelper

package/boot/plugins/build-config.js

@@ -1,68 +0,0 @@
-import { camelCase, pick, isString, omit } from 'lodash-es'
-import fs from 'fs-extra'
-import omittedPluginKeys from '../lib/omitted-plugin-keys.js'
-import titleize from '../helper/titleize.js'
-
-export async function readAllConfigs (base, name) {
-  const { readConfig, getConfig } = this.bajo.helper
-  const config = getConfig()
-  let cfg = {}
-  try {
-    cfg = await readConfig(`${base}-${config.env}.*`)
-  } catch (err) {
-    if (['BAJO_CONFIG_NO_PARSER'].includes(err.code)) throw err
-    if (['BAJO_CONFIG_FILE_NOT_FOUND'].includes(err.code)) {
-      try {
-        cfg = await readConfig(`${base}.*`)
-      } catch (err) {
-        if (!['BAJO_CONFIG_FILE_NOT_FOUND'].includes(err.code)) throw err
-      }
-    }
-  }
-  cfg.name = name
-  return cfg
-}
-
-async function runner (pkg, { argv, env }) {
-  const { log, getConfig, getModuleDir, readConfig, error, readJson, defaultsDeep } = this.bajo.helper
-  const config = getConfig()
-  const name = camelCase(pkg)
-  log.trace('Read configuration: %s', name)
-  const dir = pkg === 'app' ? (config.dir.base + '/app') : getModuleDir(pkg)
-  if (pkg !== 'app' && !fs.existsSync(`${dir}/bajo`)) throw error('Package \'%s\' isn\'t a valid Bajo package', pkg, { code: 'BAJO_INVALID_PACKAGE' })
-  let cfg = await readAllConfigs.call(this, `${dir}/bajo/config`, name)
-  cfg.dir = {
-    pkg: dir,
-    data: `${config.dir.data}/plugins/${name}`
-  }
-  const pkgJson = await readJson(`${dir + (pkg === 'app' ? '/..' : '')}/package.json`)
-  cfg.pkg = pick(pkgJson,
-    ['name', 'version', 'description', 'author', 'license', 'homepage'])
-  if (cfg.name === 'app') {
-    cfg.alias = 'app'
-    cfg.title = 'Application'
-  } else if (!isString(cfg.alias)) cfg.alias = pkg.slice(0, 5) === 'bajo-' ? pkg.slice(5).toLowerCase() : pkg // fix. can't be overriden
-  cfg.title = cfg.title ?? titleize.call(this, cfg.alias)
-  // merge with config from datadir
-  try {
-    const altCfg = await readConfig(`${config.dir.data}/config/${cfg.name}.*`)
-    cfg = defaultsDeep({}, omit(altCfg, omittedPluginKeys), cfg)
-  } catch (err) {}
-  const envArgv = defaultsDeep({}, omit(env[cfg.name] ?? {}, omittedPluginKeys) ?? {}, omit(argv[cfg.name] ?? {}, omittedPluginKeys) ?? {})
-  cfg = defaultsDeep({}, envArgv ?? {}, cfg ?? {})
-  cfg.dependencies = cfg.dependencies ?? []
-  if (isString(cfg.dependencies)) cfg.dependencies = [cfg.dependencies]
-  if (!this[name]) this[name] = {}
-  this[name].config = cfg
-}
-
-async function buildConfig ({ argv, env }) {
-  const { log, freeze } = this.bajo.helper
-  log.debug('Read configurations')
-  for (const pkg of this.bajo.config.plugins) {
-    await runner.call(this, pkg, { argv, env })
-  }
-  freeze(this.bajo.config)
-}
-
-export default buildConfig

package/boot/plugins/check-clash.js

@@ -1,18 +0,0 @@
-import { find } from 'lodash-es'
-import error from '../helper/error.js'
-
-async function checkAlias () {
-  const { log, eachPlugins } = this.bajo.helper
-  log.debug('Checking alias & name clashes')
-  const refs = []
-  await eachPlugins(async function ({ plugin, pkg, alias }) {
-    let item = find(refs, { plugin })
-    if (item) throw error('Plugin name clash: \'%s (%s)\' with \'%s (%s)\'', plugin, pkg, item.plugin, item.pkg, { code: 'BAJO_NAME_CLASH' })
-    item = find(refs, { alias })
-    if (item) throw error('Plugin alias clash: \'%s (%s)\' with \'%s (%s)\'', alias, pkg, item.alias, item.pkg, { code: 'BAJO_ALIAS_CLASH' })
-    refs.push({ plugin, alias, pkg })
-  })
-  this.bajo.pluginRefs = refs
-}
-
-export default checkAlias

package/boot/plugins/check-dependency.js

@@ -1,37 +0,0 @@
-import { reduce, map, trim, keys, intersection, each, camelCase, get } from 'lodash-es'
-import semver from 'semver'
-
-async function runner ({ plugin, pkg, dependencies }) {
-  const { log, getConfig, error, join } = this.bajo.helper
-  log.trace('Checking dependencies: %s', plugin)
-  const config = getConfig()
-  const odep = reduce(dependencies, (o, k) => {
-    const item = map(k.split('@'), m => trim(m))
-    o[item[0]] = item[1]
-    return o
-  }, {})
-  const deps = keys(odep)
-  if (deps.length > 0) {
-    if (intersection(config.plugins, deps).length !== deps.length) {
-      throw error('Dependency for \'%s\' unfulfilled: %s', pkg, join(deps), { code: 'BAJO_DEPENDENCY' })
-    }
-    each(deps, d => {
-      if (!odep[d]) return
-      const ver = get(this[camelCase(d)], 'config.pkg.version')
-      if (!ver) return
-      if (!semver.satisfies(ver, odep[d])) {
-        throw error('Semver check \'%s\' against \'%s\' failed', pkg, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
-      }
-    })
-  }
-}
-
-async function checkDependency () {
-  const { log, eachPlugins } = this.bajo.helper
-  log.debug('Checking dependencies')
-  await eachPlugins(async function ({ plugin, pkg, dependencies }) {
-    await runner.call(this, { plugin, pkg, dependencies })
-  })
-}
-
-export default checkDependency

package/boot/plugins/collect-config-handlers.js

@@ -1,22 +0,0 @@
-import { isFunction, isPlainObject, map } from 'lodash-es'
-
-async function collectConfigHandlers (pkg) {
-  const { getModuleDir, importModule, log, join } = this.bajo.helper
-  for (const pkg of this.bajo.config.plugins) {
-    let dir
-    try {
-      dir = getModuleDir(pkg)
-    } catch (err) {}
-    if (!dir) continue
-    const file = `${dir}/bajo/extend/read-config.js`
-    let mod = await importModule(file)
-    if (!mod) continue
-    if (isFunction(mod)) mod = await mod.call(this)
-    if (isPlainObject(mod)) mod = [mod]
-    this.bajo.configHandlers.concat(mod)
-  }
-  const exts = map(this.bajo.configHandlers, 'ext')
-  log.trace('Config handlers: %s', join(exts))
-}
-
-export default collectConfigHandlers

package/boot/plugins/collect-exit-handlers.js

@@ -1,18 +0,0 @@
-import {} from 'lodash-es'
-
-async function collectExitHandlers () {
-  const { importModule, log, eachPlugins, getConfig, print, join } = this.bajo.helper
-  const config = getConfig()
-  if (!config.exitHandler) return
-  this.bajo.exitHandler = this.bajo.exitHandler ?? {}
-  const names = []
-  await eachPlugins(async function ({ plugin, dir }) {
-    const mod = await importModule(`${dir}/bajo/exit.js`)
-    if (!mod) return undefined
-    this.bajo.exitHandler[plugin] = mod
-    names.push(plugin)
-  })
-  log.trace('Exit handlers: %s', names.length === 0 ? print.__('none') : join(names))
-}
-
-export default collectExitHandlers

package/boot/plugins/collect-hooks.js

@@ -1,34 +0,0 @@
-import { map, camelCase, merge, forOwn, groupBy } from 'lodash-es'
-
-async function collectHooks () {
-  const { eachPlugins, log, runHook, isLogInRange, importModule } = this.bajo.helper
-  this.bajo.hooks = this.bajo.hooks ?? []
-  log.debug('Collect hooks')
-  // collects
-  await eachPlugins(async function ({ plugin, dir, file }) {
-    const hookName = (file.slice(dir.length + 1) ?? '').split('/')[1]
-    let [ns, path] = hookName.replace('.js', '').split('@')
-    if (!path) {
-      path = ns
-      ns = plugin
-    }
-    path = camelCase(path)
-    ns = map(ns.split('.'), (n, i) => i === 1 ? n : camelCase(n)).join('.')
-    const mod = await importModule(file, { asHandler: true })
-    if (!mod) return undefined
-    merge(mod, { ns, path })
-    this.bajo.hooks.push(mod)
-  }, { glob: 'hook/**/*.js', insideBajo: true })
-  await runHook('bajo:afterCollectHooks')
-  // for log trace purpose only
-  if (!isLogInRange('trace')) return
-  const items = groupBy(this.bajo.hooks, 'ns')
-  forOwn(items, (v, k) => {
-    const hooks = groupBy(v, 'path')
-    forOwn(hooks, (v1, k1) => {
-      log.trace('Collect hook: %s:%s (%d)', k, k1, v1.length)
-    })
-  })
-}
-
-export default collectHooks

package/boot/plugins/extend-config.js

@@ -1,21 +0,0 @@
-import { isArray, each, isPlainObject, has, merge, concat } from 'lodash-es'
-import { readAllConfigs } from './build-config.js'
-
-async function extendConfig () {
-  const { eachPlugins } = this.bajo.helper
-  await eachPlugins(async function (opts) {
-    if (!opts.cfg.mergeProps) return undefined
-    await eachPlugins(async function ({ dir, plugin }) {
-      const cfg = await readAllConfigs.call(this, `${dir}/${opts.plugin}/config`, opts.plugin)
-      each(opts.cfg.mergeProps, p => {
-        if (!has(cfg, p)) return undefined
-        if (isArray(opts.cfg[p])) this[opts.plugin].config[p] = concat(opts.cfg[p], cfg[p])
-        else if (isPlainObject(opts.cfg[p])) this[opts.plugin].config[p] = merge(opts.cfg[p], cfg[p])
-        else this[opts.plugin].config[p] = cfg[p]
-      })
-    })
-    delete this[opts.plugin].config.mergeProps
-  })
-}
-
-export default extendConfig

package/boot/plugins/index.js

@@ -1,27 +0,0 @@
-import buildConfig from './build-config.js'
-import extendConfig from './extend-config.js'
-import checkDependency from './check-dependency.js'
-import checkClash from './check-clash.js'
-import attachHelper from './attach-helper.js'
-import collectHooks from './collect-hooks.js'
-import run from './run.js'
-import collectConfigHandlers from './collect-config-handlers.js'
-import collectExitHandlers from './collect-exit-handlers.js'
-import parseArgsArgv from '../lib/parse-args-argv.js'
-import parseEnv from '../lib/parse-env.js'
-
-async function bootBajos () {
-  const { argv } = await parseArgsArgv({ useParser: true }) ?? {}
-  const env = parseEnv() ?? {}
-  await collectConfigHandlers.call(this)
-  await buildConfig.call(this, { argv, env })
-  await extendConfig.call(this)
-  await checkClash.call(this)
-  await checkDependency.call(this)
-  await attachHelper.call(this)
-  await collectHooks.call(this)
-  await run.call(this)
-  await collectExitHandlers.call(this)
-}
-
-export default bootBajos

package/boot/plugins/run.js

@@ -1,26 +0,0 @@
-import { set, get, camelCase, upperFirst, map } from 'lodash-es'
-
-async function run () {
-  const { runHook, log, eachPlugins, importModule, freeze, getConfig, print, join } = this.bajo.helper
-  const config = getConfig()
-  const methods = ['init']
-  if (!get(config, 'tool')) methods.push('start')
-  for (const f of methods) {
-    await runHook(`bajo:${camelCase(`before ${f} all plugins`)}`)
-    await eachPlugins(async function ({ plugin, dir }) {
-      const mod = await importModule(`${dir}/bajo/${f}.js`)
-      if (mod) {
-        log.debug('%s: %s', print.__(upperFirst(f)), plugin)
-        await runHook(`bajo:${camelCase(`before ${f} ${plugin}`)}`)
-        await mod.call(this)
-        await runHook(`bajo:${camelCase(`after ${f} ${plugin}`)}`)
-      }
-      if (f === 'init') freeze(this[plugin].config)
-      set(this, `${plugin}.state.${f}`, true)
-    })
-    await runHook(`bajo:${camelCase(`after ${f} all plugins`)}`)
-  }
-  log.debug('Loaded plugins: %s', join(map(config.plugins, b => camelCase(b))))
-}
-
-export default run

package/boot/run-tool.js

@@ -1,41 +0,0 @@
-import { isString, map, find } from 'lodash-es'
-import Path from 'path'
-const tools = []
-
-async function runTool () {
-  const { getConfig, log, eachPlugins, importPkg, importModule, print } = this.bajo.helper
-  const config = getConfig()
-  await eachPlugins(async function checkCli ({ file, plugin, alias }) {
-    tools.push({ ns: plugin, file, nsAlias: alias })
-  }, { glob: 'tool.js', ns: 'bajoCli' })
-  this.bajo.tools = tools
-  if (!config.tool) return
-  log.debug('Run tool')
-  print.info('Sidetool is running...')
-  if (tools.length === 0) print.fatal('No tool found. Aborted!')
-  let name = config.tool
-  let toc = false
-  if (!isString(config.tool)) {
-    const select = await importPkg('bajoCli:@inquirer/select')
-    name = await select({
-      message: print.__('Please select tool provider:'),
-      choices: map(tools, t => ({ value: t.ns }))
-    })
-    toc = true
-  }
-  const [ns, path, ...params] = name.split(':')
-  const tool = find(tools, t => (t.ns === ns || t.nsAlias === ns))
-  if (!tool) print.fatal('Sidetool \'%s\' not found. Aborted!', name)
-  const opts = { ns, toc, path, params, args: config.args }
-  const mod = await importModule(tool.file)
-  if (mod === 'defCliHandler' && this.bajoCli) {
-    const { runToolMethod } = this.bajoCli.helper
-    const dir = `${Path.dirname(tool.file)}/tool`
-    await runToolMethod({ path, args: config.args, dir })
-  } else {
-    const handler = mod.handler ?? mod
-    await handler.call(this, opts)
-  }
-}
-
-export default runTool

package/docs/boot_build-config.js.html

@@ -1,75 +0,0 @@
-<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: boot/build-config.js</title><!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="",baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body class="dark" data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="giIwooOtbeeq9fbiwZEz4"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-boot.html">boot</a></div><div class="sidebar-section-children"><a href="module-boot_buildConfig.html">boot/buildConfig</a></div><div class="sidebar-section-children"><a href="module-boot_createScope.html">boot/createScope</a></div><div class="sidebar-section-children"><a href="module-helper.html">helper</a></div><div class="sidebar-section-children"><a href="module-helper_runHook.html">helper/runHook</a></div><div class="sidebar-section-children"><a href="module-helper_eachPlugins.html">helper/eachPlugins</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">boot_build-config.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
- * @module boot/buildConfig
- */
-
-const fs = require('fs-extra')
-const _ = require('lodash')
-const pathResolve = require('../helper/path-resolve')
-const readConfig = require('../helper/read-config')
-const getKeyByValue = require('../helper/get-key-by-value')
-const error = require('../helper/error')
-const envs = require('../helper/envs')
-const parseArgsArgv = require('../lib/parse-args-argv')
-const parseEnv = require('../lib/parse-env')
-
-/**
- * Building configuration object. Read configurtion file from app data directory, program
- * arguments and envoronment variables with following priority: ```Env > Args > Config file >
- * defaults config```
- *
- * If data directory is provided and doesn't exist yet, it will be automatically created.
- *
- * Config file must be located in: ```&lt;data dir>/config/bajo.&lt;format>```, and support either
- * ```.json``` or ```.js``` format. JS format must be a nodejs module that wrap an async
- * function and return an object
- *
- * @instance
- * @async
- * @throws Will throw if data directory is not provided
- *
- * @returns {Object} config
- */
-
-async function buildConfig () {
-  const { args, argv } = parseArgsArgv()
-  const env = parseEnv()
-  let defConfig = {
-    dir: {},
-    log: {
-      level: 'info',
-      dateFormat: `UTC:yyyy-mm-dd'T'HH:MM:ss.l'Z'`,
-      report: ['sysreport', 'helper', 'hook'],
-      details: []
-    },
-    plugins: ['app'],
-    env: 'dev'
-  }
-  defConfig = _.defaultsDeep(env.root, argv.root, defConfig)
-  if (!defConfig.dir.data) throw error('No data directory provided', { code: 'BAJO_DATA_DIR_NOT_PROVIDED' })
-  defConfig.dir.data = pathResolve(defConfig.dir.data)
-  _.set(defConfig, 'dir.base', pathResolve(process.cwd()))
-  _.each(['tmp', 'lock'], k => {
-    if (!defConfig.dir[k]) defConfig.dir[k] = `${defConfig.dir.data}/${k}`
-    fs.ensureDirSync(defConfig.dir[k])
-  })
-  fs.ensureDirSync(defConfig.dir.data + '/config')
-  const resp = _.omit(await readConfig.call(this, `${defConfig.dir.data}/config/bajo.*`), ['dir'])
-  const config = _.defaultsDeep(resp, defConfig)
-  config.args = args
-  config.env = config.env.toLowerCase()
-  if (_.values(envs).includes(config.env)) config.env = getKeyByValue.handler(envs, config.env)
-  if (!_.keys(envs).includes(config.env)) config.env = 'dev'
-  process.env.NODE_ENV = envs[config.env]
-  if (_.isString(config.log.details)) config.log.details = _.map((argv.root['log-details'] || '').split(','), t => _.trim(t))
-  if (config.env === 'dev') config.log.level = 'debug'
-  if (config.verbose) config.log.level = 'trace'
-
-  if (!config.plugins.includes('app')) config.plugins.push('app')
-  config.plugins = _.filter(_.uniq(_.map(config.plugins, b => _.trim(b))), b => !_.isEmpty(b))
-  this.bajo.config = config
-}
-
-module.exports = buildConfig
-</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="giIwooOtbeeq9fbiwZEz4"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-boot.html">boot</a></div><div class="sidebar-section-children"><a href="module-boot_buildConfig.html">boot/buildConfig</a></div><div class="sidebar-section-children"><a href="module-boot_createScope.html">boot/createScope</a></div><div class="sidebar-section-children"><a href="module-helper.html">helper</a></div><div class="sidebar-section-children"><a href="module-helper_runHook.html">helper/runHook</a></div><div class="sidebar-section-children"><a href="module-helper_eachPlugins.html">helper/eachPlugins</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>

package/docs/boot_create-scope.js.html

@@ -1,25 +0,0 @@
-<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: boot/create-scope.js</title><!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="",baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body class="dark" data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="giIwooOtbeeq9fbiwZEz4"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-boot.html">boot</a></div><div class="sidebar-section-children"><a href="module-boot_buildConfig.html">boot/buildConfig</a></div><div class="sidebar-section-children"><a href="module-boot_createScope.html">boot/createScope</a></div><div class="sidebar-section-children"><a href="module-helper.html">helper</a></div><div class="sidebar-section-children"><a href="module-helper_runHook.html">helper/runHook</a></div><div class="sidebar-section-children"><a href="module-helper_eachPlugins.html">helper/eachPlugins</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">boot_create-scope.js</h1></header><article><pre class="prettyprint source lang-js"><code>/**
- * @module boot/createScope
- */
-
-const { EventEmitter } = require('events')
-const event = new EventEmitter()
-
-const bajo = {
-  event
-}
-
-/**
- * @instance
- * @async
- * @returns {Object} scope
- */
-
-function createScope () {
-  return { bajo }
-}
-
-module.exports = createScope
-</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="giIwooOtbeeq9fbiwZEz4"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-boot.html">boot</a></div><div class="sidebar-section-children"><a href="module-boot_buildConfig.html">boot/buildConfig</a></div><div class="sidebar-section-children"><a href="module-boot_createScope.html">boot/createScope</a></div><div class="sidebar-section-children"><a href="module-helper.html">helper</a></div><div class="sidebar-section-children"><a href="module-helper_runHook.html">helper/runHook</a></div><div class="sidebar-section-children"><a href="module-helper_eachPlugins.html">helper/eachPlugins</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>