bajo 0.3.4 → 0.3.6

package/boot/helper/build-collections.js

@@ -1,7 +1,7 @@
 import { filter, isArray, each, pullAt, camelCase, has, find, set, get, cloneDeep } from 'lodash-es'
 
 async function buildCollections (options = {}) {
-  const { getConfig, getPluginName, fatal, runHook, error } = this.bajo.helper
+  const { getConfig, getPluginName, fatal, runHook, error, join } = this.bajo.helper
   let { plugin, handler, dupChecks = [], container = 'connections', useDefaultName } = options
   useDefaultName = useDefaultName ?? true
   if (!plugin) plugin = getPluginName(4)
@@ -32,7 +32,7 @@ async function buildCollections (options = {}) {
     each(dupChecks, d => {
       const checker = set({}, d, c[d])
       const match = filter(data, checker)
-      if (match.length > 1) fatal('One or more %s shared the same \'%s\'', container, dupChecks.join(', '))
+      if (match.length > 1) fatal('One or more %s shared the same \'%s\'', container, join(dupChecks))
     })
   })
   await runHook(`${plugin}:${camelCase(`after build ${container}`)}`)

package/boot/helper/get-plugin-file.js

@@ -0,0 +1,14 @@
+import { get } from 'lodash-es'
+
+function getPluginFile (file) {
+  if (file.includes(':')) {
+    const [plugin, path] = file.split(':')
+    if (plugin !== 'file' && this && this[plugin] && plugin.length > 1) {
+      const dir = get(this[plugin], 'config.dir.pkg')
+      file = `${dir}${path}`
+    }
+  }
+  return file
+}
+
+export default getPluginFile

package/boot/helper/import-module.js

@@ -1,5 +1,6 @@
 import resolvePath from './resolve-path.js'
-import { isFunction, isPlainObject, get } from 'lodash-es'
+import getPluginFile from './get-plugin-file.js'
+import { isFunction, isPlainObject } from 'lodash-es'
 import error from './error.js'
 import fs from 'fs-extra'
 
