npm - bajo - Versions diffs - 1.2.8 → 2.0.0 - Mend

bajo 1.2.8 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (167) hide show

package/.jsdoc.conf.json +6 -3
package/README.md +8 -148
package/class/app.js +113 -0
package/{boot/class/bajo-core.js → class/bajo.js} +449 -37
package/{boot/class/error.js → class/base/err.js} +29 -3
package/class/base/log.js +205 -0
package/class/base/plugin.js +177 -0
package/class/base/print.js +272 -0
package/class/helper/bajo.js +344 -0
package/class/helper/plugin.js +169 -0
package/{boot/class/bajo-plugin.js → class/plugin.js} +60 -3
package/docs/App.html +3 -0
package/docs/Bajo.html +15 -0
package/docs/BasePlugin.html +5 -0
package/docs/Err.html +3 -0
package/docs/Log.html +3 -0
package/docs/Plugin.html +3 -0
package/docs/Print.html +3 -0
package/docs/bitcoin.jpeg +0 -0
package/docs/class_app.js.html +116 -0
package/docs/class_bajo.js.html +1100 -0
package/docs/class_base_err.js.html +99 -0
package/docs/class_base_log.js.html +208 -0
package/docs/class_base_plugin.js.html +180 -0
package/docs/class_base_print.js.html +275 -0
package/docs/class_helper_bajo.js.html +347 -0
package/docs/class_helper_plugin.js.html +172 -0
package/docs/class_plugin.js.html +121 -0
package/docs/data/search.json +1 -0
package/docs/fonts/Inconsolata-Regular.ttf +0 -0
package/docs/fonts/OpenSans-Regular.ttf +0 -0
package/docs/fonts/WorkSans-Bold.ttf +0 -0
package/docs/global.html +3 -0
package/docs/index.html +3 -0
package/docs/lib_create-method.js.html +42 -0
package/docs/lib_formats.js.html +68 -0
package/docs/lib_log-levels.js.html +28 -0
package/docs/lib_resolve-path.js.html +30 -0
package/docs/lib_shim.js.html +35 -0
package/docs/module-class_helper_bajo.html +3 -0
package/docs/module-class_helper_plugin.html +3 -0
package/docs/module-lib_create-method.html +3 -0
package/docs/module-lib_formats.html +3 -0
package/docs/module-lib_log-levels.html +3 -0
package/docs/module-lib_resolve-path.html +3 -0
package/docs/module-lib_shim.html +3 -0
package/docs/scripts/core.js +726 -0
package/docs/scripts/core.min.js +23 -0
package/docs/scripts/resize.js +90 -0
package/docs/scripts/search.js +265 -0
package/docs/scripts/search.min.js +6 -0
package/docs/scripts/third-party/Apache-License-2.0.txt +202 -0
package/docs/scripts/third-party/fuse.js +9 -0
package/docs/scripts/third-party/hljs-line-num-original.js +369 -0
package/docs/scripts/third-party/hljs-line-num.js +1 -0
package/docs/scripts/third-party/hljs-original.js +5171 -0
package/docs/scripts/third-party/hljs.js +1 -0
package/docs/scripts/third-party/popper.js +5 -0
package/docs/scripts/third-party/tippy.js +1 -0
package/docs/scripts/third-party/tocbot.js +672 -0
package/docs/scripts/third-party/tocbot.min.js +1 -0
package/docs/styles/clean-jsdoc-theme-base.css +1159 -0
package/docs/styles/clean-jsdoc-theme-dark.css +412 -0
package/docs/styles/clean-jsdoc-theme-light.css +482 -0
package/docs/styles/clean-jsdoc-theme-scrollbar.css +30 -0
package/docs/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
package/docs/styles/clean-jsdoc-theme.min.css +1 -0
package/docs/tutorial-contribution.html +3 -0
package/docs/tutorial-ecosystem.html +3 -0
package/docs/tutorial-getting-started.html +13 -0
package/docs/tutorial-plugin-dev.html +3 -0
package/docs/tutorial-user-guide.html +3 -0
package/lib/create-method.js +39 -0
package/{boot/lib → lib}/formats.js +28 -0
package/lib/log-levels.js +25 -0
package/{boot/lib → lib}/parse-args-argv.js +1 -1
package/{boot/lib → lib}/resolve-path.js +12 -0
package/{boot/lib → lib}/shim.js +10 -0
package/misc-docs/bitcoin.jpeg +0 -0
package/misc-docs/contribution.md +20 -0
package/{docs → misc-docs}/ecosystem.md +41 -12
package/misc-docs/getting-started.md +142 -0
package/misc-docs/plugin-dev.md +0 -0
package/misc-docs/toc.json +17 -0
package/misc-docs/user-guide.md +1 -0
package/package.json +14 -12
package/bajoBook/book/doc/.metadata.json +0 -28
package/bajoBook/book/doc/How-to-Make-a-Paper-Boat-564x400@2x.jpg +0 -0
package/bajoBook/book/doc/pages/guides/definition.md +0 -7
package/bajoBook/book/doc/pages/guides/intro.md +0 -3
package/bajoBook/book/doc/pages/guides/setup.md +0 -22
package/bajoBook/book/reference/.metadata.json +0 -152
package/bajoBook/book/reference/concept-leadership-business-with-paper-boats.jpg +0 -0
package/bajoBook/book/reference/pages/configuration/configuration-file.md +0 -52
package/bajoBook/book/reference/pages/helper/break-ns-path.md +0 -24
package/bajoBook/book/reference/pages/helper/build-collections.md +0 -19
package/bajoBook/book/reference/pages/helper/call-helper-or-handler.md +0 -35
package/bajoBook/book/reference/pages/helper/current-loc.md +0 -28
package/bajoBook/book/reference/pages/helper/dayjs.md +0 -13
package/bajoBook/book/reference/pages/helper/defaults-deep.md +0 -29
package/bajoBook/book/reference/pages/helper/dump.md +0 -32
package/bajoBook/book/reference/pages/helper/each-plugins.md +0 -24
package/bajoBook/book/reference/pages/helper/envs.md +0 -11
package/bajoBook/book/reference/pages/helper/error.md +0 -29
package/bajoBook/book/reference/pages/helper/fatal.md +0 -18
package/bajoBook/book/reference/pages/helper/freeze.md +0 -13
package/bajoBook/book/reference/pages/helper/generate-id.md +0 -36
package/bajoBook/book/reference/pages/helper/get-config.md +0 -27
package/bajoBook/book/reference/pages/helper/get-global-module-dir.md +0 -13
package/bajoBook/book/reference/pages/helper/get-helper.md +0 -13
package/bajoBook/book/reference/pages/helper/get-item-by-name.md +0 -13
package/bajoBook/book/reference/pages/helper/get-key-by-value.md +0 -13
package/bajoBook/book/reference/pages/helper/get-module-dir.md +0 -13
package/bajoBook/book/reference/pages/helper/get-plugin-data-dir.md +0 -13
package/bajoBook/book/reference/pages/helper/get-plugin-name.md +0 -13
package/bajoBook/book/reference/pages/helper/get-plugin.md +0 -13
package/bajoBook/book/reference/pages/helper/import-module.md +0 -13
package/bajoBook/book/reference/pages/helper/import-pkg.md +0 -13
package/bajoBook/book/reference/pages/helper/is-empty-dir.md +0 -13
package/bajoBook/book/reference/pages/helper/is-log-in-range.md +0 -13
package/bajoBook/book/reference/pages/helper/is-set.md +0 -13
package/bajoBook/book/reference/pages/helper/is-valid-app.md +0 -13
package/bajoBook/book/reference/pages/helper/is-valid-plugin.md +0 -13
package/bajoBook/book/reference/pages/helper/log-levels.md +0 -13
package/bajoBook/book/reference/pages/helper/log.md +0 -13
package/bajoBook/book/reference/pages/helper/paginate.md +0 -13
package/bajoBook/book/reference/pages/helper/pascal-case.md +0 -13
package/bajoBook/book/reference/pages/helper/print.md +0 -13
package/bajoBook/book/reference/pages/helper/read-config.md +0 -13
package/bajoBook/book/reference/pages/helper/read-json.md +0 -13
package/bajoBook/book/reference/pages/helper/resolve-path.md +0 -13
package/bajoBook/book/reference/pages/helper/resolve-tpl-path.md +0 -13
package/bajoBook/book/reference/pages/helper/run-hook.md +0 -13
package/bajoBook/book/reference/pages/helper/save-as-download.md +0 -13
package/bajoBook/book/reference/pages/helper/titleize.md +0 -13
package/bajoBook/book/reference/pages/helper/white-space.md +0 -13
package/boot/class/app.js +0 -67
package/boot/class/bajo-core/boot-order.js +0 -35
package/boot/class/bajo-core/boot-plugins.js +0 -17
package/boot/class/bajo-core/build-config.js +0 -85
package/boot/class/bajo-core/build-plugins.js +0 -44
package/boot/class/bajo-core/collect-config-handlers.js +0 -20
package/boot/class/bajo-core/exit-handler.js +0 -53
package/boot/class/bajo-core/run-as-applet.js +0 -26
package/boot/class/bajo-plugin/attach-method.js +0 -14
package/boot/class/bajo-plugin/build-config.js +0 -15
package/boot/class/bajo-plugin/check-clash.js +0 -18
package/boot/class/bajo-plugin/check-dependency.js +0 -39
package/boot/class/bajo-plugin/collect-hooks.js +0 -31
package/boot/class/bajo-plugin/run.js +0 -23
package/boot/class/log.js +0 -90
package/boot/class/plugin.js +0 -79
package/boot/class/print.js +0 -153
package/boot/lib/create-method.js +0 -33
package/boot/lib/log-levels.js +0 -1
package/test/method/isSet.js +0 -43
/package/{bajo → extend/bajo}/intl/en-US.json +0 -0
/package/{bajo → extend/bajo}/intl/id.json +0 -0
/package/{waibuStatic → extend/waibuStatic}/virtual.json +0 -0
/package/{boot/index.js → index.js} +0 -0
/package/{boot/lib → lib}/current-loc.js +0 -0
/package/{boot/lib → lib}/dayjs.js +0 -0
/package/{boot/lib → lib}/import-module.js +0 -0
/package/{boot/lib → lib}/omitted-plugin-keys.js +0 -0
/package/{boot/lib → lib}/parse-env.js +0 -0
/package/{boot/lib → lib}/read-all-configs.js +0 -0
/package/{docs/hook.md → misc-docs/.hook.md} +0 -0

