bajo 2.18.0 → 2.19.0

package/class/err.js

@@ -18,37 +18,40 @@ Error.stackTraceLimit = 15
  */
 class Err extends Tools {
   /**
-   * @param {Plugin} plugin - Plugin instance
-   * @param {string} msg - Error message
-   * @param  {...any} [args] - Variables to interpolate with error message. Payload object can be pushed at the very last argument
+   * @param {Plugin} plugin Plugin instance.
+   * @param {string} msg Error message.
+   * @param  {...any} [args] Variables to interpolate with error message. Payload object can be pushed at the very last argument
    */
   constructor (plugin, msg, ...args) {
     super(plugin)
 
     /**
-     * Error payload extracted from the last arguments
+     * Error payload extracted from the last arguments.
+     *
      * @type {Object}
      */
     this.payload = args.length > 0 && isPlainObject(args[args.length - 1]) ? args[args.length - 1] : {}
 
     /**
-     * Original message before translation
+     * Original message before translation.
+     *
      * @type {string}
      */
     this.orgMessage = msg
 
     /**
-     * Translated message
+     * Translated message.
+     *
      * @type {string}
      */
     this.message = this.payload.noTrans ? msg : this.plugin.t(msg, ...args)
   }
 
   /**
-   * Write message to the console
+   * Write message to the console.
    *
    * @method
-   * @returns {Err} Error object, usefull for chaining
+   * @returns {Err} Error object, useful for chaining.
    */
   write = () => {
     let err
@@ -78,7 +81,7 @@ class Err extends Tools {
   }
 
   /**
-   * Print instance on console and terminate process
+   * Print instance on console and terminate process.
    *
    * @method
    */
@@ -89,10 +92,10 @@ class Err extends Tools {
   }
 
   /**
-   * Pretty format error details
+   * Pretty format error details.
    *
    * @method
-   * @param {Object} value - Value to format
+   * @param {Object} value Value to format.
    * @returns {Object}
    */
   formatErrorDetails = (value) => {

package/class/log.js

@@ -4,16 +4,16 @@ import chalk from 'chalk'
 import { stripVTControlCharacters } from 'node:util'
 
 /**
- * Log output in stringified JSON format. Returned when app run in ```prod``` environment
+ * Log output in stringified JSON format. Returned when app run in ```prod``` environment.
  *
  * @typedef TLogJson
- * @property {string} prefix - Message prefix
- * @property {string} message - The message itself
- * @property {string} level - Log level
- * @property {number} time - Time in millisecond
- * @property {number} pid - Process ID
- * @property {string} hostname - Hostname
- * @property {Object} [data] - Payload data, if any
+ * @property {string} prefix Message prefix.
+ * @property {string} message The message itself.
+ * @property {string} level Log level.
+ * @property {number} time Time in millisecond.
+ * @property {number} pid Process ID.
+ * @property {string} hostname Hostname.
+ * @property {Object} [data] Payload data, if any.
  * @see Log#formatMsg
  */
 
@@ -44,7 +44,8 @@ class Log {
   constructor (app) {
     this.lastDelta = 0
     /**
-     * The app instance
+     * The app instance.
+     *
      * @type {App}
      */
     this.app = app
@@ -63,9 +64,9 @@ class Log {
    * In ```prod``` environment, log will be delivered as JSON stringified object. See {@link TLogJson} for more info
    *
    * @method
-   * @param {string} level - Log level to use
-   * @param {string} prefix - Prefix to the message
-   * @param {...any} params - See format above
+   * @param {string} level Log level to use.
+   * @param {string} prefix Prefix to the message.
+   * @param {...any} params See format above.
    * @see Err
    * @see TLogJson
    */
@@ -126,11 +127,11 @@ class Log {
   }
 
   /**
-   * Calculate pattern used for log rotation
+   * Calculate pattern used for log rotation.
    *
    * @method
-   * @param {boolean} isPrev - If true, calculate previous rotation pattern
-   * @returns {string} Calculated pattern
+   * @param {boolean} isPrev If true, calculate previous rotation pattern.
+   * @returns {string} Calculated pattern.
    */
   getRotationPattern = (isPrev) => {
     const { dayjs } = this.app.lib
@@ -159,11 +160,11 @@ class Log {
   }
 
   /**
-   * Save log to file in {dataDir}/log
+   * Save log to file in {dataDir}/log.
    *
    * @method
-   * @param {string} text - Log message to save
-   * @param {string} prefix - Use prefix as basename. Defaults to 'bajo'
+   * @param {string} text Log message to save.
+   * @param {string} prefix Use prefix as basename. Defaults to 'bajo'.
    */
   save = (text, prefix = 'bajo') => {
     const { fs } = this.app.lib
@@ -179,84 +180,84 @@ class Log {
   }
 
   /**
-   * Display & format message in ```trace``` level. See {@link Log#formatMsg|formatMsg} for details
+   * Display & format message in ```trace``` level. See {@link Log#formatMsg|formatMsg} for details.
    *
    * @method
-   * @param {string} prefix - Message prefix
-   * @param {...any} params - Parameters
+   * @param {string} prefix Message prefix.
+   * @param {...any} params Parameters.
    */
   trace = (prefix, ...params) => {
     this.formatMsg('trace', prefix, ...params)
   }
 
   /**
-   * Display & format message in ```debug``` level. See {@link Log#formatMsg|formatMsg} for details
+   * Display & format message in ```debug``` level. See {@link Log#formatMsg|formatMsg} for details.
    *
    * @method
-   * @param {string} prefix - Message prefix
-   * @param {...any} params - Parameters
+   * @param {string} prefix Message prefix.
+   * @param {...any} params Parameters.
    */
   debug = (prefix, ...params) => {
     this.formatMsg('debug', prefix, ...params)
   }
 
   /**
-   * Display & format message in ```info``` level. See {@link Log#formatMsg|formatMsg} for details
+   * Display & format message in ```info``` level. See {@link Log#formatMsg|formatMsg} for details.
    *
    * @method
-   * @param {string} prefix - Message prefix
-   * @param {...any} params - Parameters
+   * @param {string} prefix Message prefix.
+   * @param {...any} params Parameters.
    */
   info = (prefix, ...params) => {
     this.formatMsg('info', prefix, ...params)
   }
 
   /**
-   * Display & format message in ```warn``` level. See {@link Log#formatMsg|formatMsg} for details
+   * Display & format message in ```warn``` level. See {@link Log#formatMsg|formatMsg} for details.
    *
    * @method
-   * @param {string} prefix - Message prefix
-   * @param {...any} params - Parameters
+   * @param {string} prefix Message prefix.
+   * @param {...any} params Parameters.
    */
   warn = (prefix, ...params) => {
     this.formatMsg('warn', prefix, ...params)
   }
 
   /**
-   * Display & format message in ```error``` level. See {@link Log#formatMsg|formatMsg} for details
+   * Display & format message in ```error``` level. See {@link Log#formatMsg|formatMsg} for details.
    *
    * @method
-   * @param {string} prefix - Message prefix
-   * @param {...any} params - Parameters
+   * @param {string} prefix Message prefix.
+   * @param {...any} params Parameters.
    */
   error = (prefix, ...params) => {
     this.formatMsg('error', prefix, ...params)
   }
 
   /**
-   * Display & format message in ```fatal``` level. See {@link Log#formatMsg|formatMsg} for details
+   * Display & format message in ```fatal``` level. See {@link Log#formatMsg|formatMsg} for details.
    *
    * @method
-   * @param {string} prefix - Message prefix
-   * @param {...any} params - Parameters
+   * @param {string} prefix Message prefix.
+   * @param {...any} params Parameters.
    */
   fatal = (prefix, ...params) => {
     this.formatMsg('fatal', prefix, ...params)
   }
 
   /**
-   * Display & format message in ```silent``` level. See {@link Log#formatMsg|formatMsg} for details
+   * Display & format message in ```silent``` level. See {@link Log#formatMsg|formatMsg} for details.
    *
    * @method
-   * @param {string} prefix - Message prefix
-   * @param {...any} params - Parameters
+   * @param {string} prefix Message prefix.
+   * @param {...any} params Parameters.
    */
   silent = (prefix, ...params) => {
     this.formatMsg('silent', prefix, ...params)
   }
 
   /**
-   * Dispose internal references
+   * Dispose internal references.
    */
   dispose = async () => {
     this.app = null

package/class/plugin.js

@@ -8,19 +8,19 @@ const { get, isEmpty, cloneDeep, omit, isPlainObject, camelCase } = lodash
  * respectfully.
  *
  * There are currently only two main plugins available:
- * - {@link Bajo} - Core plugin class, responsible for system wide setup and boot process. You should not touch this obviously
- * - {@link Base} - Base plugin class your own plugin should extend from
+ * - {@link Bajo} - Core plugin class, responsible for system wide setup and boot process. You should not touch this obviously.
+ * - {@link Base} - Base plugin class your own plugin should inherite from.
  *
  * @class
  */
 class Plugin {
   /**
-   * @param {string} pkgName - Package name (the one you use in package.json)
-   * @param {Object} app - App instance reference. Usefull to call app method inside a plugin
+   * @param {string} pkgName Package name (the one you use in package.json).
+   * @param {Object} app App instance reference. Usefull to call app method inside a plugin.
    */
   constructor (pkgName, app) {
     /**
-     * Package name, the one from package.json
+     * Package name, the one from package.json.
      *
      * @memberof Plugin
      * @constant {string}
@@ -28,7 +28,7 @@ class Plugin {
     this.pkgName = pkgName
 
     /**
-     * Namespace (ns) or plugin's name. Simply the camel cased version of plugin's package name
+     * Namespace (ns) or plugin's name. Simply the camel cased version of plugin's package name.
      *
      * @memberof Plugin
      * @constant {string}
@@ -37,7 +37,7 @@ class Plugin {
 
     /**
      * Plugin alias. Derived plugin must provide its own, unique alias. If it left blank,
-     * Bajo will provide this automatically (by using the kebab-cased version of plugin name)
+     * Bajo will provide this automatically (by using the kebab-cased version of plugin name).
      *
      * @readonly
      * @memberof Plugin
@@ -46,14 +46,14 @@ class Plugin {
     this.alias = null
 
     /**
-     * Reference to app instance
+     * Reference to the app instance.
      *
      * @type {Object}
      */
     this.app = app
 
     /**
-     * Config object
+     * Config object.
      *
      * @type {Object}
      * @see {@tutorial config}
@@ -61,7 +61,7 @@ class Plugin {
     this.config = {}
 
     /**
-     * Shortcut to {@link App#log} with prefix parameter set to this plugin name.
+     * Shortcut to {@link App#log} with prefix parameter set to this plugin namespace.
      *
      * @type {Log}
      */
@@ -77,11 +77,11 @@ class Plugin {
   }
 
   /**
-   * Get package info
+   * Get package info.
    *
    * @method
-   * @param {string} [dir] - Package directory. Defaults to the current plugin's package dir
-   * @param {Array} [keys=['name', 'version', 'description', 'author', 'license', 'homepage', 'bajo']] - Field keys to be use. Set empty to use all keys.
+   * @param {string} [dir] Package directory. Defaults to the current plugin's package dir.
+   * @param {Array} [keys=['name', 'version', 'description', 'author', 'license', 'homepage', 'bajo']] Field keys to be use. Set empty to use all keys.
    */
   getPkgInfo = (dir, keys = ['name', 'version', 'description', 'author', 'license', 'homepage', 'bajo']) => {
     const { pick, isEmpty } = this.app.lib._
@@ -92,15 +92,15 @@ class Plugin {
   }
 
   /**
-   * Get plugin's config value
+   * Get plugin's config value.
    *
    * @method
-   * @param {string} [path] - dot separated config path (think of lodash's 'get'). If not provided, the full config will be given
-   * @param {Object} [options={}] - Options
-   * @param {any} [options.defValue={}] - Default value to use if returned object is undefined
-   * @param {string[]} [options.omit=[]] - Omit these keys from returned object
-   * @param {boolean} [options.noClone=false] - Set true to NOT clone returned object
-   * @returns {Object} Returned object. If no path provided, the whole config object is returned
+   * @param {string} [path] dot separated config path (think of lodash's 'get'). If not provided, the full config will be given.
+   * @param {Object} [options={}] Options.
+   * @param {any} [options.defValue={}] Default value to use if returned object is undefined.
+   * @param {string[]} [options.omit=[]] Omit these keys from returned object.
+   * @param {boolean} [options.noClone=false] Set true to NOT clone returned object.
+   * @returns {Object} Returned object. If no path provided, the whole config object is returned.
    */
   getConfig = (path, options = {}) => {
     let obj = isEmpty(path) ? this.config : get(this.config, path, options.defValue ?? {})
@@ -111,12 +111,12 @@ class Plugin {
   }
 
   /**
-   * Create an instance of {@link Err} object
+   * Create an instance of {@link Err} object.
    *
    * @method
-   * @param {msg} msg - Error message
-   * @param  {...any} [args] - Argument variables you might want to add to the error object
-   * @returns {Object} Err instance
+   * @param {string} msg Error message.
+   * @param  {...any} [args] Argument variables you might want to add to the error object.
+   * @returns {Object} Err instance.
    */
   error = (msg, ...args) => {
     if (!this.print) return new Error(msg, ...args)
@@ -126,11 +126,11 @@ class Plugin {
 
   /**
    * Create an instance of Err object, display it on screen and then force
-   * terminate the app process
+   * terminate the app process.
    *
    * @method
-   * @param {msg} msg - Error message
-   * @param  {...any} [args] - Argument variables you might want to add to the error object
+   * @param {string} msg Error message.
+   * @param  {...any} [args] Argument variables you might want to add to the error object.
    */
   fatal = (msg, ...args) => {
     if (!this.print) return new Error(msg, ...args)
@@ -143,8 +143,8 @@ class Plugin {
    *
    * Shortcut to {@link App#t} with ns parameter set to this plugin namespace.
    *
-   * @param {string} text - Text to translate
-   * @param  {...any} params - Variables to interpolate to ```text```
+   * @param {string} text Text to translate.
+   * @param  {...any} params Variables to interpolate to ```text```.
    * @returns {string}
    */
   t = (text, ...params) => {
@@ -156,8 +156,8 @@ class Plugin {
    *
    * Shortcut to {@link App#te} with ns parameter set to this plugin namespace.
    *
-   * @param {string} text - Text to translate
-   * @param  {...any} params - Variables to interpolate to ```text```
+   * @param {string} text Text to translate.
+   * @param  {...any} params Variables to interpolate to ```text```.
    * @returns {string}
    */
   te = (text, ...params) => {
@@ -165,9 +165,9 @@ class Plugin {
   }
 
   /**
-   * Force bind methods to self (```this```)
+   * Force bind methods to self (```this```).
    *
-   * @param {string[]} names - Method's names
+   * @param {string[]} names Method's names.
    */
   selfBind (names) {
     if (!Array.isArray(names)) names = [names]
@@ -177,17 +177,16 @@ class Plugin {
   }
 
   /**
-   * Alias to ```this.app.dump()```
+   * Alias to ```this.app.dump()```.
    *
    * @param {...any} args
-   * @returns
    */
   dump = (...args) => {
     this.app.dump(...args)
   }
 
   /**
-   * Dispose internal references
+   * Dispose internal references.
    */
   dispose = async () => {
     this.app = null