bajo 2.1.0 → 2.2.0

package/class/plugin.js

@@ -1,5 +1,5 @@
 import lodash from 'lodash'
-import Err from './misc/err.js'
+import Err from './plugin/err.js'
 
 const { get, isEmpty, cloneDeep, omit, isPlainObject, camelCase } = lodash
 
@@ -14,39 +14,36 @@ const { get, isEmpty, cloneDeep, omit, isPlainObject, camelCase } = lodash
  * @class
  */
 class Plugin {
-  /**
-   * Package name, the one from package.json
-   *
-   * @memberof Plugin
-   * @constant {string}
-   */
-  static pkgName
-
-  /**
-   * Namespace (ns) or plugin's name. Simply the camel cased version of plugin's package name
-   *
-   * @memberof Plugin
-   * @constant {string}
-   */
-  static ns
-
-  /**
-   * 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)
-   *
-   * @readonly
-   * @memberof Plugin
-   * @type {string}
-   */
-  static alias = ''
-
   /**
    * @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) {
-    this.constructor.pkgName = pkgName
-    this.constructor.ns = camelCase(pkgName)
+    /**
+     * Package name, the one from package.json
+     *
+     * @memberof Plugin
+     * @constant {string}
+     */
+    this.pkgName = pkgName
+
+    /**
+     * Namespace (ns) or plugin's name. Simply the camel cased version of plugin's package name
+     *
+     * @memberof Plugin
+     * @constant {string}
+     */
+    this.ns = camelCase(pkgName)
+
+    /**
+     * 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)
+     *
+     * @readonly
+     * @memberof Plugin
+     * @type {string}
+     */
+    this.alias = null
 
     /**
      * Reference to app instance
@@ -79,6 +76,21 @@ class Plugin {
     }
   }
 
+  /**
+   * 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.
+   */
+  getPkgInfo = (dir, keys = ['name', 'version', 'description', 'author', 'license', 'homepage', 'bajo']) => {
+    const { pick, isEmpty } = this.app.lib._
+    const { fs } = this.app.lib
+    const file = `${dir ?? this.dir.pkg}/package.json`
+    const pkg = fs.readJsonSync(file)
+    return isEmpty(keys) ? pkg : pick(pkg, keys)
+  }
+
   /**
    * Get plugin's config value
    *
@@ -127,43 +139,35 @@ class Plugin {
   }
 
   /**
-   * Getter for plugin's package name
+   * Translate text and interpolate with given ```args```.
    *
-   * @type {string}
-   */
-  get pkgName () {
-    return this.constructor.pkgName
-  }
-
-  /**
-   * Getter for plugin's ns
+   * Shortcut to {@link App#t} with ns parameter set to this plugin namespace.
    *
-   * @type {string}
+   * @param {string} text - Text to translate
+   * @param  {...any} params - Variables to interpolate to ```text```
+   * @returns {string}
    */
-  get ns () {
-    return this.constructor.ns
+  t = (text, ...params) => {
+    return this.app.t(this.ns, text, ...params)
   }
 
   /**
-   * Getter for plugin's alias
+   * Force bind methods to self (```this```)
    *
-   * @type {string}
+   * @param {string[]} names - Method's names
    */
-  get alias () {
-    return this.constructor.alias
+  selfBind (names) {
+    for (const name of names) {
+      this[name] = this[name].bind(this)
+    }
   }
 
   /**
-   * Translate text and interpolate with given ```args```.
-   *
-   * 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```
-   * @returns {string}
+   * Dispose internal references
    */
-  t = (text, ...params) => {
-    return this.app.t(this.ns, text, ...params)
+  dispose = () => {
+    this.app = null
+    this.config = null
   }
 }