package/docs/class_helper_bajo.js.html ADDED Viewed

@@ -0,0 +1,347 @@
+<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: class/helper/bajo.js</title><!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-class_helper_bajo.html">class/helper/bajo</a></div><div class="sidebar-section-children"><a href="module-class_helper_plugin.html">class/helper/plugin</a></div><div class="sidebar-section-children"><a href="module-lib_create-method.html">lib/create-method</a></div><div class="sidebar-section-children"><a href="module-lib_formats.html">lib/formats</a></div><div class="sidebar-section-children"><a href="module-lib_log-levels.html">lib/log-levels</a></div><div class="sidebar-section-children"><a href="module-lib_resolve-path.html">lib/resolve-path</a></div><div class="sidebar-section-children"><a href="module-lib_shim.html">lib/shim</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="BasePlugin.html">BasePlugin</a></div><div class="sidebar-section-children"><a href="Err.html">Err</a></div><div class="sidebar-section-children"><a href="Log.html">Log</a></div><div class="sidebar-section-children"><a href="Plugin.html">Plugin</a></div><div class="sidebar-section-children"><a href="Print.html">Print</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-contribution.html">Contribution</a></div><div class="sidebar-section-children"><a href="tutorial-ecosystem.html">Ecosystem</a></div><div class="sidebar-section-children"><a href="tutorial-getting-started.html">Getting Started</a></div><div class="sidebar-section-children"><a href="tutorial-plugin-dev.html">Plugin Development</a></div><div class="sidebar-section-children"><a href="tutorial-user-guide.html">User Guide</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#NsPathType">NsPathType</a></div><div class="sidebar-section-children"><a href="global.html#ObjectFormatType">ObjectFormatType</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo.app</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">class_helper_bajo.js</h1></header><article><pre class="prettyprint source lang-js"><code>import readAllConfigs from '../../lib/read-all-configs.js'
+import currentLoc from '../../lib/current-loc.js'
+import resolvePath from '../../lib/resolve-path.js'
+import omitDeep from 'omit-deep'
+import os from 'os'
+import fs from 'fs-extra'
+import lodash from 'lodash'
+import {
+  buildConfigs,
+  checkDependencies,
+  checkNameAliases,
+  attachMethods,
+  collectHooks,
+  run
+} from './plugin.js'
+const {
+  reduce,
+  isNaN,
+  forOwn,
+  orderBy,
+  isFunction,
+  isPlainObject,
+  map,
+  pick,
+  values,
+  keys,
+  set,
+  get,
+  isString,
+  filter,
+  trim,
+  without,
+  uniq,
+  camelCase,
+  isEmpty,
+  omit
+} = lodash
+const omitted = ['spawn', 'cwd', 'name', 'alias', 'applet', 'a', 'plugins']
+const defConfig = {
+  log: {
+    dateFormat: 'YYYY-MM-DDTHH:MM:ss.SSS[Z]',
+    plain: false,
+    applet: false,
+    traceHook: false
+  },
+  lang: Intl.DateTimeFormat().resolvedOptions().lang ?? 'en-US',
+  intl: {
+    supported: ['en-US', 'id'],
+    fallback: 'en-US',
+    lookupOrder: [],
+    format: {
+      emptyValue: '',
+      datetime: { dateStyle: 'medium', timeStyle: 'short' },
+      date: { dateStyle: 'medium' },
+      time: { timeStyle: 'short' },
+      float: { maximumFractionDigits: 2 },
+      double: { maximumFractionDigits: 5 },
+      smallint: {},
+      integer: {}
+    },
+    unitSys: {
+      'en-US': 'imperial',
+      id: 'metric'
+    }
+  },
+  exitHandler: true
+}
+/**
+ * @module
+ */
+/**
+ * Building bajo base config. Mostly dealing with directory setups:
+ * - determine base directory
+ * - check whether data directory is valid
+ * - ensure data config directory is there
+ *
+ * @async
+ */
+export async function buildBaseConfig () {
+  const { defaultsDeep } = this.lib.aneka
+  this.applet = this.app.argv._.applet
+  this.config = defaultsDeep({}, this.app.env._, this.app.argv._)
+  this.alias = this.name
+  set(this, 'dir.base', this.app.dir)
+  const path = currentLoc(import.meta).dir + '/../../..'
+  set(this, 'dir.pkg', this.resolvePath(path))
+  if (!get(this, 'dir.data')) set(this, 'dir.data', `${this.dir.base}/data`)
+  this.dir.data = this.resolvePath(this.dir.data)
+  if (!fs.existsSync(this.dir.data)) {
+    console.log('Data directory (%s) doesn\'t exist yet', this.dir.data)
+    process.exit(1)
+  }
+  fs.ensureDirSync(`${this.dir.data}/config`)
+  if (!this.dir.tmp) {
+    this.dir.tmp = `${this.resolvePath(os.tmpdir())}/${this.name}`
+    fs.ensureDirSync(this.dir.tmp)
+  }
+  this.app.addPlugin(this)
+}
+/**
+ * Building all plugins:
+ * - read the list of plugins from ```.plugins``` file
+ * - iterate through the list and build related plugins
+ * - attach these plugins to the app instance
+ *
+ * @async
+ */
+export async function buildPlugins () {
+  let pluginPkgs = this.config.plugins ?? []
+  if (isString(pluginPkgs)) pluginPkgs = [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)))
+  }
+  this.pluginPkgs = map(filter(without(uniq(pluginPkgs), this.mainNs), p => {
+    return p[0] !== '#'
+  }), p => {
+    return trim(p.split('#')[0])
+  })
+  this.pluginPkgs.push(this.mainNs)
+  for (const pkg of this.pluginPkgs) {
+    const ns = camelCase(pkg)
+    let dir
+    if (ns === 'main') {
+      dir = `${this.dir.base}/${this.mainNs}`
+      fs.ensureDirSync(dir)
+      fs.ensureDirSync(`${dir}/plugin`)
+    } else dir = this.getModuleDir(pkg)
+    let plugin
+    const factory = `${dir}/index.js`
+    if (fs.existsSync(factory)) {
+      const { default: builder } = await import(resolvePath(factory, true))
+      const FactoryClass = await builder.call(this, pkg)
+      plugin = new FactoryClass()
+      if (!(plugin instanceof this.lib.Plugin)) throw new Error(`Plugin package '${pkg}' should be an instance of BajoPlugin`)
+    } else {
+      plugin = new this.lib.Plugin(pkg, this.app)
+    }
+    this.pluginNames.push(plugin.name)
+    this.app.addPlugin(plugin)
+  }
+  this.config = omit(this.config, this.pluginNames)
+}
+/**
+ * Collect all config handlers, including the one provided by plugins
+ *
+ * @async
+ */
+export async function collectConfigHandlers () {
+  for (const pkg of this.pluginPkgs) {
+    let dir
+    try {
+      dir = this.getModuleDir(pkg)
+    } catch (err) {}
+    if (!dir) continue
+    const file = `${dir}/extend/bajo/config-handlers.js`
+    let mod = await this.importModule(file)
+    if (!mod) continue
+    if (isFunction(mod)) mod = await mod.call(this.app[camelCase(pkg)])
+    if (isPlainObject(mod)) mod = [mod]
+    this.configHandlers = this.configHandlers.concat(mod)
+  }
+}
+/**
+ * Bajo extra config:
+ * - reading config file
+ * - merge config with arguments &amp; environments values
+ * - Set environment (```dev``` or ```prod```)
+ *
+ * @async
+ */
+export async function buildExtConfig () {
+  // config merging
+  const { defaultsDeep } = this.lib.aneka
+  let resp = await readAllConfigs.call(this.app, `${this.dir.data}/config/${this.name}`)
+  resp = omitDeep(pick(resp, ['log', 'exitHandler', 'env']), omitted)
+  this.config = defaultsDeep({}, this.config, resp, defConfig)
+  this.config.env = (this.config.env ?? 'dev').toLowerCase()
+  if (values(this.envs).includes(this.config.env)) this.config.env = this.lib.aneka.getKeyByValue(this.envs, this.config.env)
+  if (!keys(this.envs).includes(this.config.env)) throw new Error(`Unknown environment '${this.config.env}'. Supported: ${this.join(keys(this.envs))}`)
+  process.env.NODE_ENV = this.envs[this.config.env]
+  if (!this.config.log.level) this.config.log.level = this.config.env === 'dev' ? 'debug' : 'info'
+  if (this.config.silent) this.config.log.level = 'silent'
+  if (this.applet) {
+    if (!this.pluginPkgs.includes('bajo-cli')) throw new Error('Applet needs to have \'bajo-cli\' loaded first')
+    if (!this.config.log.applet) this.config.log.level = 'silent'
+    this.config.exitHandler = false
+  }
+  const exts = map(this.configHandlers, 'ext')
+  this.initPrint()
+  this.initLog()
+  this.log.debug('configHandlers%s', this.join(exts))
+  this.config = this.parseObject(this.config, { parseValue: true })
+}
+/**
+ * Setup plugins boot orders by reading plugin's ```.bootorder``` file if provided.
+ *
+ * @async
+ */
+export async function bootOrder () {
+  this.log.debug('setupBootOrder')
+  const order = reduce(this.pluginPkgs, (o, k, i) => {
+    const key = map(k.split(':'), m => trim(m))
+    if (key[1] &amp;&amp; !isNaN(Number(key[1]))) o[key[0]] = Number(key[1])
+    else o[key[0]] = 10000 + i
+    return o
+  }, {})
+  const norder = {}
+  for (let n of this.pluginPkgs) {
+    n = map(n.split(':'), m => trim(m))[0]
+    const dir = n === this.mainNs ? (`${this.dir.base}/${this.mainNs}`) : this.getModuleDir(n)
+    if (n !== this.mainNs &amp;&amp; !fs.existsSync(dir)) throw this.error('packageNotFoundOrNotBajo%s', n)
+    norder[n] = NaN
+    try {
+      norder[n] = Number(trim(await fs.readFile(`${dir}/.bootorder`, 'utf8')))
+    } catch (err) {}
+  }
+  const result = []
+  forOwn(order, (v, k) => {
+    const item = { k, v: isNaN(norder[k]) ? v : norder[k] }
+    result.push(item)
+  })
+  this.pluginPkgs = map(orderBy(result, ['v']), 'k')
+  this.log.info('runInEnv%s', this.print.write(this.envs[this.config.env]))
+  // misc
+  this.freeze(this.config)
+}
+/**
+ * Iterate through all plugins loaded and do:
+ * 1. {@link module:class/helper/bajo-plugin.buildConfigs|build configs}
+ * 2. {@link module:class/helper/bajo-plugin.checkNameAliases|ensure names &amp; aliases uniqueness}
+ * 3. {@link module:class/helper/bajo-plugin.checkDependencies|ensure dependencies are met}
+ * 4. {@link module:class/helper/bajo-plugin.attachMethods|build and attach dynamic methods}
+ * 5. {@link module:class/helper/bajo-plugin.collectHooks|collect hooks}
+ * 6. {@link module:class/helper/bajo-plugin.run|run plugins}
+ *
+ * @async
+ */
+export async function bootPlugins () {
+  await buildConfigs.call(this.app)
+  await checkNameAliases.call(this.app)
+  await checkDependencies.call(this.app)
+  await attachMethods.call(this.app)
+  await collectHooks.call(this.app)
+  await run.call(this.app)
+}
+/**
+ * Attach plugins exit handlers and make sure the app shutdowns gracefully
+ *
+ * @async
+ */
+export async function exitHandler () {
+  if (!this.config.exitHandler) return
+  async function exit (signal) {
+    const { eachPlugins } = this
+    this.log.warn('signalReceived%s', signal)
+    await eachPlugins(async function () {
+      try {
+        await this.stop()
+      } catch (err) {}
+      this.log.trace('exited')
+    })
+    this.log.debug('appShutdown')
+    process.exit(0)
+  }
+  process.on('SIGINT', async () => {
+    await exit.call(this, 'SIGINT')
+  })
+  process.on('SIGTERM', async () => {
+    await exit.call(this, 'SIGTERM')
+  })
+  process.on('uncaughtException', (error, origin) => {
+    setTimeout(() => {
+      console.error(error)
+      // process.exit(1)
+    }, 50)
+  })
+  process.on('unhandledRejection', (reason, promise) => {
+    const stackFile = reason.stack.split('\n')[1]
+    let file
+    const info = stackFile.match(/\((.*)\)/) // file is in (&lt;file>)
+    if (info) file = info[1]
+    else if (stackFile.startsWith('    at ')) file = stackFile.slice(7) // file is stackFile itself
+    if (!file) return
+    const parts = file.split(':')
+    const column = parseInt(parts[parts.length - 1])
+    const line = parseInt(parts[parts.length - 2])
+    parts.pop()
+    parts.pop()
+    file = parts.join(':')
+    this.log.error({ file, line, column }, '%s', reason.message)
+  })
+  process.on('warning', warning => {
+    this.log.error('%s', warning.message)
+  })
+}
+/**
+ * If app is in ```applet``` mode, this little helper should take care plugin's applet boot process
+ *
+ * @async
+ */
+export async function runAsApplet () {
+  const { isString, map, find } = this.lib._
+  await this.eachPlugins(async function ({ file }) {
+    const { name: ns, alias } = this
+    this.app.bajo.applets.push({ ns, file, alias })
+  }, { glob: 'applet.js', prefix: 'bajoCli' })
+  this.log.debug('appletModeActivated')
+  this.print.info('appRunningAsApplet')
+  if (this.applets.length === 0) this.print.fatal('noAppletLoaded')
+  let name = this.applet
+  if (!isString(this.applet)) {
+    const select = await this.importPkg('bajoCli:@inquirer/select')
+    name = await select({
+      message: this.print.write('Please select:'),
+      choices: map(this.applets, t => ({ value: t.ns }))
+    })
+  }
+  const [ns, path] = name.split(':')
+  const applet = find(this.applets, a => (a.ns === ns || a.alias === ns))
+  if (!applet) this.print.fatal('notFound%s%s', this.print.write('applet'), name)
+  await this.runHook(`${this.app[applet.ns]}:beforeAppletRun`)
+  await this.app.bajoCli.runApplet(applet, path, ...this.app.args)
+  await this.runHook(`${this.app[applet.ns]}:afterAppletRun`)
+}
+</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo.app</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-class_helper_bajo.html">class/helper/bajo</a></div><div class="sidebar-section-children"><a href="module-class_helper_plugin.html">class/helper/plugin</a></div><div class="sidebar-section-children"><a href="module-lib_create-method.html">lib/create-method</a></div><div class="sidebar-section-children"><a href="module-lib_formats.html">lib/formats</a></div><div class="sidebar-section-children"><a href="module-lib_log-levels.html">lib/log-levels</a></div><div class="sidebar-section-children"><a href="module-lib_resolve-path.html">lib/resolve-path</a></div><div class="sidebar-section-children"><a href="module-lib_shim.html">lib/shim</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="BasePlugin.html">BasePlugin</a></div><div class="sidebar-section-children"><a href="Err.html">Err</a></div><div class="sidebar-section-children"><a href="Log.html">Log</a></div><div class="sidebar-section-children"><a href="Plugin.html">Plugin</a></div><div class="sidebar-section-children"><a href="Print.html">Print</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-contribution.html">Contribution</a></div><div class="sidebar-section-children"><a href="tutorial-ecosystem.html">Ecosystem</a></div><div class="sidebar-section-children"><a href="tutorial-getting-started.html">Getting Started</a></div><div class="sidebar-section-children"><a href="tutorial-plugin-dev.html">Plugin Development</a></div><div class="sidebar-section-children"><a href="tutorial-user-guide.html">User Guide</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#NsPathType">NsPathType</a></div><div class="sidebar-section-children"><a href="global.html#ObjectFormatType">ObjectFormatType</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>

