bajo 2.0.1 → 2.1.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 (101) hide show
  1. package/.github/FUNDING.yml +13 -0
  2. package/.github/workflows/repo-lockdown.yml +24 -0
  3. package/.jsdoc.conf.json +7 -6
  4. package/LICENSE +1 -1
  5. package/README.md +50 -18
  6. package/class/app.js +378 -54
  7. package/class/bajo.js +228 -149
  8. package/class/base.js +106 -0
  9. package/class/helper/bajo.js +146 -90
  10. package/class/helper/{plugin.js → base.js} +96 -22
  11. package/class/{base → misc}/err.js +44 -14
  12. package/class/misc/log.js +255 -0
  13. package/class/misc/print.js +264 -0
  14. package/class/plugin.js +120 -68
  15. package/docs/App.html +23 -1
  16. package/docs/Bajo.html +2 -9
  17. package/docs/Base.html +3 -0
  18. package/docs/Err.html +3 -1
  19. package/docs/Log.html +5 -1
  20. package/docs/Plugin.html +1 -1
  21. package/docs/Print.html +1 -1
  22. package/docs/class_app.js.html +378 -56
  23. package/docs/class_bajo.js.html +230 -151
  24. package/docs/class_base.js.html +109 -0
  25. package/docs/class_helper_bajo.js.html +138 -87
  26. package/docs/class_helper_base.js.html +246 -0
  27. package/docs/class_misc_err.js.html +129 -0
  28. package/docs/class_misc_log.js.html +210 -0
  29. package/docs/class_misc_print.js.html +267 -0
  30. package/docs/class_plugin.js.html +122 -70
  31. package/docs/data/search.json +1 -1
  32. package/docs/global.html +4 -1
  33. package/docs/index.html +2 -2
  34. package/docs/index.js.html +35 -0
  35. package/docs/lib_current-loc.js.html +36 -0
  36. package/docs/lib_formats.js.html +8 -8
  37. package/docs/lib_import-module.js.html +59 -0
  38. package/docs/lib_log-levels.js.html +17 -7
  39. package/docs/lib_parse-args-argv.js.html +83 -0
  40. package/docs/lib_parse-env.js.html +53 -0
  41. package/docs/lib_resolve-path.js.html +3 -6
  42. package/docs/lib_shim.js.html +8 -3
  43. package/docs/module-Helper_Bajo.html +3 -0
  44. package/docs/module-Helper_Base.html +3 -0
  45. package/docs/module-Lib.html +15 -0
  46. package/docs/static/home.md +32 -0
  47. package/docs/static/logo-ecosystem.png +0 -0
  48. package/docs/static/logo.png +0 -0
  49. package/extend/bajo/intl/en-US.json +9 -2
  50. package/extend/bajo/intl/id.json +9 -2
  51. package/index.js +22 -2
  52. package/lib/current-loc.js +24 -2
  53. package/lib/formats.js +6 -6
  54. package/lib/import-module.js +29 -0
  55. package/lib/log-levels.js +15 -5
  56. package/lib/parse-args-argv.js +20 -12
  57. package/lib/parse-env.js +18 -7
  58. package/lib/resolve-path.js +1 -4
  59. package/lib/shim.js +6 -1
  60. package/package.json +4 -7
  61. package/wiki/CONFIG.md +36 -0
  62. package/wiki/CONTRIBUTING.md +5 -0
  63. package/wiki/DEV_GUIDE.md +3 -0
  64. package/wiki/ECOSYSTEM.md +93 -0
  65. package/wiki/GETTING-STARTED.md +356 -0
  66. package/wiki/USER-GUIDE.md +256 -0
  67. package/class/base/log.js +0 -205
  68. package/class/base/plugin.js +0 -168
  69. package/class/base/print.js +0 -272
  70. package/docs/BasePlugin.html +0 -5
  71. package/docs/class_base_err.js.html +0 -99
  72. package/docs/class_base_log.js.html +0 -208
  73. package/docs/class_base_plugin.js.html +0 -180
  74. package/docs/class_base_print.js.html +0 -275
  75. package/docs/class_helper_plugin.js.html +0 -172
  76. package/docs/lib_create-method.js.html +0 -42
  77. package/docs/module-class_helper_bajo.html +0 -3
  78. package/docs/module-class_helper_plugin.html +0 -3
  79. package/docs/module-lib_create-method.html +0 -3
  80. package/docs/module-lib_formats.html +0 -3
  81. package/docs/module-lib_log-levels.html +0 -3
  82. package/docs/module-lib_resolve-path.html +0 -3
  83. package/docs/module-lib_shim.html +0 -3
  84. package/docs/tutorial-contribution.html +0 -3
  85. package/docs/tutorial-ecosystem.html +0 -3
  86. package/docs/tutorial-getting-started.html +0 -13
  87. package/docs/tutorial-plugin-dev.html +0 -3
  88. package/docs/tutorial-user-guide.html +0 -3
  89. package/lib/create-method.js +0 -39
  90. package/lib/dayjs.js +0 -8
  91. package/lib/omitted-plugin-keys.js +0 -3
  92. package/lib/read-all-configs.js +0 -19
  93. package/misc-docs/.hook.md +0 -11
  94. package/misc-docs/bitcoin.jpeg +0 -0
  95. package/misc-docs/contribution.md +0 -20
  96. package/misc-docs/ecosystem.md +0 -94
  97. package/misc-docs/getting-started.md +0 -142
  98. package/misc-docs/plugin-dev.md +0 -0
  99. package/misc-docs/toc.json +0 -17
  100. package/misc-docs/user-guide.md +0 -1
  101. /package/docs/{bitcoin.jpeg → static/bitcoin.jpeg} +0 -0
