bajo 2.16.0 → 2.18.0

package/class/{helper/bajo.js → _helper.js}

@@ -1,30 +1,32 @@
-import Print from '../plugin/print.js'
-import Log from '../app/log.js'
+import Print from './print.js'
+import Log from './log.js'
 import os from 'os'
 import fs from 'fs-extra'
 import lodash from 'lodash'
-import {
-  buildConfigs,
-  checkDependencies,
-  checkNameAliases,
-  collectHooks,
-  run
-} from './base.js'
+import semver from 'semver'
+import aneka from 'aneka/index.js'
+import outmatch from 'outmatch'
+import fastGlob from 'fast-glob'
+import { sprintf } from 'sprintf-js'
+import dayjs from 'dayjs'
+import utc from 'dayjs/plugin/utc.js'
+import customParseFormat from 'dayjs/plugin/customParseFormat.js'
+import localizedFormat from 'dayjs/plugin/localizedFormat.js'
+import weekOfYear from 'dayjs/plugin/weekOfYear.js'
+import freeze from '../lib/freeze.js'
+import findDeep from '../lib/find-deep.js'
+import omitDeep from 'omit-deep'
+
+/**
+ * Internal helpers called by Bajo and other classes. It should remains
+ * hidden and not to be imported by any program.
+ *
+ * @module Helper
+ */
 
 const {
-  orderBy,
-  isFunction,
-  isPlainObject,
-  map,
-  pick,
-  values,
-  keys,
-  set,
-  get,
-  without,
-  uniq,
-  camelCase,
-  isEmpty
+  merge, forOwn, groupBy, find, reduce, map, trim, keys, intersection, each,
+  camelCase, get, orderBy, isFunction, isPlainObject, pick, values, set, without, uniq, isEmpty
 } = lodash
 
 const omitted = ['spawn', 'cwd', 'name', 'alias', 'applet', 'a', 'plugins']
@@ -49,6 +51,19 @@ const defConfig = {
       retain: 5
     }
   },
