bajo 2.18.0 → 2.20.0

package/class/print.js

@@ -8,10 +8,10 @@ const { isPlainObject } = lodash
 
 /**
  * @typedef TPrintOptions
- * @property {boolean} [showDatetime=false] - Show actual date & time
- * @property {boolean} [showCounter=false] - Show as counter
- * @property {boolean} [silent] - Suppress any messages. Defaults to the one set in {@tutorial config}
- * @property {Object} [ora] - {@link https://github.com/sindresorhus/ora#api|Ora's options} object
+ * @property {boolean} [showDatetime=false] Show actual date & time.
+ * @property {boolean} [showCounter=false] Show as counter.
+ * @property {boolean} [silent] Suppress any messages. Defaults to the one set in {@tutorial config}.
+ * @property {Object} [ora] {@link https://github.com/sindresorhus/ora#api|Ora's options} object.
  * @see {@link Print}
  */
 
@@ -25,14 +25,15 @@ const { isPlainObject } = lodash
  */
 class Print extends Tools {
   /**
-   * @param {Plugin} plugin - Plugin instance
-   * @param {TPrintOptions} [options={}] - Options object
+   * @param {Plugin} plugin Plugin instance.
+   * @param {TPrintOptions} [options={}] Options object.
    */
   constructor (plugin, options = {}) {
     super(plugin)
 
     /**
-     * Options object
+     * Options object.
+     *
      * @type {TPrintOptions}
      */
     this.options = options
@@ -42,7 +43,8 @@ class Print extends Tools {
     }
 
     /**
-     * Time when instance is created
+     * Time when instance is created.
+     *
      * @type {Object}
      * @see {@link https://day.js.org|dayjs}  object
      */
@@ -50,6 +52,7 @@ class Print extends Tools {
 
     /**
      * ora instance
+     *
      * @see {@link https://github.com/sindresorhus/ora|ora}
      */
     this.ora = ora(this.options.ora)
@@ -57,10 +60,10 @@ class Print extends Tools {
   }
 
   /**
-   * Setting spinner options; override the one passed at constructor
+   * Setting spinner options; override the one passed at constructor.
    *
    * @method
-   * @param {any[]} [args=[]] - Array of options. If the last argument is an object, it will be used to override ora options
+   * @param {any[]} [args=[]] Array of options. If the last argument is an object, it will be used to override ora options.
    */
   setOpts = (args = []) => {
     const { silent } = this.app.bajo.config
@@ -71,10 +74,10 @@ class Print extends Tools {
   }
 
   /**
-   * Translate, prefixed with counter and/or datetime etc
+   * Translate, prefixed with counter and/or datetime etc.
    *
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options.
    * @returns {string}
    */
   buildText = (text, ...args) => {
@@ -89,12 +92,12 @@ class Print extends Tools {
   }
 
   /**
-   * Set spinner's text
+   * Set spinner's text,
    *
    * @method
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options.
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   setText = (text, ...args) => {
     text = this.buildText(text, ...args)
@@ -103,10 +106,10 @@ class Print extends Tools {
   }
 
   /**
-   * Get elapsed time since instance is created
+   * Get elapsed time since instance is created.
    *
    * @method
-   * @param {string} [unit=hms] - Unit's time. Put 'hms' (default) to get hour, minute, second format or of any format supported by {@link https://day.js.org/docs/en/display/difference|dayjs}
+   * @param {string} [unit=hms] Unit's time. Put 'hms' (default) to get hour, minute, second format or of any format supported by {@link https://day.js.org/docs/en/display/difference|dayjs}.
    * @returns {string} Elapsed time since start
    * @see {@link https://day.js.org/docs/en/display/difference|dayjs duration format}
    */
@@ -117,12 +120,12 @@ class Print extends Tools {
   }
 
   /**
-   * Start the spinner
+   * Start the spinner,
    *
    * @method
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora's options.
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   start = (text, ...args) => {
     this.setOpts(args)
@@ -132,10 +135,10 @@ class Print extends Tools {
   }
 
   /**
-   * Stop the spinner
+   * Stop the spinner.
    *
    * @method
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   stop = () => {
     this.ora.stop()
@@ -143,12 +146,12 @@ class Print extends Tools {
   }
 
   /**
-   * Print success message, prefixed with a check icon
+   * Print success message, prefixed with a check icon.
    *
    * @method
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   succeed = (text, ...args) => {
     this.setText(text, ...args)
@@ -157,12 +160,12 @@ class Print extends Tools {
   }
 
   /**
-   * Print failed message, prefixed with a cross icon
+   * Print failed message, prefixed with a cross icon.
    *
    * @method
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   fail = (text, ...args) => {
     this.setText(text, ...args)
@@ -171,12 +174,12 @@ class Print extends Tools {
   }
 
   /**
-   * Print warning message, prefixed with a warn icon
+   * Print warning message, prefixed with a warn icon.
    *
    * @method
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   warn = (text, ...args) => {
     this.setText(text, ...args)
@@ -185,12 +188,12 @@ class Print extends Tools {
   }
 
   /**
-   * Print information message, prefixed with an info icon
+   * Print information message, prefixed with an info icon.
    *
    * @method
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   info = (text, ...args) => {
     this.setText(text, ...args)
@@ -199,10 +202,10 @@ class Print extends Tools {
   }
 
   /**
-   * Clear spinner text
+   * Clear spinner text.
    *
    * @method
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   clear = () => {
     this.ora.clear()
@@ -210,10 +213,10 @@ class Print extends Tools {
   }
 
   /**
-   * Force render spinner
+   * Force render spinner.
    *
    * @method
-   * @returns {Print} Return the instance itself, usefull for method chaining
+   * @returns {Print} Return the instance itself, usefull for method chaining.
    */
   render = () => {
     this.ora.render()
@@ -221,11 +224,11 @@ class Print extends Tools {
   }
 
   /**
-   * Print failed message, prefixed with a cross icon and exit
+   * Print failed message, prefixed with a cross icon and exit.
    *
    * @method
-   * @param {string} text - Text to use
-   * @param {...any} [args] - Any variable to interpolate text. If the last argument is an object, it will be used to override ora options
+   * @param {string} text Text to use.
+   * @param {...any} [args] Any variable to interpolate text. If the last argument is an object, it will be used to override ora options.
    */
   fatal = (text, ...args) => {
     if (text instanceof Error) {
@@ -239,11 +242,11 @@ class Print extends Tools {
   }
 
   /**
-   * Create a new print instance
+   * Create a new print instance.
    *
    * @method
-   * @param {TPrintOptions} [options] - Options object. If not provided, defaults to the current options
-   * @returns {Print} Return new print instance
+   * @param {TPrintOptions} [options] Options object. If not provided, defaults to the current options.
+   * @returns {Print} Return new print instance.
    */
   spinner = (options) => {
     const spin = new Print(this.plugin, options ?? this.options)

package/class/tools.js

@@ -1,9 +1,8 @@
 /**
- * Base tools class
+ * Tools class.
  *
  * @class
  */
-
 class Tools {
   constructor (plugin) {
     /**
@@ -20,7 +19,7 @@ class Tools {
   }
 
   /**
-   * Force bind methods to self (```this```)
+   * Force bind methods to self (```this```).
    *
    * @param {string[]} names - Method's names
    */
@@ -31,7 +30,7 @@ class Tools {
   }
 
   /**
-   * Dispose internal references
+   * Dispose internal references.
    */
   dispose = async () => {
     this.app = null