bajo 1.2.9 → 2.0.0

package/bajoBook/book/reference/pages/helper/dump.md

@@ -1,32 +0,0 @@
----
-title: function dump()
----
-
-A ```console.log``` with untruncated, deep objects. Doesn't return anything, instead prints arguments as nested, deep object.
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-| ```...args``` | ...object || rest parameter of objects |
-
-###### Returns:
-
-```void```
-
-#### Example
-
-```javascript
-...
-const { dump } = this.bajo.helper
-const value = {
-  level1: {
-    level2: {
-      level3: {
-        level4: 'this is a test'
-      }
-    }
-  }
-}
-dump(value)
-```

package/bajoBook/book/reference/pages/helper/each-plugins.md

@@ -1,24 +0,0 @@
----
-title: async function eachPlugins()
----
-
-Walk through all loaded plugins and execute the callback handler.
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-| ```handler``` | async function || callback handler. _Required_ |
-| ```options``` | object |||
-|     ```key``` | string | ```name``` | Key of Bajo's config object that will be used as the key of returned object |
-|     ```glob``` | string/object || see above |
-|     ```ns``` | string | _Autodetect_ | If not set, it defaults to calling plugin |
-|     ```extend``` | string || see above |
-|     ```extendHandler``` | function | ```handler``` | see above |
-|     ```useBajo``` | boolean | ```false``` | weather to scan **bajo** package dir too |
-
-###### Returns:
-
-```object```
-
-#### Example

package/bajoBook/book/reference/pages/helper/envs.md