package/docs/module-Lib.html ADDED
@@ -0,0 +1,15 @@
1
+ <!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>Module: Lib</title><!--[if lt IE 9]>
2
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
+ <![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 API</a><div class="sidebar-items-container"><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="Base.html">Base</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-events"><div>Events</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#event:bajo:afterAll%257Bmethod%257D">bajo:afterAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBootComplete">bajo:afterBootComplete</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBuildCollection">bajo:afterBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterCollectHooks">bajo:afterCollectHooks</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeAll%257Bmethod%257D">bajo:beforeAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeBuildCollection">bajo:beforeBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:afterAppletRun">{ns}:afterAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:after%257Bmethod%257D">{ns}:after{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:beforeAppletRun">{ns}:beforeAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:before%257Bmethod%257D">{ns}:before{method}</a></div></div><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-Helper_Bajo.html">Helper/Bajo</a></div><div class="sidebar-section-children"><a href="module-Helper_Base.html">Helper/Base</a></div><div class="sidebar-section-children"><a href="module-Lib.html">Lib</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#TAppConfigHandler">TAppConfigHandler</a></div><div class="sidebar-section-children"><a href="global.html#TAppEnv">TAppEnv</a></div><div class="sidebar-section-children"><a href="global.html#TAppLib">TAppLib</a></div><div class="sidebar-section-children"><a href="global.html#TBajoDataType">TBajoDataType</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatResult">TBajoFormatResult</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatType">TBajoFormatType</a></div><div class="sidebar-section-children"><a href="global.html#TLogJson">TLogJson</a></div><div class="sidebar-section-children"><a href="global.html#TLogLevels">TLogLevels</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathPairs">TNsPathPairs</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathResult">TNsPathResult</a></div><div class="sidebar-section-children"><a href="global.html#TPrintOptions">TPrintOptions</a></div><div class="sidebar-section-children"><a href="global.html#boot">boot</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://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 class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo</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><header></header><article><div class="container-overview"><div class="description"><p>External helpers you can use by importing its file directly</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_shim.js.html">lib/shim.js</a>, <a href="lib_shim.js.html#line1">line 1</a></li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id=".currentLoc"><span class="type-signature">(static) </span>currentLoc<span class="signature">(metaImport)</span><span class="type-signature"> &rarr; {Object}</span></h3><div class="description"><p>Get current directory &amp; file. An attempt to brings back the old <code>__dirname</code> and <code>__filename</code> to the ES6 era.</p><p>Returns object with the following keys:</p><ul><li><code>__dirname</code> (aliases to <code>dir</code>) - current directory name</li><li><code>__filename</code> (aliases to <code>file</code>) - current file path</li></ul><p>Example:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
4
+ const currentLoc = await importModule('bajo:/lib/current-loc.js')
5
+
6
+ const { __dirname, __filename } = currentLoc(import.meta)
7
+ console.log(__dirname, __filename)
8
+ </code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>metaImport</code></td><td class="type"><span class="param-type">Object</span></td><td class="description last"><p><code>import.meta</code> object</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_current-loc.js.html">lib/current-loc.js</a>, <a href="lib_current-loc.js.html#line27">line 27</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id=".importModule"><span class="type-signature">(async, static) </span>importModule<span class="signature">(file, options<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {any}</span></h3><div class="description"><p>Import file/module from any loaded plugins</p><p>Example: your plugin structure looks like this</p><pre class="prettyprint source"><code>|- src
9
+ | |- lib
10
+ | | |- my-module.js
11
+ |- index.js
12
+ |- package.json
13
+ </code></pre><p>And now this is how to import <code>my-module.js</code>:</p><pre class="prettyprint source lang-javascript"><code>const { importModule } = this.app.bajo
14
+ const myModule = await importModule('myPlugin:/src/lib/my-module.js')
15
+ </code></pre></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>file</code></td><td class="type"><span class="param-type"><a href="global.html#TNsPathPairs">TNsPathPairs</a></span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>File to import</p></td></tr><tr><td class="name"><code>options</code></td><td class="type"><span class="param-type">Object</span></td><td class="attributes">&lt;optional><br></td><td class="default">{}</td><td class="description last"><p>Options</p><h6>Properties</h6><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>asDefaultImport</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="default">true</td><td class="description last"><p>If <code>true</code> (default), return default imported module</p></td></tr><tr><td class="name"><code>asHandler</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="default"></td><td class="description last"><p>If <code>true</code>, return as a handler</p></td></tr><tr><td class="name"><code>noCache</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="default"></td><td class="description last"><p>If <code>true</code>, always import as a fresh copy</p></td></tr></tbody></table></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_import-module.js.html">lib/import-module.js</a>, <a href="lib_import-module.js.html#line35">line 35</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="Bajo.html#importModule">Bajo#importModule</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">any</span></dd></dl></div><h3 class="name has-anchor" id=".parseArgsArgv"><span class="type-signature">(async, static) </span>parseArgsArgv<span class="signature">(useParser<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {Object}</span></h3><div class="description"><p>Parse program arguments (args) &amp; options (argv). See <a href="App.html#args">args</a> &amp; <a href="App.html#argv">argv</a> for examples</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>useParser</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="description last"><p>If <code>true</code>, skip <a href="https://github.com/yargs/yargs">yargs</a></p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_parse-args-argv.js.html">lib/parse-args-argv.js</a>, <a href="lib_parse-args-argv.js.html#line60">line 60</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="App.html#args">App#args</a></li><li><a href="App.html#argv">App#argv</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>An object containing <code>args</code> and <code>argv</code></p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id=".parseEnv"><span class="type-signature">(static) </span>parseEnv<span class="signature">()</span><span class="type-signature"> &rarr; {Object}</span></h3><div class="description"><p>Parse environment variables. See <a href="App.html#envVars">envVars</a> for examples</p></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_parse-env.js.html">lib/parse-env.js</a>, <a href="lib_parse-env.js.html#line29">line 29</a></li></ul></dd></div><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li><a href="App.html#envVars">App#envVars</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">Object</span></dd></dl></div><h3 class="name has-anchor" id=".resolvePath"><span class="type-signature">(static) </span>resolvePath<span class="signature">(file, asFileUrl<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {string}</span></h3><div class="description"><p>Resolve file name to filesystem's path. Windows path separator <code>\</code> is normalized to Unix's <code>/</code></p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th>Attributes</th><th>Default</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>file</code></td><td class="type"><span class="param-type">string</span></td><td class="attributes"></td><td class="default"></td><td class="description last"><p>File to resolve</p></td></tr><tr><td class="name"><code>asFileUrl</code></td><td class="type"><span class="param-type">boolean</span></td><td class="attributes">&lt;optional><br></td><td class="default">false</td><td class="description last"><p>Return as file URL format <code>file:///&lt;name&gt;</code></p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_resolve-path.js.html">lib/resolve-path.js</a>, <a href="lib_resolve-path.js.html#line14">line 14</a></li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">string</span></dd></dl></div><h3 class="name has-anchor" id=".shim"><span class="type-signature">(static) </span>shim<span class="signature">()</span></h3><div class="description"><p>Function to attach some of the methods needed but probably not provided by your node installation:</p><ul><li><code>String.prototype.replaceAll</code></li><li><code>String.prototype.splice</code></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="lib_shim.js.html">lib/shim.js</a>, <a href="lib_shim.js.html#line16">line 16</a></li></ul></dd></div></dl></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 API</a><div class="mobile-nav-links"><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 class="navbar-item"><a id="" href="https://bajo.app" target="">Bajo</a></div></div><div class="mobile-sidebar-items-c"><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="Base.html">Base</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-events"><div>Events</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#event:bajo:afterAll%257Bmethod%257D">bajo:afterAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBootComplete">bajo:afterBootComplete</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterBuildCollection">bajo:afterBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:afterCollectHooks">bajo:afterCollectHooks</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeAll%257Bmethod%257D">bajo:beforeAll{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:bajo:beforeBuildCollection">bajo:beforeBuildCollection</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:afterAppletRun">{ns}:afterAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:after%257Bmethod%257D">{ns}:after{method}</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:beforeAppletRun">{ns}:beforeAppletRun</a></div><div class="sidebar-section-children"><a href="global.html#event:%257Bns%257D:before%257Bmethod%257D">{ns}:before{method}</a></div></div><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-Helper_Bajo.html">Helper/Bajo</a></div><div class="sidebar-section-children"><a href="module-Helper_Base.html">Helper/Base</a></div><div class="sidebar-section-children"><a href="module-Lib.html">Lib</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#TAppConfigHandler">TAppConfigHandler</a></div><div class="sidebar-section-children"><a href="global.html#TAppEnv">TAppEnv</a></div><div class="sidebar-section-children"><a href="global.html#TAppLib">TAppLib</a></div><div class="sidebar-section-children"><a href="global.html#TBajoDataType">TBajoDataType</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatResult">TBajoFormatResult</a></div><div class="sidebar-section-children"><a href="global.html#TBajoFormatType">TBajoFormatType</a></div><div class="sidebar-section-children"><a href="global.html#TLogJson">TLogJson</a></div><div class="sidebar-section-children"><a href="global.html#TLogLevels">TLogLevels</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathPairs">TNsPathPairs</a></div><div class="sidebar-section-children"><a href="global.html#TNsPathResult">TNsPathResult</a></div><div class="sidebar-section-children"><a href="global.html#TPrintOptions">TPrintOptions</a></div><div class="sidebar-section-children"><a href="global.html#boot">boot</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/static/home.md ADDED
@@ -0,0 +1,32 @@
1
+ ![bajo](static/logo.png)
2
+
3
+ ### The ultimate framework for whipping up a massive app in no time!
4
+
5
+ <p style="display:flex; flex-wrap: wrap; justify-content: space-between; align-items: baseline">
6
+ <a href="https://dobo.bajo.app/" style="text-align:center"><img src="https://ardhi.github.io/dobo/static/logo.png" width="200"><br/>Dobo DBMS</a>
7
+ <a href="https://waibu.bajo.app/" style="text-align:center"><img src="https://ardhi.github.io/waibu/static/logo.png" width="200"><br/>Waibu Web Framework</a>
8
+ <a href="https://sumba.bajo.app/" style="text-align:center"><img src="https://ardhi.github.io/sumba/static/logo.png" width="200"><br/>Sumba Biz Suite</a>
9
+ <a href="https://masohi.bajo.app/" style="text-align:center"><img src="https://ardhi.github.io/masohi/static/logo.png" width="200"><br/>Masohi Messaging</a>
10
+ </p>
11
+
12
+ ## Hire Me
13
+
14
+ If you have a Bajo Framework-based project and need a professional service or assistance, please <a href="https://github.com/ardhi#professional-service">click here</a>. I'd be happy to work on it at a competitive price and with fast turnaround!
15
+
16
+ ## Support Me
17
+
18
+ Please support me using the channels below. Your donation will motivate me to work faster and more diligently on future development.
19
+
20
+ <a href="https://github.com/sponsors/ardhi">
21
+ <img src="https://img.shields.io/badge/Github-slategrey?style=flat&logo=github" height="50">
22
+ </a>
23
+ <a href="https://www.patreon.com/bajoframework">
24
+ <img src="https://img.shields.io/badge/Patreon-f2c3b2?style=flat&logo=patreon" height="50">
25
+ </a>
26
+ <a href="https://www.paypal.com/ncp/payment/EWLERL7SCUU64">
27
+ <img src="https://img.shields.io/badge/Paypal-blue?style=flat&logo=paypal" height="50">
28
+ </a>
29
+
30
+ <p>
31
+ <div><img alt="bc1qwtv78cwp9ef8hnqaw84fxg5856l0pggqe32g6f" src="static/bitcoin.jpeg" width="150" height="150" /><br>Bitcoin</div>
32
+ </p>
package/docs/static/logo-ecosystem.png ADDED
Binary file
package/docs/static/logo.png ADDED
Binary file
package/extend/bajo/intl/en-US.json CHANGED
@@ -19,9 +19,10 @@
19
19
  "oneOrMoreSharedTheSame%s%s": "One or more %s shared the same '%s'",
20
20
  "bootCompleted%s": "Boot process completed in %s",
21
21
  "runInEnv%s": "Run in '%s' environment",
22
- "appRunningAsApplet": "App is running as applet...",
22
+ "appRunningAsApplet": "App runs in applet mode",
23
23
  "setupBootOrder": "Setup boot order",
24
24
  "configHandlers%s": "Config handlers: %s",
25
+ "dataDir%s": "Data dir: %s",
25
26
  "exited": "Exited",
26
27
  "appShutdown": "App shutdown",
27
28
  "appletModeActivated": "Applet mode activated",
@@ -168,5 +169,11 @@
168
169
  "country": "Country",
169
170
  "save": "Save",
170
171
  "local": "Local",
171
- "global": "Global"
172
+ "global": "Global",
173
+ "unknownEnv%s%s": "Unknown environment '%s', accepted values: %s",
174
+ "buildPluginsStart": "Starting to build plugins...",
175
+ "buildPluginsComplete": "Building plugins completed",
176
+ "pluginPackageNotFound%s": "Plugin package '%s' file not found!",
177
+ "pluginPackageInvalid%s": "`Plugin package '%s' should be an instance of Base class`",
178
+ "appletNeedsBajoCli": "Applet needs to have 'bajo-cli' loaded"
172
179
  }