@@ -12,13 +13,7 @@ async function load (file, asDefaultImport = true, noCache = true) {
 }
 
 async function importModule (file, { asDefaultImport, asHandler, noCache } = {}) {
-  if (file.includes(':')) {
-    const [plugin, path] = file.split(':')
-    if (plugin.length > 1) {
-      const dir = get(this[plugin], 'config.dir.pkg')
-      file = `${dir}${path}`
-    }
-  }
+  file = getPluginFile.call(this, file)
   if (!fs.existsSync(file)) return
   let mod = await load(file, asDefaultImport, noCache)
   if (!asHandler) return mod

package/boot/helper/import-pkg.js

@@ -1,4 +1,4 @@
-import { isPlainObject, map, last, isEmpty, has, keys, values, trim, get } from 'lodash-es'
+import { isPlainObject, last, isEmpty, has, keys, values, get } from 'lodash-es'
 import os from 'os'
 import getModuleDir from './get-module-dir.js'
 import resolvePath from './resolve-path.js'
@@ -7,46 +7,21 @@ import defaultsDeep from './defaults-deep.js'
 import path from 'path'
 import fs from 'fs-extra'
 
-/**
- * Load/import a package dynamically. You can import package one-by-one or multiple
- * packages at once.
- *
- * Package 'pkg' must be in the following format: ```<original name>:<new name>:<bajo package name>```
- * ```<new name>``` can be omitted, so the format will be: ```<name>::<bajo package name>```
- *
- * If you only import one package, returned value is the imported package itself
- * If multiple packages are imported, returned value is an object with ```<new name>``` as its
- * keys and imported packages as its values
- *
- * Example:
- * ```
- * const imported = await importPkg('ora::bajo-cli')
- * const multiple = await importPkg('ora::bajo-cli', 'lodash:_:bajo')
- *
- * @param  {...string} pkg
- * @returns
- */
-
-async function importPkg (...pkg) {
+async function importPkg (...pkgs) {
   const result = {}
   let opts = { returnDefault: true, thrownNotFound: false, noCache: false }
-  if (isPlainObject(last(pkg))) {
-    opts = defaultsDeep(pkg.pop(), opts)
+  if (isPlainObject(last(pkgs))) {
+    opts = defaultsDeep(pkgs.pop(), opts)
   }
-  for (const p of pkg) {
-    const parts = map(p.split(':'), i => trim(i))
-    let [ns, orgName, name] = parts
-    if (parts.length === 1) {
-      orgName = ns
-      ns = 'bajo'
-      name = orgName
-    } else if (parts.length === 2) {
-      name = orgName
+  for (const pkg of pkgs) {
+    let [plugin, name] = pkg.split(':').map(item => item.trim())
+    if (!name) {
+      name = plugin
+      plugin = 'bajo'
     }
-    if (isEmpty(name)) name = orgName
-    const dir = getModuleDir.call(this, orgName, ns)
-    const pkg = readJson(`${dir}/package.json`, opts.thrownNotFound)
-    const mainFileOrg = dir + '/' + (pkg.main ?? get(pkg, 'exports.default', 'index.js'))
+    const dir = getModuleDir.call(this, name, plugin)
+    const p = readJson(`${dir}/package.json`, opts.thrownNotFound)
+    const mainFileOrg = dir + '/' + (p.main ?? get(p, 'exports.default', 'index.js'))
     let mainFile = resolvePath(mainFileOrg, os.platform() === 'win32')
     if (isEmpty(path.extname(mainFile))) {
       if (fs.existsSync(`${mainFileOrg}/index.js`)) mainFile += '/index.js'
@@ -60,7 +35,7 @@ async function importPkg (...pkg) {
     }
     result[name] = mod
   }
-  if (pkg.length === 1) return result[keys(result)[0]]
+  if (pkgs.length === 1) return result[keys(result)[0]]
   if (opts.asObject) return result
   return values(result)
 }

package/boot/helper/join.js

@@ -0,0 +1,11 @@
+import { isPlainObject } from 'lodash-es'
+import isSet from './is-set.js'
+
+const join = (array, sep) => {
+  if (isSet(sep) && !isPlainObject(sep)) return array.join(sep)
+  const { separator = ', ', joiner = 'and' } = sep ?? {}
+  const last = (array.pop() ?? '').trim()
+  return array.map(a => (a + '').trim()).join(separator) + ` ${joiner} ${last}`
+}
+
+export default join

package/boot/helper/read-config.js

@@ -1,5 +1,6 @@
 import path from 'path'
 import resolvePath from './resolve-path.js'
+import getPluginFile from './get-plugin-file.js'
 import readJson from './read-json.js'
 import parseObject from './parse-object.js'
 import { find, map, isEmpty } from 'lodash-es'
@@ -7,7 +8,7 @@ import error from './error.js'
 import fg from 'fast-glob'
 
 async function readConfig (file, { pattern, globOptions = {}, ignoreError, defValue = {} } = {}) {
-  file = resolvePath(file)
+  file = resolvePath(getPluginFile.call(this, file))
   let ext = path.extname(file)
   const fname = path.dirname(file) + '/' + path.basename(file, ext)
   ext = ext.toLowerCase()

package/boot/lib/logger.js

@@ -58,7 +58,6 @@ class Log {
         text = JSON.stringify(json)
       } else {
         text = `[${dayjs(dt).utc(true).format(this.format)}] ${upperFirst(level)}: ${msg}`
-        // if (!isEmpty(data)) text += '\n  ' + (pretty.render(data, prettyOpts).split('\n').join('\n  '))
         if (!isEmpty(data)) text += '\n' + JSON.stringify(data)
       }
       console.log(text)

package/boot/plugins/check-dependency.js

@@ -2,7 +2,7 @@ import { reduce, map, trim, keys, intersection, each, camelCase, get } from 'lod
 import semver from 'semver'
 
 async function runner ({ plugin, pkg, dependencies }) {
-  const { log, getConfig, error } = this.bajo.helper
+  const { log, getConfig, error, join } = this.bajo.helper
   log.trace('Checking dependencies: %s', plugin)
   const config = getConfig()
   const odep = reduce(dependencies, (o, k) => {
@@ -13,7 +13,7 @@ async function runner ({ plugin, pkg, dependencies }) {
   const deps = keys(odep)
   if (deps.length > 0) {
     if (intersection(config.plugins, deps).length !== deps.length) {
-      throw error('Dependency for \'%s\' unfulfilled: %s', pkg, deps.join(', '), { code: 'BAJO_DEPENDENCY' })
+      throw error('Dependency for \'%s\' unfulfilled: %s', pkg, join(deps), { code: 'BAJO_DEPENDENCY' })
     }
     each(deps, d => {
       if (!odep[d]) return

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

@@ -1,7 +1,7 @@
 import { isFunction, isPlainObject, map } from 'lodash-es'
 
 async function collectConfigHandlers (pkg) {
-  const { getModuleDir, importModule, log } = this.bajo.helper
+  const { getModuleDir, importModule, log, join } = this.bajo.helper
   for (const pkg of this.bajo.config.plugins) {
     let dir
     try {
@@ -16,7 +16,7 @@ async function collectConfigHandlers (pkg) {
     this.bajo.configHandlers.concat(mod)
   }
   const exts = map(this.bajo.configHandlers, 'ext')
-  log.trace('Config handlers: %s', exts.join(', '))
+  log.trace('Config handlers: %s', join(exts))
 }
 
 export default collectConfigHandlers

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

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

package/boot/plugins/run.js

@@ -1,7 +1,7 @@
 import { set, get, camelCase, upperFirst, map } from 'lodash-es'
 
 async function run () {
-  const { runHook, log, eachPlugins, importModule, freeze, getConfig, print } = this.bajo.helper
+  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')
@@ -20,7 +20,7 @@ async function run () {
     })
     await runHook(`bajo:${camelCase(`after ${f} all plugins`)}`)
   }
-  log.debug('Loaded plugins: %s', map(config.plugins, b => camelCase(b)).join(', '))
+  log.debug('Loaded plugins: %s', join(map(config.plugins, b => camelCase(b))))
 }
 
 export default run

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bajo",
-  "version": "0.3.4",
+  "version": "0.3.6",
   "description": "A framework to build a giant monstrous app rapidly",
   "main": "boot/index.js",
   "scripts": {