bajo 2.2.1 → 2.3.1

package/class/app.js

@@ -1,43 +1,14 @@
 import util from 'util'
-import lodash from 'lodash'
 import Bajo from './bajo.js'
-import fastGlob from 'fast-glob'
-import { sprintf } from 'sprintf-js'
-import outmatch from 'outmatch'
-import fs from 'fs-extra'
-import aneka from 'aneka/index.js'
 import Base from './base.js'
-import freeze from '../lib/freeze.js'
 import { runAsApplet } from './helper/bajo.js'
 import Tools from './plugin/tools.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 findDeep from '../lib/find-deep.js'
-
-dayjs.extend(utc)
-dayjs.extend(customParseFormat)
-dayjs.extend(localizedFormat)
-dayjs.extend(weekOfYear)
-
-const { camelCase, isPlainObject, get, reverse, map, last, without } = lodash
-const { pascalCase } = aneka
-let unknownLangWarning = false
 
-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
-  }
-}
+import { outmatchNs, parseObject, lib } from './helper/app.js'
+
+const { camelCase, isPlainObject, get, reverse, map, last, without } = lib._
+const { pascalCase } = lib.aneka
+let unknownLangWarning = false
 
 /**
  * @typedef {Object} TAppEnv
@@ -46,31 +17,6 @@ function outmatchNs (source, pattern) {
  * @see App
  */
 
-/**
- * @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
- */
-const lib = {
-  _: lodash,
-  fs,
-  fastGlob,
-  sprintf,
-  outmatch,
-  dayjs,
-  aneka,
-  freeze,
-  findDeep
-}
-
 /**
  * App class. This is the root. This is where all plugins call it home.
  *
@@ -78,9 +24,19 @@ const lib = {
  */
 class App {
   /**
-   * @param {string} cwd - Current working dirctory
+   * @param {Object} [options] - App options
+   * @param {string} [options.cwd] - Set current working directory. Defaults to the script directory
+   * @param {string[]} [options.plugins] - Array of plugins to load. If provided, it override the list in ```package.json``` and ```.plugins``` file
+   * @param {Object} [options.config] - Plugin's config object. If provided, plugin configs will no longer be read from its config files
    */
-  constructor (cwd) {
+  constructor (options = {}) {
+    /**
+     * Copy of provided options
+     *
+     * @type {Object}
+     */
+    this.options = options
+
     /**
      * Your main namespace. And yes, you suppose to NOT CHANGE this
      *
@@ -115,7 +71,7 @@ class App {
      *
      * @type {Array}
      */
-    this.pluginPkgs = []
+    this.pluginPkgs = options.plugins ?? []
 
     /**
      * @typedef {Object} TAppConfigHandler
@@ -150,20 +106,7 @@ class App {
      */
     this.lib = lib
     this.lib.outmatchNs = outmatchNs.bind(this)
-    this.lib.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)
-    }
+    this.lib.parseObject = parseObject.bind(this)
 
     /**
      * Instance of system log
@@ -253,13 +196,13 @@ class App {
      */
     this.envVars = {}
 
-    if (!cwd) cwd = process.cwd()
+    if (!options.cwd) options.cwd = process.cwd()
     const l = last(process.argv)
     if (l.startsWith('--cwd')) {
       const parts = l.split('=')
-      cwd = parts[1]
+      options.cwd = parts[1]
     }
-    this.dir = aneka.resolvePath(cwd)
+    this.dir = this.lib.aneka.resolvePath(options.cwd)
     process.env.APPDIR = this.dir
   }
 