package/extend/bajo/intl/id.json CHANGED
@@ -19,9 +19,10 @@
19
19
  "oneOrMoreSharedTheSame%s%s": "Satu atau lebih %s berbagi '%s'",
20
20
  "bootCompleted%s": "Proses booting komplit dalam %s",
21
21
  "runInEnv%s": "Berjalan di lingkungan '%s'",
22
- "appRunningAsApplet": "App berjalan sebagai applet...",
22
+ "appRunningAsApplet": "App berjalan di mode applet",
23
23
  "setupBootOrder": "Atur urutan booting",
24
24
  "configHandlers%s": "Pengatur konfigurasi: %s",
25
+ "dataDir%s": "Dir data: %s",
25
26
  "exited": "Exited",
26
27
  "appShutdown": "Aplikasi ditutup",
27
28
  "appletModeActivated": "Mode applet diaktifkan",
@@ -168,5 +169,11 @@
168
169
  "country": "Negara",
169
170
  "save": "Simpan",
170
171
  "local": "Lokal",
171
- "global": "Global"
172
+ "global": "Global",
173
+ "unknownEnv%s%s": "Lingkungan '%s' tak dikenal, nilai yang dimungkinkan: %s",
174
+ "buildPluginsStart": "Mulai memuat plugin...",
175
+ "buildPluginsComplete": "Pemuatan plugin komplit",
176
+ "pluginPackageNotFound%s": "Berkas paket plugin '%s' tidak ditemukan!",
177
+ "pluginPackageInvalid%s": "Paket plugin '%s' harus berupa instan dari kelas Base",
178
+ "appletNeedsBajoCli": "Applet membutuhkan 'bajo-cli' yang harus termuat terlebih dahulu"
172
179
  }
