bajo 2.17.0 → 2.18.0

package/class/app.js

@@ -3,6 +3,7 @@ import Bajo from './bajo.js'
 import Base from './base.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'
 
@@ -255,6 +256,103 @@ class App {
     return this.pluginPkgs.map(pkg => camelCase(pkg))
   }
 
+  /**
+   * 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.
    *
@@ -273,7 +371,8 @@ class App {
   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 }

package/class/bajo.js

@@ -33,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
@@ -172,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')
@@ -572,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.
    *
@@ -730,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)
   }
@@ -916,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()
@@ -1065,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/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/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.17.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,10 @@
 # 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```