@@ -320,17 +263,20 @@ class App {
    * @fires bajo:afterBootCompleted
    */
   boot = async () => {
-    // argv/args/env
     this.bajo = new Bajo(this)
-    const { argv, args } = await aneka.parseArgsArgv() ?? {}
+    // argv/args/env
+    const { parseArgsArgv, parseEnv, secToHms } = this.lib.aneka
+    const { parseObject } = this.lib
+    const { argv, args } = await parseArgsArgv({ cwd: this.options.cwd })
+
     this.args = args
-    this.argv = aneka.parseObject(argv, { parseValue: true })
-    this.envVars = aneka.parseObject(aneka.parseEnv(), { parseValue: true })
+    this.argv = parseObject(argv, { parseValue: true })
+    this.envVars = parseObject(parseEnv(), { parseValue: true })
     this.applet = this.envVars._.applet ?? this.argv._.applet
     await this.bajo.init()
     // boot complete
     const elapsed = new Date() - this.runAt
-    this.bajo.log.debug('bootCompleted%s', aneka.secToHms(elapsed, true))
+    this.bajo.log.debug('bootCompleted%s', secToHms(elapsed, true))
     /**
      * Run after boot process is completed
      *
@@ -362,6 +308,8 @@ class App {
    * @param {string} ns - Plugin name
    */
   loadIntl = (ns) => {
+    const { fs } = this.lib
+
     this[ns].intl = {}
     for (const l of this.bajo.config.intl.supported) {
       this[ns].intl[l] = {}
@@ -393,6 +341,8 @@ class App {
    * @returns {string}
    */
   t = (ns, text, ...params) => {
+    const { formatText } = this.lib.aneka
+
     if (!text) {
       text = ns
       ns = 'bajo'
@@ -426,7 +376,7 @@ class App {
       }
     }
     if (!trans) trans = text
-    return aneka.formatText(trans, ...params)
+    return formatText(trans, ...params)
   }
 
   /**

package/class/base.js

@@ -38,11 +38,12 @@ class Base extends Plugin {
    */
   loadConfig = async () => {
     const { defaultsDeep } = this.app.lib.aneka
-    const { get, keys, pick } = this.app.lib._
+    const { get, keys, pick, isEmpty } = this.app.lib._
     const { log, getModuleDir, readAllConfigs } = this.app.bajo
     const { parseObject } = this.app.lib
 
-    const defKeys = keys(this.config)
+    const defKeys = keys(this.config).concat(this.app.getAllNs())
+    defKeys.push('title')
     log.trace('- %s', this.ns)
     const dir = this.ns === this.app.mainNs ? (`${this.app.bajo.dir.base}/${this.app.mainNs}`) : getModuleDir(this.pkgName)
     let cfg = await readAllConfigs(`${dir}/config`)
@@ -53,14 +54,14 @@ class Base extends Plugin {
     }
     // merge with config from datadir
     try {
-      const altCfg = await readAllConfigs(`${this.app.bajo.dir.data}/config/${this.ns}`)
+      let altCfg = get(this, `app.options.config.${this.ns}`, {})
+      if (isEmpty(altCfg)) altCfg = await readAllConfigs(`${this.app.bajo.dir.data}/config/${this.ns}`)
       cfg = defaultsDeep({}, altCfg, cfg)
     } catch (err) {}
     const cfgEnv = get(this, `app.env.${this.ns}`, {})
     const cfgArgv = get(this, `app.argv.${this.ns}`, {})
     const envArgv = defaultsDeep({}, cfgEnv, cfgArgv)
     cfg = pick(defaultsDeep({}, envArgv ?? {}, cfg ?? {}, this.config ?? {}), defKeys)
-    this.title = this.title ?? cfg.title ?? this.alias
     this.config = parseObject(cfg, { parseValue: true })
   }
 

package/class/helper/app.js

@@ -0,0 +1,73 @@
+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/bajo.js

@@ -1,6 +1,5 @@
 import Print from '../plugin/print.js'
 import Log from '../app/log.js'
-import omitDeep from 'omit-deep'
 import os from 'os'
 import fs from 'fs-extra'
 import lodash from 'lodash'
@@ -25,8 +24,6 @@ const {
   keys,
   set,
   get,
-  filter,
-  trim,
   without,
   uniq,
   camelCase,
@@ -125,20 +122,24 @@ export async function buildBaseConfig () {
     fs.ensureDirSync(this.dir.tmp)
   }
   this.pkg = await this.getPkgInfo()
-  // collect list of plugins
-  const mainPkg = await this.getPkgInfo(this.app.dir)
-  let pluginPkgs = get(mainPkg, 'bajo.plugins', [])
+  let pluginPkgs = this.app.pluginPkgs
   if (isEmpty(pluginPkgs)) {
-    const pluginsFile = `${this.dir.data}/config/.plugins`
-    if (fs.existsSync(pluginsFile)) {
-      pluginPkgs = pluginPkgs.concat(filter(map(trim(fs.readFileSync(pluginsFile, 'utf8')).split('\n'), p => trim(p)), b => !isEmpty(b)))
+    // collect list of plugins
+    const mainPkg = await this.getPkgInfo(this.app.dir)
+    pluginPkgs = get(mainPkg, 'bajo.plugins', [])
+    if (isEmpty(pluginPkgs)) {
+      const pluginsFile = `${this.dir.data}/config/.plugins`
+      if (fs.existsSync(pluginsFile)) {
+        let lines = fs.readFileSync(pluginsFile, 'utf8')
+        lines = lines.trim().split('\n').map(p => p.trim())
+        pluginPkgs = lines.filter(c => {
+          const line = c.split('#')[0].trim()
+          return !isEmpty(line)
+        })
+      }
     }
   }
-  this.app.pluginPkgs = map(filter(without(uniq(pluginPkgs), this.app.mainNs), p => {
-    return p[0] !== '#'
-  }), p => {
-    return trim(p.split('#')[0])
-  })
+  this.app.pluginPkgs = without(uniq(pluginPkgs), this.app.mainNs)
   this.app.pluginPkgs.push(this.app.mainNs)
 }
 
@@ -210,9 +211,11 @@ export async function collectConfigHandlers () {
 export async function buildExtConfig () {
   // config merging
   const { defaultsDeep } = this.app.lib.aneka
-  const { parseObject } = this.app.lib
+  const { parseObject, omitDeep } = this.app.lib
+  const { isEmpty, get } = this.app.lib._
 
-  let resp = await this.readAllConfigs(`${this.dir.data}/config/${this.ns}`)
+  let resp = get(this, `app.options.config.${this.ns}`, {})
+  if (isEmpty(resp)) resp = await this.readAllConfigs(`${this.dir.data}/config/${this.ns}`)
   resp = omitDeep(pick(resp, ['log', 'exitHandler', 'env', 'runtime']), omitted)
   const envs = this.app.envs
   this.config = defaultsDeep({}, this.config, resp, defConfig)

package/class/helper/base.js

@@ -78,14 +78,14 @@ export async function checkDependencies () {
     const deps = keys(odep)
     if (deps.length > 0) {
       if (intersection(this.bajo.app.pluginPkgs, deps).length !== deps.length) {
-        throw this.error('dependencyUnfulfilled%s%s', pkg, join(deps), { code: 'BAJO_DEPENDENCY' })
+        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.error('semverCheckFailed%s%s', pkg, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
+          throw this.bajo.error('semverCheckFailed%s%s', pkg, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
         }
       })
     }

package/index.js

@@ -21,19 +21,21 @@ shim()
  *
  * @global
  * @async
- * @see {@tutorial 01-getting-started}
- * @param {string} [cwd] - Current working directory
+ * @param {Object} [options] - App options
+ * @param {string} [options.cwd] - Set current working directory. Defaults to the script directory
+ * @param {string[]} [options.plugins] - Array of plugins to load. If provided, it override the list in ```package.json``` and ```.plugins``` file
+ * @param {Object} [options.config] - Plugin's config object. If provided, plugin configs will no longer be read from its config files
  * @returns {App}
  */
-async function boot (cwd) {
-  if (!cwd) cwd = process.cwd()
-  const pkgFile = `${cwd}/package.json`
+async function boot (options = {}) {
+  if (!options.cwd) options.cwd = process.cwd()
+  const pkgFile = `${options.cwd}/package.json`
   const pkg = fs.readJsonSync(pkgFile)
   if (pkg.type !== 'module') {
     console.error(`Please turn on ES6 parsing by adding "type": "module" to ${pkgFile}!`)
     process.exit(1)
   }
-  const app = new App(cwd)
+  const app = new App(options)
   return await app.boot()
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bajo",
-  "version": "2.2.1",
+  "version": "2.3.1",
   "description": "The ultimate framework for whipping up massive apps in no time",
   "main": "index.js",
   "scripts": {
@@ -26,7 +26,7 @@
   "homepage": "https://github.com/ardhi/bajo#readme",
   "dependencies": {
     "add-filename-increment": "^1.0.0",
-    "aneka": "^0.10.0",
+    "aneka": "^0.11.1",
     "chalk": "^5.6.0",
     "dayjs": "^1.11.13",
     "deep-freeze-strict": "^1.1.1",

package/wiki/CHANGES.md

@@ -1,5 +1,15 @@
 # Changes
 
+## 2026-01-21
+
+- [2.3.1] Bug fix on keys that needs to be used while reading plugin's config files
+
+## 2026-01-18
+
+- [2.3.0] ```App``` constructor now accept an object as its parameter. For details, please see documentation
+- [2.3.0] Package upgrade to ```aneka@0.11.0```
+- [2.3.0] Bug fix on ```checkDependencies()```
+
 ## 2026-01-16
 
 - [2.2.1] Bug fix on multiple appearance of loaded plugins info