package/index.js CHANGED
@@ -3,10 +3,30 @@ import shim from './lib/shim.js'
3
3
 
4
4
  shim()
5
5
 
6
+ /**
7
+ * Main entry point of a Bajo app. Returned value is the app instance itself.
8
+ *
9
+ * While you can code directly around it, you typically write your code the main plugin (```{mainNs}```) or
10
+ * writing your own custom plugin.
11
+ *
12
+ * I recommend the second method for its portability.
13
+ *
14
+ * Example:
15
+ * ```javascript
16
+ * // index.js file. Your main package entry point
17
+ * import bajo from 'bajo'
18
+ * await bajo()
19
+ * ```
20
+ *
21
+ * @global
22
+ * @async
23
+ * @see {@tutorial 01-getting-started}
24
+ * @param {string} [cwd] - Current working directory
25
+ * @returns {App}
26
+ */
6
27
  async function boot (cwd) {
7
28
  const app = new App(cwd)
8
- await app.boot()
9
- return app
29
+ return await app.boot()
10
30
  }
11
31
 
12
32
  export default boot
package/lib/current-loc.js CHANGED
@@ -2,8 +2,30 @@ import path from 'path'
2
2
  import resolvePath from './resolve-path.js'
3
3
  import { fileURLToPath } from 'url'