@@ -1,11 +0,0 @@
----
-title: object envs
----
-
-Variable of object holding all available environtments
-
-#### Example
-
-```javascript
-const { envs } = this.bajo.helper
-console.log(envs) // prints: { dev: 'development', prod: 'production' }

package/bajoBook/book/reference/pages/helper/error.md

@@ -1,29 +0,0 @@
----
-title: function error()
----
-
-A shortcut to create an instance of Error with message and optionally rest parameter within a single line.
-
-Message can hold ```sprintf``` token. If it does, use rest parameter to replace its token.
-
-If last parameter is a plain object, it will be used as error payload.
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-| ```message``` | string || Error message. _Required_ |
-| ```...args``` | ...any || see above |
-
-###### Returns:
-
-```object``` new instance of node's Error
-
-#### Example
-
-```javascript
-...
-const { error } = this.bajo.helper
-const payload = { statusCode: 500, details: [{ field: 'username', error: 'Required' }] }
-throw error('This is a %s error, it should also hold some payloads', 'fatal', payload)
-```

package/bajoBook/book/reference/pages/helper/fatal.md

@@ -1,18 +0,0 @@
----
-title: function fatal()
----
-
-Basically the same as [error()](2.9-error.md), with two extras:
-
-- prints error on screen
-- terminate running program with exit code 1
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-| ```...args``` | ...any || any arguments provided here will be passed through **error()** |
-
-###### Returns:
-
-```void```

package/bajoBook/book/reference/pages/helper/freeze.md

@@ -1,13 +0,0 @@
----
-title: function freeze()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/generate-id.md

@@ -1,36 +0,0 @@
----
-title: function generateId()
----
-
-ID generator based on [nanoid](https://github.com/ai/nanoid).
-
-By default, ```options.pattern``` is set to ```abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789``` so that resulted ID will be a full alphanumeric characters with the length of ```options.length``` (default: ```21```)
-
-If ```options.pattern``` is an object:
-
-- ```pattern```: characters to use
-- ```lowerCase```: if ```true```, only use lowercase
-- ```upperCase```: if ```true```, only use uppercase
-
-```lowerCase``` and ```upperCase``` is mutually exclusive, first one win.
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-| ```options``` | object |||
-|     ```pattern``` | string or object | all alphanumeric characters | see above |
-|     ```length``` | integer | ```21``` | length of generated ID |
-|     ```returnInstance``` | boolean | ```false``` | Set ```true``` to return a nanoid instance |
-
-###### Returns:
-
-```string``` or ```object```
-
-#### Example
-
-```javascript
-...
-const { generateId } = this.bajo.helper
-console.log(generateId()) // returns: <randomly generated characters>
-```

package/bajoBook/book/reference/pages/helper/get-config.md

@@ -1,27 +0,0 @@
----
-title: function getConfig()
----
-
-Get configuration object of **bajo** or its **plugin**
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-| ```name``` | string | ```bajo``` | A valid plugin name |
-| ```options``` | object |||
-|     ```full``` | boolean | ```false``` | If ```true```, returns ALL config objects belonging to named plugin. Otherwise, returns only subset of objects that can be changed through configuration file |
-|     ```clone``` | boolean | ```false``` | If ```true```, returns cloned object |
-
-###### Returns:
-
-```object```
-
-#### Example
-
-```javascript
-...
-const { getConfig } = this.bajo.helper
-const cfg = getConfig('bajoLogger')
-console.log(cfg)
-```

package/bajoBook/book/reference/pages/helper/get-global-module-dir.md

@@ -1,13 +0,0 @@
----
-title: function getGlobalModuleDir()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/get-helper.md

@@ -1,13 +0,0 @@
----
-title: function getHelper()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/get-item-by-name.md

@@ -1,13 +0,0 @@
----
-title: async function getItemByName()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/get-key-by-value.md

@@ -1,13 +0,0 @@
----
-title: function getKeyByValue()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/get-module-dir.md

@@ -1,13 +0,0 @@
----
-title: function getModuleDir()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/get-plugin-data-dir.md

@@ -1,13 +0,0 @@
----
-title: function getPluginDataDir()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/get-plugin-name.md

@@ -1,13 +0,0 @@
----
-title: function getPluginName()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/get-plugin.md

@@ -1,13 +0,0 @@
----
-title: function getPlugin()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/import-module.md

@@ -1,13 +0,0 @@
----
-title: async function importModule()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/import-pkg.md

@@ -1,13 +0,0 @@
----
-title: async function importPkg()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/is-empty-dir.md

@@ -1,13 +0,0 @@
----
-title: async function isEmptyDir()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/is-log-in-range.md

@@ -1,13 +0,0 @@
----
-title: function isLogInRange()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/is-set.md

@@ -1,13 +0,0 @@
----
-title: function isSet()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/is-valid-app.md

@@ -1,13 +0,0 @@
----
-title: function isValidApp()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/is-valid-plugin.md

@@ -1,13 +0,0 @@
----
-title: function isValidPlugin()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/log-levels.md

@@ -1,13 +0,0 @@
----
-title: object logLevels
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/log.md

@@ -1,13 +0,0 @@
----
-title: object log
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/paginate.md

@@ -1,13 +0,0 @@
----
-title: function paginate()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/pascal-case.md

@@ -1,13 +0,0 @@
----
-title: function pascalCase()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/print.md

@@ -1,13 +0,0 @@
----
-title: object print
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/read-config.md

@@ -1,13 +0,0 @@
----
-title: async function readConfig()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/read-json.md

@@ -1,13 +0,0 @@
----
-title: function readJson()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/resolve-path.md

@@ -1,13 +0,0 @@
----
-title: function resolvePath()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/resolve-tpl-path.md

@@ -1,13 +0,0 @@
----
-title: function resolveTplPath()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/run-hook.md

@@ -1,13 +0,0 @@
----
-title: async function runHook()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/save-as-download.md

@@ -1,13 +0,0 @@
----
-title: async function saveAsDownload()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/titleize.md

@@ -1,13 +0,0 @@
----
-title: function titleize()
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/bajoBook/book/reference/pages/helper/white-space.md

@@ -1,13 +0,0 @@
----
-title: array whiteSpace
----
-
-###### Parameters:
-
-| Name | Type | Default Value | Description |
-| ---- | ---- | ------------- | ----------- |
-
-###### Returns:
-
-
-#### Example

package/boot/class/app.js

@@ -1,67 +0,0 @@
-import util from 'util'
-import lodash from 'lodash'
-import BajoCore from './bajo-core.js'
-import resolvePath from '../lib/resolve-path.js'
-import parseArgsArgv from '../lib/parse-args-argv.js'
-import parseEnv from '../lib/parse-env.js'
-import buildPlugins from './bajo-core/build-plugins.js'
-import { buildBaseConfig, buildExtConfig } from './bajo-core/build-config.js'
-import collectConfigHandlers from './bajo-core/collect-config-handlers.js'
-import bootOrder from './bajo-core/boot-order.js'
-import bootPlugins from './bajo-core/boot-plugins.js'
-import exitHandler from './bajo-core/exit-handler.js'
-import runAsApplet from './bajo-core/run-as-applet.js'
-
-const { last } = lodash
-
-class App {
-  constructor (cwd) {
-    if (!cwd) cwd = process.cwd()
-    const l = last(process.argv)
-    if (l.startsWith('--cwd')) {
-      const parts = l.split('=')
-      cwd = parts[1]
-    }
-    this.dir = resolvePath(cwd)
-    process.env.APPDIR = this.dir
-  }
-
-  addPlugin = (plugin) => {
-    if (this[plugin.name]) throw new Error(`Plugin '${plugin.name}' added already`)
-    this[plugin.name] = plugin
-  }
-
-  dump = (...args) => {
-    const terminate = last(args) === true
-    if (terminate) args.pop()
-    for (const arg of args) {
-      const result = util.inspect(arg, false, null, true)
-      console.log(result)
-    }
-    if (terminate) process.kill(process.pid, 'SIGINT')
-  }
-
-  boot = async () => {
-    // argv/args
-    const { args, argv } = await parseArgsArgv.call(this.app) ?? {}
-    this.argv = argv
-    this.args = args
-    this.env = parseEnv() ?? {}
-
-    const bajo = new BajoCore(this)
-    await buildBaseConfig.call(bajo)
-    await buildPlugins.call(bajo)
-    await collectConfigHandlers.call(bajo)
-    await buildExtConfig.call(bajo)
-    await bootOrder.call(bajo)
-    await bootPlugins.call(bajo)
-    await exitHandler.call(bajo)
-    // boot complete
-    const elapsed = new Date() - bajo.runAt
-    bajo.log.info('bootCompleted%s', bajo.lib.aneka.secToHms(elapsed, true))
-    await bajo.runHook('bajo:afterBootComplete')
-    if (bajo.applet) await runAsApplet.call(bajo)
-  }
-}
-
-export default App