+  dump: {
+    depth: 2,
+    compact: false,
+    colors: true,
+    breakLength: 80,
+    caller: true,
+    frame: {
+      titleAllignment: 'center',
+      padding: 1,
+      margin: 1,
+      borderStyle: 'round'
+    }
+  },
   lang: Intl.DateTimeFormat().resolvedOptions().lang ?? 'en-US',
   intl: {
     supported: ['en-US', 'id'],
@@ -90,12 +105,64 @@ const defMain = `async function factory (pkgName) {
 export default factory
 `
 
+export function outmatchNs (source, pattern) {
+  const { breakNsPath } = this.bajo
+  const [src, subSrc] = source.split(':')
+  if (!subSrc) return pattern === src
+  try {
+    const { fullNs, path } = breakNsPath(pattern)
+    const isMatch = outmatch(path)
+    return src === fullNs && isMatch(subSrc)
+  } catch (err) {
+    return false
+  }
+}
+
+export function parseObject (obj, options = {}) {
+  const me = this
+  const { ns = 'bajo', lang } = options
+  options.translator = {
+    lang,
+    prefix: 't:',
+    handler: val => {
+      const [text, ...args] = val.split('|')
+      args.push({ lang })
+      return me[ns].t(text, ...args)
+    }
+  }
+  return aneka.parseObject(obj, options)
+}
+
+dayjs.extend(utc)
+dayjs.extend(customParseFormat)
+dayjs.extend(localizedFormat)
+dayjs.extend(weekOfYear)
+
 /**
- * Internal helpers called by Bajo that only used once for bootstrapping. It should remains
- * hidden and not to be imported by any program.
- *
- * @module Helper/Bajo
+ * @typedef {Object} TAppLib
+ * @property {Object} _ - Access to {@link https://lodash.com|lodash}
+ * @property {Object} fs - Access to {@link https://github.com/jprichardson/node-fs-extra|fs-extra}
+ * @property {Object} fastGlob - Access to {@link https://github.com/mrmlnc/fast-glob|fast-glob}
+ * @property {Object} sprintf - Access to {@link https://github.com/alexei/sprintf.js|sprintf}
+ * @property {Object} aneka - Access to {@link https://github.com/ardhi/aneka|aneka}
+ * @property {Object} outmatch - Access to {@link https://github.com/axtgr/outmatch|outmatch}
+ * @property {Object} dayjs - Access to {@link https://day.js.org|dayjs} with utc & customParseFormat plugin already applied
+ * @property {Object} freeze
+ * @property {Object} findDeep
+ * @see App
  */
+export const lib = {
+  _: lodash,
+  fs,
+  fastGlob,
+  sprintf,
+  outmatch,
+  dayjs,
+  aneka,
+  freeze,
+  findDeep,
+  omitDeep
+}
 
 /**
  * Building bajo base config. Mostly dealing with directory setups:
@@ -112,7 +179,7 @@ export async function buildBaseConfig () {
   const { defaultsDeep, textToArray, currentLoc, resolvePath } = this.app.lib.aneka
   this.config = defaultsDeep({}, this.app.argv._, this.app.envVars._)
   set(this, 'dir.base', this.app.dir)
-  const path = currentLoc(import.meta).dir + '/../..'
+  const path = currentLoc(import.meta).dir + '/..'
   set(this, 'dir.pkg', resolvePath(path))
   if (get(this, 'config.dir.data')) set(this, 'dir.data', this.config.dir.data)
   if (!get(this, 'dir.data')) set(this, 'dir.data', `${this.dir.base}/data`)
@@ -278,6 +345,203 @@ export async function bootOrder () {
   freeze(this.config)
 }
 
+/**
+ * Build configurations
+ *
+ * @async
+ */
+export async function buildConfigs () {
+  this.bajo.log.debug('readConfigs')
+  for (const ns of this.getAllNs()) {
+    await this[ns].loadConfig()
+    this[ns].print = new Print(this[ns])
+    this.loadIntl(ns)
+  }
+}
+
+/**
+ * Ensure for names and aliases to be unique and no clashes with other plugins
+ *
+ * @async
+ */
+export async function checkNameAliases () {
+  this.bajo.log.debug('checkAliasNameClash')
+  const refs = []
+  for (const pkg of this.bajo.app.pluginPkgs) {
+    const plugin = this.bajo.app[camelCase(pkg)]
+    const { ns, alias } = plugin
+    let item = find(refs, { ns })
+    if (item) throw this.bajo.error('pluginNameClash%s%s%s%s', ns, pkg, item.ns, item.pkg, { code: 'BAJO_NAME_CLASH' })
+    item = find(refs, { alias })
+    if (item) throw this.bajo.error('pluginNameClash%s%s%s%s', alias, pkg, item.alias, item.pkg, { code: 'BAJO_ALIAS_CLASH' })
+    refs.push({ ns, alias, pkg })
+  }
+}
+
+/**
+ * Ensure dependencies are met
+ *
+ * @async
+ */
+export async function checkDependencies () {
+  const { join } = this.bajo
+  this.bajo.log.debug('checkDeps')
+  for (const pkg of this.bajo.app.pluginPkgs) {
+    const plugin = this.bajo.app[camelCase(pkg)]
+    const { ns, dependencies } = plugin
+    this.bajo.log.trace('- %s', ns)
+    const odep = reduce(dependencies, (o, k) => {
+      const item = map(k.split('@'), m => trim(m))
+      if (k[0] === '@') o['@' + item[1]] = item[2]
+      else o[item[0]] = item[1]
+      return o
+    }, {})
+    const deps = keys(odep)
+    if (deps.length > 0) {
+      if (intersection(this.bajo.app.pluginPkgs, deps).length !== deps.length) {
+        throw this.bajo.error('dependencyUnfulfilled%s%s', pkg, join(deps), { code: 'BAJO_DEPENDENCY' })
+      }
+      each(deps, d => {
+        if (!odep[d]) return
+        const ver = get(this.bajo.app[camelCase(d)], 'pkg.version')
+        if (!ver) return
+        if (!semver.satisfies(ver, odep[d])) {
+          throw this.bajo.error('semverCheckFailed%s%s', pkg, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
+        }
+      })
+    }
+  }
+}
+
+/**
+ * Collect and build hooks and push them to the bajo's hook system
+ *
+ * @async
+ * @fires bajo:afterCollectHooks
+ */
+export async function collectHooks () {
+  const { eachPlugins, runHook, isLogInRange, importModule } = this.bajo
+  const { isArray, isPlainObject } = this.lib._
+  const me = this // "this" is "app"
+  me.bajo.log.trace('collecting%s', this.t('hooks'))
+  await eachPlugins(async function ({ dir, file }) {
+    let mod = await importModule(file, { asHandler: true })
+    if (!mod) return undefined
+    if (file.includes('hook.js')) mod = await mod.handler.call(this)
+    if (isArray(mod)) {
+      for (const m of mod) {
+        if (!isPlainObject(m)) continue
+        if (!m.name) throw me.bajo.error('missing%s%s', 'name', file)
+        if (isArray(m.name)) {
+          for (const name of m.name) {
+            me.bajo.hooks.push(merge({}, m, { name, src: this.ns }))
+          }
+        } else {
+          m.src = this.ns
+          me.bajo.hooks.push(m)
+        }
+      }
+    } else {
+      const _file = file.replace(dir + '/hook/', '').replace('.js', '')
+      let [names, path] = _file.split('@')
+      names = names.split('$').map(n => trim(n))
+      for (let name of names) {
+        name = name.split('.').map(n => camelCase(n)).join('.')
+        const m = merge({}, mod, { name: `${name}:${camelCase(path)}`, src: this.ns })
+        me.bajo.hooks.push(m)
+      }
+    }
+  }, { glob: ['hook/*.js', 'hook.js'], prefix: me.bajo.ns })
+  // for log trace purpose only
+  if (isLogInRange('trace')) {
+    const items = groupBy(me.bajo.hooks, item => item.name)
+    forOwn(items, (v, k) => {
+      const [name, path] = k.split(':')
+      me.bajo.log.trace('- %s:%s (%d)', name, path, v.length)
+    })
+  }
+
+  /**
+   * Run after hooks are collected
+   *
+   * @global
+   * @event bajo:afterCollectHooks
+   * @param {Object[]} hooks - Array of hook objects
+   * @see {@tutorial hook}
+   * @see module:Helper/Base.collectHooks
+   */
+  await runHook('bajo:afterCollectHooks', this.bajo.hooks)
+  me.bajo.log.debug('collected%s%d', this.t('hooks'), me.bajo.hooks.length)
+}
+
+/**
+ * Finally, run all plugins
+ *
+ * @async
+ * @fires bajo:beforeAll{method}
+ * @fires {ns}:before{method}
+ * @fires {ns}:after{method}
+ * @fires bajo:afterAll{method}
+ */
+export async function run () {
+  const me = this
+  const { runHook, eachPlugins, join } = me.bajo
+  const { freeze } = me.lib
+  const methods = ['init']
+  if (!me.applet) methods.push('start')
+  for (const method of methods) {
+    /**
+     * Run before all ```{method}``` executed. Accepted ```{method}```: ```Init``` or ```Start```
+     *
+     * @global
+     * @event bajo:beforeAll{method}
+     * @param {string} method - Accepted methods: ```Init```, ```Start```
+     * @see module:Helper/Base.run
+     */
+    await runHook(`bajo:${camelCase(`before all ${method}`)}`)
+    await eachPlugins(async function () {
+      const { ns } = this
+      /**
+       * Run before ```{method}``` is executed within ```{ns}``` context
+       *
+       * - ```{ns}``` - namespace
+       * - ```{method}``` - Accepted methods: ```Init``` or ```Start```
+       *
+       * @global
+       * @event {ns}:before{method}
+       * @see module:Helper/Base.run
+       */
+      await runHook(`${ns}:${camelCase(`before ${method}`)}`)
+      await me[ns][method]()
+      /**
+       * Run after ```{method}``` is executed within ```{ns}``` context
+       *
+       * - ```{ns}``` - namespace
+       * - ```{method}``` - Accepted methods: ```Init``` or ```Start```
+       *
+       * @global
+       * @event {ns}:after{method}
+       * @see module:Helper/Base.run
+       */
+      await runHook(`${ns}:${camelCase(`after ${method}`)}`)
+      if (method === 'start') freeze(me[ns].config)
+    })
+    /**
+     * Run after all ```{method}``` executed. Accepted ```{method}```: ```Init``` or ```Start```
+     *
+     * @global
+     * @event bajo:afterAll{method}
+     * @see module:Helper/Base.run
+     */
+    await runHook(`bajo:${camelCase(`after all ${method}`)}`)
+  }
+  if (me.bajo.config.log.level === 'trace') {
+    let text = join(map(me.bajo.app.pluginPkgs, b => camelCase(b)))
+    text += ` (${me.bajo.app.pluginPkgs.length})`
+    me.bajo.log.trace('loadedPlugins%s', text)
+  } else me.bajo.log.debug('loadedPlugins%s', me.bajo.app.pluginPkgs.length)
+}
+
 /**
  * Iterate through all plugins loaded and do:
  *

package/class/app.js

@@ -1,16 +1,35 @@
 import util from 'util'
 import Bajo from './bajo.js'
 import Base from './base.js'
-import { runAsApplet } from './helper/bajo.js'
-import Cache from './app/cache.js'
-import Tools from './plugin/tools.js'
-import { outmatchNs, parseObject, lib } from './helper/app.js'
+import Cache from './cache.js'
+import Tools from './tools.js'
+import Plugin from './plugin.js'
+import { outmatchNs, parseObject, lib, runAsApplet } from './_helper.js'
 import { fileURLToPath } from 'url'
 
 const { camelCase, isPlainObject, get, reverse, map, last, without, set } = lib._
-const { pascalCase, getCallerFilename } = lib.aneka
+const { pascalCase } = lib.aneka
 let unknownLangWarning = false
 
+function getCallerFilename () {
+  const originalFunc = Error.prepareStackTrace
+  let callerfile
+
+  try {
+    const err = new Error()
+    Error.prepareStackTrace = (_, stack) => stack
+    const currentfile = err.stack.shift().getFileName()
+
+    while (err.stack.length) {
+      callerfile = err.stack.shift().getFileName()
+      if (currentfile !== callerfile) break
+    }
+  } catch (e) {}
+
+  Error.prepareStackTrace = originalFunc
+  return callerfile
+}
+
 /**
  * @typedef {Object} TAppEnv
  * @property {string} dev=development
@@ -238,23 +257,132 @@ class App {
   }
 
   /**
-   * Dumping variable on screen. Like ```console.log``` but with max 10 depth.
+   * Get loaded plugins
+   *
+   * @method
+   * @param {string[]} [nss] - Array of namespaces. If empty, it returns all loaded plugins
+   * @returns {TPlugin[]}
+   */
+  getPlugins = (nss) => {
+    const allNs = nss ?? this.getAllNs()
+    return allNs.map(ns => this[ns])
+  }
+
+  /**
+   * Get all plugins loaded plugins
+   *
+   * @method
+   * @returns {TPlugin[]}
+   */
+  getAllPlugins = () => {
+    return this.getPlugins()
+  }
+
+  /**
+   * Get plugin by name
+   *
+   * @method
+   * @param {string} name - Plugin name/namespace or alias
+   * @param {boolean} [silent] - If ```true```, silently return undefined even on error
+   * @returns {Object} Plugin object
+   */
+  getPlugin = (name, silent) => {
+    if (!this[name]) {
+      // alias?
+      let plugin
+      for (const key in this) {
+        const item = this[key]
+        if (item instanceof Plugin && (item.alias === name || item.pkgName === name)) {
+          plugin = item
+          break
+        }
+      }
+      if (!plugin) {
+        if (silent) return false
+        throw this.bajo.error('pluginWithNameAliasNotLoaded%s', name)
+      }
+      name = plugin.ns
+    }
+    return this[name]
+  }
+
+  /**
+   * Get plugin data directory
+   *
+   * @method
+   * @param {string} name - Plugin name (namespace) or alias
+   * @param {boolean} [ensureDir=true] - Set ```true``` (default) to ensure directory is existed
+   * @returns {string}
+   */
+  getPluginDataDir = (name, ensureDir = true) => {
+    const { fs } = this.lib
+    const plugin = this.getPlugin(name)
+    const dir = `${this.bajo.dir.data}/plugins/${plugin.ns}`
+    if (ensureDir) fs.ensureDirSync(dir)
+    return dir
+  }
+
+  /**
+   * Resolve file path from:
+   *
+   * - local/absolute file
+   * - TNsPath (```myPlugin:/path/to/file.txt```)
+   * - file under node_modules, e.g. ```myPlugin:node_modules/some-package/file.txt```
+   *
+   * @method
+   * @param {string} file - File path, see above for supported types
+   * @returns {string} Resolved file path
+   */
+  getPluginFile = (file) => {
+    const { currentLoc } = this.lib.aneka
+    const { fs } = this.lib
+    const { trim } = this.lib._
+    if (!this) return file
+    if (file[0] === '.') file = `${currentLoc(import.meta).dir}/${trim(file.slice(1), '/')}`
+    if (file.includes(':')) {
+      if (file.slice(1, 2) === ':') return file // windows fs
+      const { ns, path } = this.bajo.breakNsPath(file, false)
+      if (ns !== 'file' && this && this[ns] && ns.length > 1) {
+        file = `${this[ns].dir.pkg}${path}`
+        if (path.startsWith('node_modules/')) {
+          file = `${this[ns].dir.pkg}/${path}`
+          if (!fs.existsSync(file)) file = `${this[ns].dir.pkg}/../${path.slice('node_modules/'.length)}`
+        }
+      }
+    }
+    return file
+  }
+
+  /**
+   * Dumping variable on screen. Like ```console.log``` with configurable options. Useful for quick debugging and testing. You can also use it to dump variables in production without worrying about performance because it is using Bajo's built-in cache to store the result of util's inspect, so it will only be processed once for each unique variable.
+   *
+   * Any argument passed to this method will be displayed on screen.
+   * If the last argument is a boolean ```true```, app will quit rightaway after dumping.
+   *
+   * If you have ```bajoCli``` plugin installed, variables will be displayed in a nice box using ```boxen``` package.
+   * Otherwise, it will fallback to ```console.log``` with util's inspect result.
+   *
+   * To have more control on how the variable is displayed, you can set options in Bajo's config under ```dump``` key.
+   * See {@link Bajo#config} for details.
    *
    * @method
-   * @param  {...any} args - any arguments passed will be displayed on screen. If the last argument is a boolean 'true', app will quit rightaway
+   * @param  {...any} args - Variables to dump
    */
   dump = (...args) => {
     let caller = getCallerFilename()
     caller = caller ? fileURLToPath(caller) : 'Unavailable'
-    const terminate = last(args) === true
+    const opts = last(args)
+    const terminate = isPlainObject(opts) && opts.abort
     if (terminate) args.pop()
     const value = args.length === 1 ? args[0] : args
+    const options = { ...this.bajo.config.dump }
     if (this.boxen) {
-      const result = util.inspect(value, { depth: 10, colors: true })
-      const info = this.boxen(result, { title: `Caller: ${caller}`, titleAlignment: 'center', padding: 1, margin: 1, borderStyle: 'round' })
-      console.log(info)
+      const result = util.inspect(value, options)
+      const opts = { ...this.bajo.config.dump.frame }
+      if (options.caller) opts.title = `Caller: ${caller}`
+      console.log(this.boxen(result, opts))
     } else {
-      const result = util.inspect([caller, value], { depth: 10, colors: true })
+      const result = util.inspect(options.caller ? [caller, value] : value, options)
       console.log(result)
     }
     if (terminate) process.exit('1')

package/class/bajo.js

@@ -1,3 +1,4 @@
+import Tools from './tools.js'
 import Plugin from './plugin.js'
 import increment from 'add-filename-increment'
 import fs from 'fs-extra'
@@ -21,7 +22,7 @@ import {
   bootOrder,
   bootPlugins,
   exitHandler
-} from './helper/bajo.js'
+} from './_helper.js'
 
 const require = createRequire(import.meta.url)
 
@@ -32,7 +33,7 @@ const {
   last, get, has, values, dropRight, pick
 } = lodash
 
-const { resolvePath, currentLoc } = aneka
+const { resolvePath } = aneka
 
 /**
  * The Core. The main engine. The one and only plugin that control app's boot process and
@@ -171,7 +172,7 @@ class Bajo extends Plugin {
     [ns, subNs, subSubNs] = ns.split('.')
     if (checkNs) {
       if (!this.app[ns]) {
-        const plugin = this.getPlugin(ns)
+        const plugin = this.app.getPlugin(ns)
         if (plugin) ns = plugin.ns
       }
       if (!this.app[ns]) throw this.error('unknownPluginOrNotLoaded%s')
@@ -297,7 +298,7 @@ class Bajo extends Plugin {
   callHandler = async (item, ...args) => {
     let result
     let scope = this
-    if (item instanceof Plugin) {
+    if (item instanceof Tools || item instanceof Plugin) {
       scope = item
       item = args.shift()
     }
@@ -571,77 +572,6 @@ class Bajo extends Plugin {
     return resolvePath(path.dirname(dir))
   }
 
-  /**
-   * Get plugin data directory
-   *
-   * @method
-   * @param {string} name - Plugin name (namespace) or alias
-   * @param {boolean} [ensureDir=true] - Set ```true``` (default) to ensure directory is existed
-   * @returns {string}
-   */
-  getPluginDataDir = (name, ensureDir = true) => {
-    const plugin = this.getPlugin(name)
-    const dir = `${this.app.bajo.dir.data}/plugins/${plugin.ns}`
-    if (ensureDir) fs.ensureDirSync(dir)
-    return dir
-  }
-
-  /**
-   * Resolve file path from:
-   *
-   * - local/absolute file
-   * - TNsPath (```myPlugin:/path/to/file.txt```)
-   * - file under node_modules, e.g. ```myPlugin:node_modules/some-package/file.txt```
-   *
-   * @method
-   * @param {string} file - File path, see above for supported types
-   * @returns {string} Resolved file path
-   */
-  getPluginFile = (file) => {
-    if (!this) return file
-    if (file[0] === '.') file = `${currentLoc(import.meta).dir}/${trim(file.slice(1), '/')}`
-    if (file.includes(':')) {
-      if (file.slice(1, 2) === ':') return file // windows fs
-      const { ns, path } = this.breakNsPath(file)
-      if (ns !== 'file' && this && this.app && this.app[ns] && ns.length > 1) {
-        file = `${this.app[ns].dir.pkg}${path}`
-        if (path.startsWith('node_modules/')) {
-          file = `${this.app[ns].dir.pkg}/${path}`
-          if (!fs.existsSync(file)) file = `${this.app[ns].dir.pkg}/../${path.slice('node_modules/'.length)}`
-        }
-      }
-    }
-    return file
-  }
-
-  /**
-   * Get plugin by name
-   *
-   * @method
-   * @param {string} name - Plugin name/namespace or alias
-   * @param {boolean} [silent] - If ```true```, silently return undefined even on error
-   * @returns {Object} Plugin object
-   */
-  getPlugin = (name, silent) => {
-    if (!this.app[name]) {
-      // alias?
-      let plugin
-      for (const key in this.app) {
-        const item = this.app[key]
-        if (item instanceof Plugin && (item.alias === name || item.pkgName === name)) {
-          plugin = item
-          break
-        }
-      }
-      if (!plugin) {
-        if (silent) return false
-        throw this.error('pluginWithNameAliasNotLoaded%s', name)
-      }
-      name = plugin.ns
-    }
-    return this.app[name]
-  }
-
   /**
    * Import file/module from any loaded plugins.
    *
@@ -729,7 +659,7 @@ class Bajo extends Plugin {
    * @returns {boolean}
    */
   isEmptyDir = async (dir, filterFn) => {
-    dir = resolvePath(this.getPluginFile(dir))
+    dir = resolvePath(this.app.getPluginFile(dir))
     await fs.exists(dir)
     return await emptyDir(dir, filterFn)
   }
@@ -915,7 +845,7 @@ class Bajo extends Plugin {
     await this.runHook('bajo:beforeReadConfig', file, options)
     parserOpts.readFromFile = true
     if (!ns) ns = this.ns
-    file = resolvePath(this.getPluginFile(file))
+    file = resolvePath(this.app.getPluginFile(file))
     let ext = path.extname(file)
     const fname = path.dirname(file) + '/' + path.basename(file, ext)
     ext = ext.toLowerCase()
@@ -1064,8 +994,8 @@ class Bajo extends Plugin {
    * @returns {string} Full file path
    */
   saveAsDownload = async (file, item, printSaved = true) => {
-    const { print, getPluginDataDir } = this.app.bajo
-    const fname = increment(`${getPluginDataDir(this.ns)}/download/${trim(file, '/')}`, { fs: true })
+    const { print } = this.app.bajo
+    const fname = increment(`${this.app.getPluginDataDir(this.ns)}/download/${trim(file, '/')}`, { fs: true })
     const dir = path.dirname(fname)
     if (!fs.existsSync(dir)) fs.ensureDirSync(dir)
     await fs.writeFile(fname, item, 'utf8')

package/class/{app/cache.js → cache.js}

@@ -4,8 +4,7 @@ class Cache {
   }
 
   getRootDir = () => {
-    const { getPluginDataDir } = this.app.bajo
-    return `${getPluginDataDir('bajo')}/cache`
+    return `${this.app.getPluginDataDir('bajo')}/cache`
   }
 
   prep = (name, ttlDur = 0) => {

package/class/{app/log.js → log.js}

@@ -1,5 +1,5 @@
 import os from 'os'
-import logLevels from '../../lib/log-levels.js'
+import logLevels from '../lib/log-levels.js'
 import chalk from 'chalk'
 import { stripVTControlCharacters } from 'node:util'
 

package/class/plugin.js

@@ -1,5 +1,5 @@
 import lodash from 'lodash'
-import Err from './plugin/err.js'
+import Err from './err.js'
 
 const { get, isEmpty, cloneDeep, omit, isPlainObject, camelCase } = lodash
 

package/lib/import-module.js

@@ -43,7 +43,7 @@ async function importModule (file, { asDefaultImport = true, asHandler, noCache
     return imported
   }
 
-  if (this) file = this.getPluginFile(file)
+  if (this) file = this.app.getPluginFile(file)
   if (!fs.existsSync(file)) return
   let mod = await load(file, asDefaultImport, noCache)
   if (!asHandler) return mod

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bajo",
-  "version": "2.16.0",
+  "version": "2.18.0",
   "description": "The ultimate framework for whipping up massive apps in no time",
   "main": "index.js",
   "scripts": {

package/wiki/CHANGES.md

@@ -1,5 +1,16 @@
 # Changes
 
+## 2026-06-12
+
+- [2.18.0] Move plugin related methods to ```app```
+- [2.18.0] Last argument of ```app.dump()``` serves as options if it a plain object with certain keys
+
+## 2026-06-03
+
+- [2.17.0] Combine all helpers to ```_helper.js```
+- [2.17.0] ```callHandler()``` now can accept an instance of ```Tools``` as its scope too
+- [2.17.0] Bug fix in ```app.dump()```
+
 ## 2026-06-01
 
 - [2.16.0] Upgrade ```aneka@0.14.0```

package/class/helper/app.js

@@ -1,73 +0,0 @@
-import aneka from 'aneka/index.js'
-import outmatch from 'outmatch'
-import lodash from 'lodash'
-import fs from 'fs-extra'
-import fastGlob from 'fast-glob'
-import { sprintf } from 'sprintf-js'
-import dayjs from 'dayjs'
-import utc from 'dayjs/plugin/utc.js'
-import customParseFormat from 'dayjs/plugin/customParseFormat.js'
-import localizedFormat from 'dayjs/plugin/localizedFormat.js'
-import weekOfYear from 'dayjs/plugin/weekOfYear.js'
-import freeze from '../../lib/freeze.js'
-import findDeep from '../../lib/find-deep.js'
-import omitDeep from 'omit-deep'
-
-dayjs.extend(utc)
-dayjs.extend(customParseFormat)
-dayjs.extend(localizedFormat)
-dayjs.extend(weekOfYear)
-
-/**
- * @typedef {Object} TAppLib
- * @property {Object} _ - Access to {@link https://lodash.com|lodash}
- * @property {Object} fs - Access to {@link https://github.com/jprichardson/node-fs-extra|fs-extra}
- * @property {Object} fastGlob - Access to {@link https://github.com/mrmlnc/fast-glob|fast-glob}
- * @property {Object} sprintf - Access to {@link https://github.com/alexei/sprintf.js|sprintf}
- * @property {Object} aneka - Access to {@link https://github.com/ardhi/aneka|aneka}
- * @property {Object} outmatch - Access to {@link https://github.com/axtgr/outmatch|outmatch}
- * @property {Object} dayjs - Access to {@link https://day.js.org|dayjs} with utc & customParseFormat plugin already applied
- * @property {Object} freeze
- * @property {Object} findDeep
- * @see App
- */
-export const lib = {
-  _: lodash,
-  fs,
-  fastGlob,
-  sprintf,
-  outmatch,
-  dayjs,
-  aneka,
-  freeze,
-  findDeep,
-  omitDeep
-}
-
-export function outmatchNs (source, pattern) {
-  const { breakNsPath } = this.bajo
-  const [src, subSrc] = source.split(':')
-  if (!subSrc) return pattern === src
-  try {
-    const { fullNs, path } = breakNsPath(pattern)
-    const isMatch = outmatch(path)
-    return src === fullNs && isMatch(subSrc)
-  } catch (err) {
-    return false
-  }
-}
-
-export function parseObject (obj, options = {}) {
-  const me = this
-  const { ns = 'bajo', lang } = options
-  options.translator = {
-    lang,
-    prefix: 't:',
-    handler: val => {
-      const [text, ...args] = val.split('|')
-      args.push({ lang })
-      return me[ns].t(text, ...args)
-    }
-  }
-  return aneka.parseObject(obj, options)
-}

package/class/helper/base.js

@@ -1,222 +0,0 @@
-import semver from 'semver'
-import lodash from 'lodash'
-import Print from '../plugin/print.js'
-
-const {
-  merge,
-  forOwn,
-  groupBy,
-  find,
-  reduce,
-  map,
-  trim,
-  keys,
-  intersection,
-  each,
-  camelCase,
-  get
-} = lodash
-
-/**
- * Internal helpers called by Bajo & plugins that only used once for bootstrapping purpose.
- * It should remains hidden and not to be imported by any program.
- *
- * @module Helper/Base
- */
-
-/**
- * Build configurations
- *
- * @async
- */
-export async function buildConfigs () {
-  this.bajo.log.debug('readConfigs')
-  for (const ns of this.getAllNs()) {
-    await this[ns].loadConfig()
-    this[ns].print = new Print(this[ns])
-    this.loadIntl(ns)
-  }
-}
-
-/**
- * Ensure for names and aliases to be unique and no clashes with other plugins
- *
- * @async
- */
-export async function checkNameAliases () {
-  this.bajo.log.debug('checkAliasNameClash')
-  const refs = []
-  for (const pkg of this.bajo.app.pluginPkgs) {
-    const plugin = this.bajo.app[camelCase(pkg)]
-    const { ns, alias } = plugin
-    let item = find(refs, { ns })
-    if (item) throw this.bajo.error('pluginNameClash%s%s%s%s', ns, pkg, item.ns, item.pkg, { code: 'BAJO_NAME_CLASH' })
-    item = find(refs, { alias })
-    if (item) throw this.bajo.error('pluginNameClash%s%s%s%s', alias, pkg, item.alias, item.pkg, { code: 'BAJO_ALIAS_CLASH' })
-    refs.push({ ns, alias, pkg })
-  }
-}
-
-/**
- * Ensure dependencies are met
- *
- * @async
- */
-export async function checkDependencies () {
-  const { join } = this.bajo
-  this.bajo.log.debug('checkDeps')
-  for (const pkg of this.bajo.app.pluginPkgs) {
-    const plugin = this.bajo.app[camelCase(pkg)]
-    const { ns, dependencies } = plugin
-    this.bajo.log.trace('- %s', ns)
-    const odep = reduce(dependencies, (o, k) => {
-      const item = map(k.split('@'), m => trim(m))
-      if (k[0] === '@') o['@' + item[1]] = item[2]
-      else o[item[0]] = item[1]
-      return o
-    }, {})
-    const deps = keys(odep)
-    if (deps.length > 0) {
-      if (intersection(this.bajo.app.pluginPkgs, deps).length !== deps.length) {
-        throw this.bajo.error('dependencyUnfulfilled%s%s', pkg, join(deps), { code: 'BAJO_DEPENDENCY' })
-      }
-      each(deps, d => {
-        if (!odep[d]) return
-        const ver = get(this.bajo.app[camelCase(d)], 'pkg.version')
-        if (!ver) return
-        if (!semver.satisfies(ver, odep[d])) {
-          throw this.bajo.error('semverCheckFailed%s%s', pkg, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
-        }
-      })
-    }
-  }
-}
-
-/**
- * Collect and build hooks and push them to the bajo's hook system
- *
- * @async
- * @fires bajo:afterCollectHooks
- */
-export async function collectHooks () {
-  const { eachPlugins, runHook, isLogInRange, importModule } = this.bajo
-  const { isArray, isPlainObject } = this.lib._
-  const me = this // "this" is "app"
-  me.bajo.log.trace('collecting%s', this.t('hooks'))
-  await eachPlugins(async function ({ dir, file }) {
-    let mod = await importModule(file, { asHandler: true })
-    if (!mod) return undefined
-    if (file.includes('hook.js')) mod = await mod.handler.call(this)
-    if (isArray(mod)) {
-      for (const m of mod) {
-        if (!isPlainObject(m)) continue
-        if (!m.name) throw me.bajo.error('missing%s%s', 'name', file)
-        if (isArray(m.name)) {
-          for (const name of m.name) {
-            me.bajo.hooks.push(merge({}, m, { name, src: this.ns }))
-          }
-        } else {
-          m.src = this.ns
-          me.bajo.hooks.push(m)
-        }
-      }
-    } else {
-      const _file = file.replace(dir + '/hook/', '').replace('.js', '')
-      let [names, path] = _file.split('@')
-      names = names.split('$').map(n => trim(n))
-      for (let name of names) {
-        name = name.split('.').map(n => camelCase(n)).join('.')
-        const m = merge({}, mod, { name: `${name}:${camelCase(path)}`, src: this.ns })
-        me.bajo.hooks.push(m)
-      }
-    }
-  }, { glob: ['hook/*.js', 'hook.js'], prefix: me.bajo.ns })
-  // for log trace purpose only
-  if (isLogInRange('trace')) {
-    const items = groupBy(me.bajo.hooks, item => item.name)
-    forOwn(items, (v, k) => {
-      const [name, path] = k.split(':')
-      me.bajo.log.trace('- %s:%s (%d)', name, path, v.length)
-    })
-  }
-
-  /**
-   * Run after hooks are collected
-   *
-   * @global
-   * @event bajo:afterCollectHooks
-   * @param {Object[]} hooks - Array of hook objects
-   * @see {@tutorial hook}
-   * @see module:Helper/Base.collectHooks
-   */
-  await runHook('bajo:afterCollectHooks', this.bajo.hooks)
-  me.bajo.log.debug('collected%s%d', this.t('hooks'), me.bajo.hooks.length)
-}
-
-/**
- * Finally, run all plugins
- *
- * @async
- * @fires bajo:beforeAll{method}
- * @fires {ns}:before{method}
- * @fires {ns}:after{method}
- * @fires bajo:afterAll{method}
- */
-export async function run () {
-  const me = this
-  const { runHook, eachPlugins, join } = me.bajo
-  const { freeze } = me.lib
-  const methods = ['init']
-  if (!me.applet) methods.push('start')
-  for (const method of methods) {
-    /**
-     * Run before all ```{method}``` executed. Accepted ```{method}```: ```Init``` or ```Start```
-     *
-     * @global
-     * @event bajo:beforeAll{method}
-     * @param {string} method - Accepted methods: ```Init```, ```Start```
-     * @see module:Helper/Base.run
-     */
-    await runHook(`bajo:${camelCase(`before all ${method}`)}`)
-    await eachPlugins(async function () {
-      const { ns } = this
-      /**
-       * Run before ```{method}``` is executed within ```{ns}``` context
-       *
-       * - ```{ns}``` - namespace
-       * - ```{method}``` - Accepted methods: ```Init``` or ```Start```
-       *
-       * @global
-       * @event {ns}:before{method}
-       * @see module:Helper/Base.run
-       */
-      await runHook(`${ns}:${camelCase(`before ${method}`)}`)
-      await me[ns][method]()
-      /**
-       * Run after ```{method}``` is executed within ```{ns}``` context
-       *
-       * - ```{ns}``` - namespace
-       * - ```{method}``` - Accepted methods: ```Init``` or ```Start```
-       *
-       * @global
-       * @event {ns}:after{method}
-       * @see module:Helper/Base.run
-       */
-      await runHook(`${ns}:${camelCase(`after ${method}`)}`)
-      if (method === 'start') freeze(me[ns].config)
-    })
-    /**
-     * Run after all ```{method}``` executed. Accepted ```{method}```: ```Init``` or ```Start```
-     *
-     * @global
-     * @event bajo:afterAll{method}
-     * @see module:Helper/Base.run
-     */
-    await runHook(`bajo:${camelCase(`after all ${method}`)}`)
-  }
-  if (me.bajo.config.log.level === 'trace') {
-    let text = join(map(me.bajo.app.pluginPkgs, b => camelCase(b)))
-    text += ` (${me.bajo.app.pluginPkgs.length})`
-    me.bajo.log.trace('loadedPlugins%s', text)
-  } else me.bajo.log.debug('loadedPlugins%s', me.bajo.app.pluginPkgs.length)
-}