package/docs/class_helper_plugin.js.html ADDED Viewed

@@ -0,0 +1,172 @@
+<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Source: class/helper/plugin.js</title><!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="light"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-class_helper_bajo.html">class/helper/bajo</a></div><div class="sidebar-section-children"><a href="module-class_helper_plugin.html">class/helper/plugin</a></div><div class="sidebar-section-children"><a href="module-lib_create-method.html">lib/create-method</a></div><div class="sidebar-section-children"><a href="module-lib_formats.html">lib/formats</a></div><div class="sidebar-section-children"><a href="module-lib_log-levels.html">lib/log-levels</a></div><div class="sidebar-section-children"><a href="module-lib_resolve-path.html">lib/resolve-path</a></div><div class="sidebar-section-children"><a href="module-lib_shim.html">lib/shim</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="BasePlugin.html">BasePlugin</a></div><div class="sidebar-section-children"><a href="Err.html">Err</a></div><div class="sidebar-section-children"><a href="Log.html">Log</a></div><div class="sidebar-section-children"><a href="Plugin.html">Plugin</a></div><div class="sidebar-section-children"><a href="Print.html">Print</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-contribution.html">Contribution</a></div><div class="sidebar-section-children"><a href="tutorial-ecosystem.html">Ecosystem</a></div><div class="sidebar-section-children"><a href="tutorial-getting-started.html">Getting Started</a></div><div class="sidebar-section-children"><a href="tutorial-plugin-dev.html">Plugin Development</a></div><div class="sidebar-section-children"><a href="tutorial-user-guide.html">User Guide</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#NsPathType">NsPathType</a></div><div class="sidebar-section-children"><a href="global.html#ObjectFormatType">ObjectFormatType</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo.app</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section id="source-page" class="source-page"><header><h1 id="title" class="has-anchor">class_helper_plugin.js</h1></header><article><pre class="prettyprint source lang-js"><code>import createMethod from '../../lib/create-method.js'
+import semver from 'semver'
+import lodash from 'lodash'
+const {
+  merge,
+  forOwn,
+  groupBy,
+  find,
+  reduce,
+  map,
+  trim,
+  keys,
+  intersection,
+  each,
+  camelCase,
+  get
+} = lodash
+/**
+ * @module
+ */
+/**
+ * Scan plugins ```method``` directories, and turn + attach its found files as methods dynamically.
+ *
+ * @async
+ */
+export async function attachMethods () {
+  const { eachPlugins } = this.bajo
+  const me = this // the app
+  me.bajo.log.debug('attachMethods')
+  await eachPlugins(async function () {
+    const { name: ns, pkgName } = this
+    const dir = ns === me.bajo.mainNs ? (`${me.bajo.dir.base}/${me.bajo.mainNs}`) : me.bajo.getModuleDir(pkgName)
+    const num = await createMethod.call(me[ns], `${dir}/method`, pkgName)
+    me.bajo.log.trace('- %s (%d)', ns, num)
+  })
+}
+/**
+ * Build configurations
+ *
+ * @async
+ */
+export async function buildConfigs () {
+  this.bajo.log.debug('readConfigs')
+  for (const pkg of this.bajo.pluginPkgs) {
+    const plugin = this[camelCase(pkg)]
+    await plugin.loadConfig()
+    plugin.initPrint()
+    plugin.initLog()
+  }
+}
+/**
+ * Ensure for names and aliases to be unique and no clashes with other plugins
+ *
+ * @async
+ */
+export async function checkNameAliases () {
+  const { eachPlugins } = this.bajo
+  this.bajo.log.debug('checkAliasNameClash')
+  const refs = []
+  await eachPlugins(async function () {
+    const { name: ns, pkgName, alias } = this
+    let item = find(refs, { ns })
+    if (item) throw this.error('pluginNameClash%s%s%s%s', ns, pkgName, item.ns, item.pkgName, { code: 'BAJO_NAME_CLASH' })
+    item = find(refs, { alias })
+    if (item) throw this.error('pluginNameClash%s%s%s%s', alias, pkgName, item.alias, item.pkgName, { code: 'BAJO_ALIAS_CLASH' })
+    refs.push({ ns, alias, pkgName })
+  })
+}
+/**
+ * Ensure dependencies are met
+ *
+ * @async
+ */
+export async function checkDependencies () {
+  async function runner () {
+    const { name: ns, pkgName } = this
+    const { join } = this.app.bajo
+    this.app.bajo.log.trace('- %s', ns)
+    const odep = reduce(this.dependencies, (o, k) => {
+      const item = map(k.split('@'), m => trim(m))
+      if (k[0] === '@') o['@' + item[1]] = item[2]
+      else o[item[0]] = item[1]
+      return o
+    }, {})
+    const deps = keys(odep)
+    if (deps.length > 0) {
+      if (intersection(this.app.bajo.pluginPkgs, deps).length !== deps.length) {
+        throw this.error('dependencyUnfulfilled%s%s', pkgName, join(deps), { code: 'BAJO_DEPENDENCY' })
+      }
+      each(deps, d => {
+        if (!odep[d]) return
+        const ver = get(this.app[camelCase(d)], 'config.pkg.version')
+        if (!ver) return
+        if (!semver.satisfies(ver, odep[d])) {
+          throw this.error('semverCheckFailed%s%s', pkgName, `${d}@${odep[d]}`, { code: 'BAJO_DEPENDENCY_SEMVER' })
+        }
+      })
+    }
+  }
+  const { eachPlugins } = this.bajo
+  this.bajo.log.debug('checkDeps')
+  await eachPlugins(async function () {
+    await runner.call(this)
+  })
+}
+/**
+ * Collect and build hooks and push them to the bajo's hook system
+ *
+ * @async
+ */
+export async function collectHooks () {
+  const { eachPlugins, runHook, isLogInRange, importModule, breakNsPathFromFile } = this.bajo
+  const me = this
+  me.bajo.hooks = this.bajo.hooks ?? []
+  me.bajo.log.debug('collectHooks')
+  // collects
+  await eachPlugins(async function ({ dir, file }) {
+    const { name: ns } = this
+    const { fullNs, path } = breakNsPathFromFile({ file, dir, baseNs: ns, suffix: '/hook/' })
+    const mod = await importModule(file, { asHandler: true })
+    if (!mod) return undefined
+    merge(mod, { ns: fullNs, path, src: ns })
+    me.bajo.hooks.push(mod)
+  }, { glob: 'hook/**/*.js', prefix: me.bajo.name })
+  // for log trace purpose only
+  if (!isLogInRange('trace')) return
+  const items = groupBy(me.bajo.hooks, 'ns')
+  forOwn(items, (v, k) => {
+    const hooks = groupBy(v, 'path')
+    forOwn(hooks, (v1, k1) => {
+      me.bajo.log.trace('- %s:%s (%d)', k, k1, v1.length)
+    })
+  })
+  // run handler
+  await runHook('bajo:afterCollectHooks')
+}
+/**
+ * Finally, run all plugins
+ *
+ * @async
+ */
+export async function run () {
+  const me = this
+  const { runHook, eachPlugins, join } = me.bajo
+  const { freeze } = me.bajo
+  const methods = ['init']
+  if (!me.bajo.applet) methods.push('start')
+  for (const method of methods) {
+    await runHook(`bajo:${camelCase(`before ${method} all plugins`)}`)
+    await eachPlugins(async function () {
+      const { name: ns } = this
+      if (method === 'start') freeze(me[ns].config)
+      await runHook(`${ns}:${camelCase(`before ${method}`)}`)
+      await me[ns][method]()
+      await runHook(`${ns}:${camelCase(`after ${method}`)}`)
+    })
+    await runHook(`bajo:${camelCase(`after ${method} all plugins`)}`)
+  }
+  me.bajo.log.debug('loadedPlugins%s', join(map(me.bajo.pluginPkgs, b => camelCase(b))))
+}
+</code></pre></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">Bajo Framework</a><div class="mobile-nav-links"><div class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo.app</a></div><div class="navbar-item"><a id="" href="https://www.npmjs.com/package/bajo" target="">NPM</a></div><div class="navbar-item"><a id="" href="https://github.com/ardhi/bajo" target="">Github</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-modules"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-class_helper_bajo.html">class/helper/bajo</a></div><div class="sidebar-section-children"><a href="module-class_helper_plugin.html">class/helper/plugin</a></div><div class="sidebar-section-children"><a href="module-lib_create-method.html">lib/create-method</a></div><div class="sidebar-section-children"><a href="module-lib_formats.html">lib/formats</a></div><div class="sidebar-section-children"><a href="module-lib_log-levels.html">lib/log-levels</a></div><div class="sidebar-section-children"><a href="module-lib_resolve-path.html">lib/resolve-path</a></div><div class="sidebar-section-children"><a href="module-lib_shim.html">lib/shim</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="App.html">App</a></div><div class="sidebar-section-children"><a href="Bajo.html">Bajo</a></div><div class="sidebar-section-children"><a href="BasePlugin.html">BasePlugin</a></div><div class="sidebar-section-children"><a href="Err.html">Err</a></div><div class="sidebar-section-children"><a href="Log.html">Log</a></div><div class="sidebar-section-children"><a href="Plugin.html">Plugin</a></div><div class="sidebar-section-children"><a href="Print.html">Print</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-tutorials"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-contribution.html">Contribution</a></div><div class="sidebar-section-children"><a href="tutorial-ecosystem.html">Ecosystem</a></div><div class="sidebar-section-children"><a href="tutorial-getting-started.html">Getting Started</a></div><div class="sidebar-section-children"><a href="tutorial-plugin-dev.html">Plugin Development</a></div><div class="sidebar-section-children"><a href="tutorial-user-guide.html">User Guide</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#NsPathType">NsPathType</a></div><div class="sidebar-section-children"><a href="global.html#ObjectFormatType">ObjectFormatType</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#dark-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>