4
4
 
5
- const currentLoc = (meta) => {
6
- const file = resolvePath(fileURLToPath(meta.url))
5
+ /**
6
+ * Get current directory & file. An attempt to brings back the old ```__dirname``` and ```__filename```
7
+ * to the ES6 era.
8
+ *
9
+ * Returns object with the following keys:
10
+ * - ```__dirname``` (aliases to ```dir```) - current directory name
11
+ * - ```__filename``` (aliases to ```file```) - current file path
12
+ *
13
+ * Example:
14
+ * ```javascript
15
+ * const { importModule } = this.app.bajo
16
+ * const currentLoc = await importModule('bajo:/lib/current-loc.js')
17
+ *
18
+ * const { __dirname, __filename } = currentLoc(import.meta)
19
+ * console.log(__dirname, __filename)
20
+ * ```
21
+ *
22
+ * @method
23
+ * @memberof module:Lib
24
+ * @param {Object} metaImport - ```import.meta``` object
25
+ * @returns {Object}
26
+ */
27
+ const currentLoc = (metaImport) => {
28
+ const file = resolvePath(fileURLToPath(metaImport.url))
7
29
  const dir = path.dirname(file)
8
30
  return { dir, file, __dirname: dir, __filename: file }
9
31
  }
package/lib/formats.js CHANGED
@@ -1,9 +1,7 @@
1
1
  /**
2
- * @module
3
- */
4
-
5
- /**
6
- * @typedef {Object} DataType
2
+ * Supported data types
3
+ *
4
+ * @typedef {Object} TBajoDataType
7
5
  * @type {Array}
8
6
  * @property {string} 0 - string
9
7
  * @property {string} 1 - float
@@ -19,7 +17,9 @@
19
17
  */
20
18
 
21
19
  /**
22
- * @typedef {Object} FormatType
20
+ * General format types
21
+ *
22
+ * @typedef {Object} TBajoFormatType
23
23
  * @type {Array}
24
24
  * @property {string} 0 - speed
25
25
  * @property {string} 1 - distance
package/lib/import-module.js CHANGED
@@ -3,6 +3,35 @@ import fs from 'fs-extra'
3
3
  import lodash from 'lodash'
4
4
  const { isFunction, isPlainObject } = lodash
5
5
 
6
+ /**
7
+ * Import file/module from any loaded plugins
8
+ *
9
+ * Example: your plugin structure looks like this
10
+ * ```
11
+ * |- src
12
+ * | |- lib
13
+ * | | |- my-module.js
14
+ * |- index.js
15
+ * |- package.json
16
+ * ```
17
+ *
18
+ * And now this is how to import ```my-module.js```:
19
+ * ```javascript
20
+ * const { importModule } = this.app.bajo
21
+ * const myModule = await importModule('myPlugin:/src/lib/my-module.js')
22
+ * ```
23
+ *
24
+ * @method
25
+ * @async
26
+ * @memberof module:Lib
27
+ * @param {TNsPathPairs} file - File to import
28
+ * @param {Object} [options={}] - Options
29
+ * @param {boolean} [options.asDefaultImport=true] - If ```true``` (default), return default imported module
30
+ * @param {boolean} [options.asHandler] - If ```true```, return as a {@link HandlerType|handler}
31
+ * @param {boolean} [options.noCache] - If ```true```, always import as a fresh copy
32
+ * @returns {any}
33
+ * @see Bajo#importModule
34
+ */
6
35
  async function importModule (file, { asDefaultImport, asHandler, noCache } = {}) {
7
36
  const load = async (file, asDefaultImport = true, noCache = false) => {
8
37
  file = resolvePath(file, true)
package/lib/log-levels.js CHANGED
@@ -1,17 +1,27 @@
1
1
  /**
2
- * @module
3
- */
4
-
5
- /**
6
- * @typedef {Object} LogLevelsType
2
+ * @typedef {Object} TLogLevels
7
3
  * @type {Object}
8
4
  * @property {Object} trace
5
+ * @property {number} [trace.number=10]
6
+ * @property {string} [trace.color=gray]
9
7
  * @property {Object} debug
8
+ * @property {number} [debug.number=20]
9
+ * @property {string} [debug.color=greenBright]
10
10
  * @property {Object} info
11
+ * @property {number} [info.number=30]
12
+ * @property {string} [info.color=blueBright]
11
13
  * @property {Object} warn
14
+ * @property {number} [warn.number=40]
15
+ * @property {string} [warn.color=yellowBright]
12
16
  * @property {Object} error
17
+ * @property {number} [error.number=50]
18
+ * @property {string} [error.color=redBright]
13
19
  * @property {Object} fatal
20
+ * @property {number} [fatal.number=60]
21
+ * @property {string} [fatal.color=magentaBright]
14
22
  * @property {Object} silent
23
+ * @property {number} [silent.number=99]
24
+ * @property {string} [silent.color=white]
15
25
  */
16
26
 
17
27
  export default {
package/lib/parse-args-argv.js CHANGED
@@ -2,13 +2,13 @@ import yargs from 'yargs'
2
2
  import { Parser } from 'yargs/helpers'
3
3
  import { unflatten } from 'flat'
4
4
  import dotenvParseVariables from 'dotenv-parse-variables'
5
- import importModule from './import-module.js'
6
5
  import lodash from 'lodash'
7
6
  import fs from 'fs-extra'
8
7
  import path from 'path'
9
- import currentLoc from './current-loc.js'
10
8
 
11
9
  const { find, each, set, camelCase, forOwn } = lodash
10
+ const delimiter = '-'
11
+ const splitter = ':'
12
12
 
13
13
  const parseItem = (data, delimiter) => {
14
14
  return unflatten(data, {
@@ -18,7 +18,7 @@ const parseItem = (data, delimiter) => {
18
18
  })
19
19
  }
20
20
 
21
- const parseWithParser = async () => {
21
+ async function parseWithParser () {
22
22
  return Parser(process.argv.slice(2), {
23
23
  configuration: {
24
24
  'camel-case-expansion': false
@@ -26,11 +26,8 @@ const parseWithParser = async () => {
26
26
  })
27
27
  }
28
28
 
29
- const parseWithYargs = async () => {
30
- const parser = './app/bajo/argv-parser.js'
31
- const mod = await importModule(parser)
32
- if (mod) return await mod(yargs)
33
- const pkg = fs.readJSONSync(`${currentLoc(import.meta).dir}/../package.json`)
29
+ async function parseWithYargs () {
30
+ const pkg = fs.readJSONSync(`${this.dir}/package.json`)
34
31
  let name = `node ${pkg.main}`
35
32
  if (pkg.bin) name = path.basename(pkg.bin, '.js')
36
33
  const cli = yargs(process.argv.slice(2))
@@ -42,16 +39,27 @@ const parseWithYargs = async () => {
42
39
  .parserConfiguration({
43
40
  'camel-case-expansion': false
44
41
  })
45
- .version().alias('version', 'v')
42
+ .version(pkg.version).alias('version', 'v')
46
43
  .help().alias('help', 'h')
47
44
  .alias('applet', 'a')
48
45
  if (pkg.homepage) cli.epilog(`For more information please visit ${pkg.homepage}`)
49
46
  return cli.argv
50
47
  }
51
48
 
52
- async function parseArgsArgv ({ delimiter = '-', splitter = ':', useParser } = {}) {
49
+ /**
50
+ * Parse program arguments (args) & options (argv). See {@link App#args|args} & {@link App#argv|argv} for examples
51
+ *
52
+ * @method
53
+ * @async
54
+ * @memberof module:Lib
55
+ * @param {boolean} [useParser] - If ```true```, skip {@link https://github.com/yargs/yargs|yargs}
56
+ * @returns {{args: Array, argv: Object}} An object containing ```args``` and ```argv```
57
+ * @see App#args
58
+ * @see App#argv
59
+ */
60
+ async function parseArgsArgv (useParser) {
53
61
  if (!useParser) useParser = find(process.argv, a => a.startsWith('--spawn'))
54
- let argv = useParser ? await parseWithParser() : await parseWithYargs()
62
+ let argv = useParser ? await parseWithParser.call(this) : await parseWithYargs.call(this)
55
63
  const args = argv._
56
64
  delete argv._
57
65
  delete argv.$0
@@ -66,7 +74,7 @@ async function parseArgsArgv ({ delimiter = '-', splitter = ':', useParser } = {
66
74
  forOwn(all, (v, k) => {
67
75
  result[k] = parseItem(v, delimiter)
68
76
  })
69
- return { args, argv: result }
77
+ return { args, argv: this.bajo.parseObject(result, { parseValue: true }) }
70
78
  }
71
79
 
72
80
  export default parseArgsArgv
package/lib/parse-env.js CHANGED
@@ -4,7 +4,6 @@ import dotEnv from 'dotenv'
4
4
  import lodash from 'lodash'
5
5
 
6
6
  const { each, set, camelCase, forOwn } = lodash
7
-
8
7
  const parse = (data, delimiter) => {
9
8
  return unflatten(data, {
10
9
  delimiter,
@@ -16,15 +15,24 @@ const parse = (data, delimiter) => {
16
15
  })
17
16
  }
18
17
 
19
- export default function ({ delimiter = '__', splitter = '.' } = {}) {
18
+ const delimiter = '__'
19
+ const splitter = '.'
20
+
21
+ /**
22
+ * Parse environment variables. See {@link App#envVars|envVars} for examples
23
+ *
24
+ * @method
25
+ * @memberof module:Lib
26
+ * @returns {Object}
27
+ * @see App#envVars
28
+ */
29
+ function parseEnv () {
20
30
  let env
21
31
  try {
22
- env = dotEnv.config()
23
- if (env.error) throw env.error
32
+ env = dotEnv.config({ quiet: true })
24
33
  } catch (err) {
25
- env = { parsed: {} }
26
34
  }
27
- env = dotenvParseVariables(env.parsed, { assignToProcessEnv: false })
35
+ env = dotenvParseVariables(process.env, { assignToProcessEnv: false })
28
36
  const all = { _: {} }
29
37
  each(env, (v, k) => {
30
38
  const parts = k.split(splitter)
@@ -35,5 +43,8 @@ export default function ({ delimiter = '__', splitter = '.' } = {}) {
35
43
  forOwn(all, (v, k) => {
36
44
  result[k] = parse(v, delimiter)
37
45
  })
38
- return result
46
+ if (result._.lang) result._.lang = result._.lang.split('.')[0].replaceAll('_', '-')
47
+ return this.bajo.parseObject(result, { parseValue: true })
39
48
  }
49
+
50
+ export default parseEnv
package/lib/resolve-path.js CHANGED
@@ -2,14 +2,11 @@ import path from 'path'
2
2
  import { fileURLToPath } from 'url'
3
3
  import os from 'os'
4
4
 
5
- /**
6
- * @module
7
- */
8
-
9
5
  /**
10
6
  * Resolve file name to filesystem's path. Windows path separator ```\```
11
7
  * is normalized to Unix's ```/```
12
8
  *
9
+ * @memberof module:Lib
13
10
  * @param {string} file - File to resolve
14
11
  * @param {boolean} [asFileUrl=false] - Return as file URL format ```file:///<name>```
15
12
  * @returns {string}
package/lib/shim.js CHANGED
@@ -1,5 +1,8 @@
1
1
  /**
2
- * @module
2
+ * External helpers you can use by importing its file directly
3
+ *
4
+ * @name Lib
5
+ * @module Lib
3
6
  */
4
7
 
5
8
  /**
@@ -7,6 +10,8 @@
7
10
  *
8
11
  * - ```String.prototype.replaceAll```
9
12
  * - ```String.prototype.splice```
13
+ *
14
+ * @memberof module:Lib
10
15
  */
11
16
  function shim () {
12
17
  // taken from: https://vanillajstoolkit.com/polyfills/stringreplaceall/
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "bajo",
3
- "version": "2.0.1",
4
- "description": "A framework to build a giant monstrous app rapidly",
3
+ "version": "2.1.0",
4
+ "description": "The ultimate framework for whipping up massive apps in no time",
5
5
  "main": "index.js",
6
6
  "scripts": {
7
7
  "build-doc": "jsdoc -c .jsdoc.conf.json",
@@ -26,7 +26,7 @@
26
26
  "homepage": "https://github.com/ardhi/bajo#readme",
27
27
  "dependencies": {
28
28
  "add-filename-increment": "^1.0.0",
29
- "aneka": "^0.1.4",
29
+ "aneka": "^0.1.5",
30
30
  "chalk": "^5.6.0",
31
31
  "dayjs": "^1.11.13",
32
32
  "deep-freeze-strict": "^1.1.1",
@@ -49,10 +49,7 @@
49
49
  "yargs": "^18.0.0"
50
50
  },
51
51
  "devDependencies": {
52
- "@faker-js/faker": "^9.9.0",
53
- "chai": "^6.0.0",
54
52
  "clean-jsdoc-theme": "^4.3.0",
55
- "docdash": "^2.0.2",
56
- "sinon": "^21.0.0"
53
+ "docdash": "^2.0.2"
57
54
  }
58
55
  }
package/wiki/CONFIG.md ADDED
@@ -0,0 +1,36 @@
1
+ # Config Object
2
+
3
+ The following table shows the default app settings. To change these to suit your needs, please refer to [Getting Started](GETTING-STARTED.md)
4
+
5
+ | Key Name | Type | Default | Description |
6
+ | ------- | ---- | ----- | ----------- |
7
+ | ```log``` | ```object``` | | |
8
+ | &nbsp;&nbsp;&nbsp;&nbsp;```dateFormat``` | ```string``` | ```YYYY-MM-DDTHH:MM:ss.SSS[Z]```| See [dayjs string & format](https://day.js.org/docs/en/parse/string-format) for more info |
9
+ | &nbsp;&nbsp;&nbsp;&nbsp;```timeTaken``` | ```boolean``` | ```false```| Show time taken from previous activity in ms |
10
+ | &nbsp;&nbsp;&nbsp;&nbsp;```useUtc``` | ```boolean``` | ```false```| Use UTC, defaults: local date/time |
11
+ | &nbsp;&nbsp;&nbsp;&nbsp;```pretty``` | ```boolean``` | ```false```| Colorful, pretty styling |
12
+ | &nbsp;&nbsp;&nbsp;&nbsp;```applet``` | ```boolean``` | ```false```| Show log even in applet mode |
13
+ | &nbsp;&nbsp;&nbsp;&nbsp;```save``` | ```boolean``` | ```false```| Save log in '{dataDir}/log' |
14
+ | &nbsp;&nbsp;&nbsp;&nbsp;```rotation``` | ```object``` | | Log rotation config if ```save``` is true |
15
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```cycle``` | ```string``` | ```none``` | Available values: ```none```, ```daily```, ```weekly```, ```monthly``` |
16
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```compressOld``` | ```boolean``` | ```false``` | Set to ```true``` to compress old logs |
17
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```byPlugin``` | ```boolean``` | ```false``` | Split log by plugin's name |
18
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```retain``` | ```integer``` | ```5``` | How many old logs will be kept/retained |
19
+ | ```lang``` | ```string``` | Auto detected | Valid language code e.g: 'en-US', 'id', etc. |
20
+ | ```intl``` | ```object``` | | Internationalization settings |
21
+ | &nbsp;&nbsp;&nbsp;&nbsp;```supported``` | ```array``` | ```['en-US', 'id']``` | Supported languages |
22
+ | &nbsp;&nbsp;&nbsp;&nbsp;```fallback``` | ```string``` | ```en-US``` | Language to use if the selected one isn't valid |
23
+ | &nbsp;&nbsp;&nbsp;&nbsp;```format``` | ```object``` | | |
24
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```emptyValue``` | ```string``` | ```''``` | Value to use if value is ```null``` or ```undefined``` |
25
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```datetime``` | ```object``` | ```{ dateStyle: 'medium', timeStyle: 'short' }``` | See [this link](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) for more info |
26
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```date``` | ```object``` | ```{ dateStyle: 'medium' }``` | See above |
27
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```time``` | ```object``` | ```{ dateStyle: 'short' }``` | See above |
28
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```float``` | ```object``` | ```{ maximumFractionDigits: 2 }``` | See above |
29
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```double``` | ```object``` | ```{ maximumFractionDigits: 5 }``` | See above |
30
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```smallint``` | ```object``` | ```{}``` | See above |
31
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```integer``` | ```object``` | ```{}``` | See above |
32
+ | &nbsp;&nbsp;&nbsp;&nbsp;```unitSys``` | ```object``` | | Add new language if necessary. If not specified, value defaults to ```metric```. Accepted values: ```imperial```, ```metric```, ```nautical``` |
33
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```en-US``` | ```string``` | ```imperial``` | |
34
+ | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;```id``` | ```string``` | ```metric``` | |
35
+ | ```exitHandler``` | ```boolean``` | ```true``` | If ```false```, no graceful shutdown |
36
+ | ```env``` | ```string``` | ```dev``` | Acceptable values: ```dev```, or ```prod``` |
package/wiki/CONTRIBUTING.md ADDED
@@ -0,0 +1,5 @@
1
+ # Contributing
2
+
3
+ Thanks very much to everyone who wants to join as a contributor, but I have committed to devoting 100% of my time to this project. Therefore, I'm currently unable to accept pull requests from anyone until the project is large enough for me to manage it independently.
4
+
5
+ However, I am available if you encounter any bugs that require immediate fixes. Please report your issues in a GitHub issue, and I'll try to address them promptly. I'm also open to criticism and suggestions for improvements or requests for new features.
package/wiki/DEV_GUIDE.md ADDED
@@ -0,0 +1,3 @@
1
+ # Developer Guide
2
+
3
+ TBD