bajo 2.21.1 → 2.22.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 (66) hide show
  1. package/.jsdoc.conf.json +1 -1
  2. package/class/app.js +139 -115
  3. package/class/bajo.js +96 -89
  4. package/class/base.js +25 -9
  5. package/class/cache.js +32 -19
  6. package/class/err.js +11 -9
  7. package/class/log.js +102 -52
  8. package/class/plugin.js +45 -35
  9. package/class/print.js +45 -44
  10. package/class/tools.js +7 -1
  11. package/docs/App.html +1 -23
  12. package/docs/Bajo.html +1 -6
  13. package/docs/Base.html +1 -1
  14. package/docs/Cache.html +1 -1
  15. package/docs/Err.html +2 -2
  16. package/docs/Log.html +4 -4
  17. package/docs/Plugin.html +1 -1
  18. package/docs/Print.html +1 -1
  19. package/docs/Tools.html +1 -1
  20. package/docs/class_app.js.html +141 -117
  21. package/docs/class_bajo.js.html +98 -91
  22. package/docs/class_base.js.html +27 -11
  23. package/docs/class_cache.js.html +34 -21
  24. package/docs/class_err.js.html +13 -11
  25. package/docs/class_log.js.html +104 -54
  26. package/docs/class_plugin.js.html +47 -37
  27. package/docs/class_print.js.html +47 -46
  28. package/docs/class_tools.js.html +9 -3
  29. package/docs/data/search.json +1 -1
  30. package/docs/global.html +1 -1
  31. package/docs/index.html +1 -1
  32. package/docs/index.js.html +8 -4
  33. package/docs/{class__helper.js.html → lib_helper.js.html} +208 -96
  34. package/docs/lib_hook.js.html +231 -0
  35. package/docs/module-Helper.html +8 -1
  36. package/docs/module-Hook.html +3 -0
  37. package/docs/module-Lib.html +1 -8
  38. package/index.js +1 -1
  39. package/{class/_helper.js → lib/helper.js} +206 -94
  40. package/lib/hook.js +228 -0
  41. package/package.json +1 -1
  42. package/wiki/CHANGES.md +6 -0
  43. package/docs/class_helper_bajo.js.html +0 -398
  44. package/docs/class_helper_base.js.html +0 -246
  45. package/docs/class_misc_err.js.html +0 -129
  46. package/docs/class_misc_log.js.html +0 -210
  47. package/docs/class_misc_print.js.html +0 -267
  48. package/docs/lib_current-loc.js.html +0 -36
  49. package/docs/lib_find-deep.js.html +0 -27
  50. package/docs/lib_formats.js.html +0 -68
  51. package/docs/lib_freeze.js.html +0 -54
  52. package/docs/lib_import-module.js.html +0 -61
  53. package/docs/lib_index.js.html +0 -9
  54. package/docs/lib_log-levels.js.html +0 -38
  55. package/docs/lib_parse-args-argv.js.html +0 -83
  56. package/docs/lib_parse-env.js.html +0 -53
  57. package/docs/lib_resolve-path.js.html +0 -27
  58. package/docs/lib_shim.js.html +0 -40
  59. package/docs/module-Helper_Bajo.html +0 -3
  60. package/docs/module-Helper_Base.html +0 -3
  61. package/lib/find-deep.js +0 -24
  62. package/lib/formats.js +0 -65
  63. package/lib/freeze.js +0 -51
  64. package/lib/import-module.js +0 -58
  65. package/lib/index.js +0 -6
  66. package/lib/log-levels.js +0 -35
package/lib/hook.js ADDED
@@ -0,0 +1,228 @@
1
+ /**
2
+ * @module Hook
3
+ */
4
+
5
+ /**
6
+ * @typedef THook
7
+ * @type {Object}
8
+ * @property {string} name - Hook name
9
+ * @property {string} ns - Hook namespace
10
+ * @property {function} handler - Hook handler function
11
+ * @property {number} [level=999] - Hook level (lower number means higher priority)
12
+ * @property {string} src - Hook source (origin plugin namespace). Bajo will set this automatically, any value you set will be overriden.
13
+ * @property {boolean} [noWait=false] - If true, Bajo will not wait for this hook to complete before proceeding to the next hook. Default is false.
14
+ */
15
+
16
+ /**
17
+ * Run before boot process. You can use this hook to do some pre-boot process.
18
+ *
19
+ * @name bajo:beforeBoot
20
+ * @async
21
+ * @method
22
+ */
23
+
24
+ /**
25
+ * Run after boot process. You can use this hook to do some post-boot process.
26
+ *
27
+ * @name bajo:afterBoot
28
+ * @async
29
+ * @method
30
+ */
31
+
32
+ /**
33
+ * Run after hooks are collected. You can use this hook to modify the collected hooks before
34
+ * they are recognized as application hooks.
35
+ *
36
+ * @async
37
+ * @method
38
+ * @name bajo:afterCollectHooks
39
+ * @param {Array<module:Hook~THook>} hooks - Array of hook objects
40
+ * @see module:Helper.collectHooks
41
+ */
42
+
43
+ /**
44
+ * Run before all plugins are initialized. You can use this hook to do some pre-initialization process.
45
+ *
46
+ * @async
47
+ * @method
48
+ * @name bajo:beforeAllInit
49
+ * @see module:Helper.run
50
+ */
51
+
52
+ /**
53
+ * Run after all plugins are initialized. You can use this hook to do some post-initialization process.
54
+ *
55
+ * @async
56
+ * @method
57
+ * @name bajo:afterAllInit
58
+ * @see module:Helper.run
59
+ */
60
+
61
+ /**
62
+ * Run before all plugins are started. You can use this hook to do some pre-start process.
63
+ *
64
+ * @async
65
+ * @method
66
+ * @name bajo:beforeAllStart
67
+ * @see module:Helper.run
68
+ */
69
+
70
+ /**
71
+ * Run after all plugins are started. You can use this hook to do some post-start process.
72
+ *
73
+ * @async
74
+ * @method
75
+ * @name bajo:afterAllStart
76
+ * @see module:Helper.run
77
+ */
78
+
79
+ /**
80
+ * Run before `{ns}` plugins are initialized. You can use this hook to do some pre-initialization process.
81
+ *
82
+ * @async
83
+ * @method
84
+ * @name {ns}:beforeInit
85
+ * @see module:Helper.run
86
+ */
87
+
88
+ /**
89
+ * Run after `{ns}` plugins are initialized. You can use this hook to do some post-initialization process.
90
+ *
91
+ * @async
92
+ * @method
93
+ * @name {ns}:afterInit
94
+ * @see module:Helper.run
95
+ */
96
+
97
+ /**
98
+ * Run after `{ns}` plugins are initialized. You can use this hook to do some pre-start process.
99
+ *
100
+ * @async
101
+ * @method
102
+ * @name {ns}:beforeStart
103
+ * @see module:Helper.run
104
+ */
105
+
106
+ /**
107
+ * Run after `{ns}` plugins are started. You can use this hook to do some post-start process.
108
+ *
109
+ * @async
110
+ * @method
111
+ * @name {ns}:afterStart
112
+ * @see module:Helper.run
113
+ */
114
+
115
+ /**
116
+ * Run before applet is run. `{ns}` is the applet's namespace
117
+ *
118
+ * @name {ns}:beforeAppletRun
119
+ * @async
120
+ * @method
121
+ * @param {...any} args - Arguments passed to the applet
122
+ * @see module:Helper.runAsApplet
123
+ */
124
+
125
+ /**
126
+ * Run after applet is run. `{ns}` is the applet's namespace
127
+ *
128
+ * @name {ns}:afterAppletRun
129
+ * @async
130
+ * @method
131
+ * @param {...any} args - Arguments passed to the applet
132
+ * @see module:Helper.runAsApplet
133
+ */
134
+
135
+ /**
136
+ * Run before collection is built.
137
+ *
138
+ * @async
139
+ * @method
140
+ * @name bajo:beforeBuildCollection
141
+ * @param {string} container - Collection container name
142
+ * @see Bajo#buildCollections
143
+ */
144
+
145
+ /**
146
+ * Run after collection is built.
147
+ *
148
+ * @async
149
+ * @method
150
+ * @name bajo:afterBuildCollection
151
+ * @param {string} container - Collection container name
152
+ * @param {array<object>} items - Collection items
153
+ * @see Bajo#buildCollections
154
+ */
155
+
156
+ /**
157
+ * Run after a non override/extended configuration file is read.
158
+ *
159
+ * @async
160
+ * @method
161
+ * @name bajo.default:afterReadConfig
162
+ * @param {string} file - Config file path
163
+ * @param {string} orgObj - Original config object before parsing
164
+ * @param {object} options - readConfig options
165
+ */
166
+
167
+ /**
168
+ * Run before a configuration file override is read.
169
+ *
170
+ * @async
171
+ * @method
172
+ * @name bajo.override:beforeReadConfig
173
+ * @param {string} fileExt - Config file extension
174
+ * @param {object} options - readConfig options
175
+ */
176
+
177
+ /**
178
+ * Run after a configuration file override is read.
179
+ *
180
+ * @async
181
+ * @method
182
+ * @name bajo.override:afterReadConfig
183
+ * @param {string} fileExt - Config file extension
184
+ * @param {object} result - Resulting config object after parsing
185
+ * @param {object} options - readConfig options
186
+ */
187
+
188
+ /**
189
+ * Run before a extended configuration file is read.
190
+ *
191
+ * @async
192
+ * @method
193
+ * @name bajo.extend:beforeReadConfig
194
+ * @param {string} fileExt - Config file extension
195
+ * @param {object} options - readConfig options
196
+ */
197
+
198
+ /**
199
+ * Run after a extended configuration file is read.
200
+ *
201
+ * @async
202
+ * @method
203
+ * @name bajo.extend:afterReadConfig
204
+ * @param {string} fileExt - Config file extension
205
+ * @param {object} result - Resulting config object after parsing
206
+ * @param {object} options - readConfig options
207
+ */
208
+
209
+ /**
210
+ * Run before a configuration file is read.
211
+ *
212
+ * @async
213
+ * @method
214
+ * @name bajo:beforeReadConfig
215
+ * @param {string} file - Config file path
216
+ * @param {object} options - readConfig options
217
+ */
218
+
219
+ /**
220
+ * Run after all read processes of a configuration file are completed.
221
+ *
222
+ * @async
223
+ * @method
224
+ * @name bajo:afterReadConfig
225
+ * @param {string} file - Config file path
226
+ * @param {object} result - Resulting config object after parsing
227
+ * @param {object} options - readConfig options
228
+ */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bajo",
3
- "version": "2.21.1",
3
+ "version": "2.22.0",
4
4
  "description": "The ultimate framework for whipping up massive apps in no time",
5
5
  "main": "index.js",
6
6
  "scripts": {
package/wiki/CHANGES.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changes
2
2
 
3
+ ## 2026-07-08
4
+
5
+ - [2.22.0] Update documentations
6
+ - [2.22.0] Reorganize project files
7
+ - [2.22.0] Bug fix in boot process
8
+
3
9
  ## 2026-07-02
4
10
 
5
11
  - [2.21.1] Bug fix in ```index.js```
@@ -1,398 +0,0 @@
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>Source: class/helper/bajo.js</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 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 currentLoc from '../../lib/current-loc.js'
4
- import resolvePath from '../../lib/resolve-path.js'
5
- import Print from '../misc/print.js'
6
- import Log from '../misc/log.js'
7
- import omitDeep from 'omit-deep'
8
- import os from 'os'
9
- import fs from 'fs-extra'
10
- import lodash from 'lodash'
11
- import {
12
- buildConfigs,
13
- checkDependencies,
14
- checkNameAliases,
15
- attachMethods,
16
- collectHooks,
17
- run
18
- } from './base.js'
19
-
20
- const {
21
- reduce,
22
- isNaN,
23
- forOwn,
24
- orderBy,
25
- isFunction,
26
- isPlainObject,
27
- map,
28
- pick,
29
- values,
30
- keys,
31
- set,
32
- get,
33
- filter,
34
- trim,
35
- without,
36
- uniq,
37
- camelCase,
38
- isEmpty
39
- } = lodash
40
-
41
- const omitted = ['spawn', 'cwd', 'name', 'alias', 'applet', 'a', 'plugins']
42
-
43
- const defConfig = {
44
- env: 'dev',
45
- log: {
46
- timeTaken: false,
47
- dateFormat: 'YYYY-MM-DDTHH:MM:ss.SSS[Z]',
48
- localDate: false,
49
- pretty: false,
50
- applet: false,
51
- traceHook: false
52
- },
53
- lang: Intl.DateTimeFormat().resolvedOptions().lang ?? 'en-US',
54
- intl: {
55
- supported: ['en-US', 'id'],
56
- fallback: 'en-US',
57
- lookupOrder: [],
58
- format: {
59
- emptyValue: '',
60
- datetime: { dateStyle: 'medium', timeStyle: 'short' },
61
- date: { dateStyle: 'medium' },
62
- time: { timeStyle: 'short' },
63
- float: { maximumFractionDigits: 2 },
64
- double: { maximumFractionDigits: 5 },
65
- smallint: {},
66
- integer: {}
67
- },
68
- unitSys: {
69
- 'en-US': 'imperial',
70
- id: 'metric'
71
- }
72
- },
73
- exitHandler: true
74
- }
75
-
76
- const defMain = `async function factory (pkgName) {
77
- const me = this
78
-
79
- return class Main extends this.app.pluginClass.base {
80
- constructor () {
81
- super(pkgName, me.app)
82
- this.config = {}
83
- }
84
- }
85
- }
86
-
87
- export default factory
88
- `
89
-
90
- /**
91
- * Internal helpers called by Bajo that only used once for bootstrapping. It should remains
92
- * hidden and not to be imported by any program.
93
- *
94
- * @module Helper/Bajo
95
- */
96
-
97
- /**
98
- * Building bajo base config. Mostly dealing with directory setups:
99
- * - determine base directory
100
- * - check whether data directory is valid. If not exist, create one inside app dir
101
- * - ensure data config directory is there
102
- * - ensure tmp dir is there
103
- * - read the list of plugins from ```.plugins``` file
104
- *
105
- * @async
106
- */
107
- export async function buildBaseConfig () {
108
- // dirs
109
- const { defaultsDeep } = this.app.lib.aneka
110
- this.config = defaultsDeep({}, this.app.envVars._, this.app.argv._)
111
- set(this, 'dir.base', this.app.dir)
112
- const path = currentLoc(import.meta).dir + '/../..'
113
- set(this, 'dir.pkg', this.resolvePath(path))
114
- if (!get(this, 'dir.data')) set(this, 'dir.data', `${this.dir.base}/data`)
115
- this.dir.data = this.resolvePath(this.dir.data)
116
- if (!fs.existsSync(this.dir.data)) {
117
- console.log('Data directory (%s) doesn\'t exist yet', this.dir.data)
118
- process.exit(1)
119
- }
120
- fs.ensureDirSync(`${this.dir.data}/config`)
121
- if (!this.dir.tmp) {
122
- this.dir.tmp = `${this.resolvePath(os.tmpdir())}/${this.ns}`
123
- fs.ensureDirSync(this.dir.tmp)
124
- }
125
- // collect list of plugins
126
- let pluginPkgs = []
127
- const pluginsFile = `${this.dir.data}/config/.plugins`
128
- if (fs.existsSync(pluginsFile)) {
129
- pluginPkgs = pluginPkgs.concat(filter(map(trim(fs.readFileSync(pluginsFile, 'utf8')).split('\n'), p => trim(p)), b => !isEmpty(b)))
130
- }
131
- this.app.pluginPkgs = map(filter(without(uniq(pluginPkgs), this.app.mainNs), p => {
132
- return p[0] !== '#'
133
- }), p => {
134
- return trim(p.split('#')[0])
135
- })
136
- this.app.pluginPkgs.push(this.app.mainNs)
137
- }
138
-
139
- /**
140
- * Building all plugins:
141
- * - load from app's pluginPkgs
142
- * - iterate through the list and build related plugins
143
- * - making sure main plugin is there. If not, create from template
144
- * - attach these plugins to the app instance
145
- *
146
- * @async
147
- */
148
- export async function buildPlugins () {
149
- this.log.trace('buildPluginsStart')
150
- for (const pkg of this.app.pluginPkgs) {
151
- const ns = camelCase(pkg)
152
- let dir
153
- if (ns === 'main') {
154
- dir = `${this.dir.base}/${this.app.mainNs}`
155
- fs.ensureDirSync(dir)
156
- if (!fs.existsSync(`${dir}/index.js`)) {
157
- fs.writeFileSync(`${dir}/index.js`, defMain, 'utf8')
158
- }
159
- } else dir = this.getModuleDir(pkg)
160
- const factory = `${dir}/index.js`
161
- if (!fs.existsSync(factory)) throw this.error('pluginPackageNotFound%s', pkg)
162
- const { default: builder } = await import(resolvePath(factory, true))
163
- const ClassDef = await builder.call(this, pkg)
164
- const plugin = new ClassDef()
165
- if (!(plugin instanceof this.app.pluginClass.base)) throw this.error('pluginPackageInvalid%s', pkg)
166
- this.app.addPlugin(plugin, ClassDef)
167
- this.log.trace('- ' + pkg)
168
- }
169
- this.log.debug('buildPluginsComplete')
170
- }
171
-
172
- /**
173
- * Collect all config handlers, including the one provided by plugins
174
- *
175
- * @async
176
- */
177
- export async function collectConfigHandlers () {
178
- for (const pkg of this.app.pluginPkgs) {
179
- let dir
180
- try {
181
- dir = this.getModuleDir(pkg)
182
- } catch (err) {}
183
- if (!dir) continue
184
- const file = `${dir}/extend/bajo/config-handlers.js`
185
- let mod = await this.importModule(file)
186
- if (!mod) continue
187
- if (isFunction(mod)) mod = await mod.call(this.app[camelCase(pkg)])
188
- if (isPlainObject(mod)) mod = [mod]
189
- this.app.configHandlers = this.app.configHandlers.concat(mod)
190
- }
191
- this.app.log = new Log(this.app)
192
- }
193
-
194
- /**
195
- * Bajo extra config:
196
- * - reading config file
197
- * - merge config with arguments &amp; environments values
198
- * - Set environment (```dev``` or ```prod```)
199
- *
200
- * @async
201
- */
202
- export async function buildExtConfig () {
203
- // config merging
204
- const { defaultsDeep } = this.app.lib.aneka
205
- let resp = await this.readAllConfigs(`${this.dir.data}/config/${this.ns}`)
206
- resp = omitDeep(pick(resp, ['log', 'exitHandler', 'env']), omitted)
207
- const envs = this.app.constructor.envs
208
- this.config = defaultsDeep({}, this.config, resp, defConfig)
209
- // language
210
- this.config.lang = (this.config.lang ?? '').split('.')[0]
211
- this.app.loadIntl(this.ns)
212
- this.print = new Print(this)
213
- // environment
214
- if (values(envs).includes(this.config.env)) this.config.env = this.app.lib.aneka.getKeyByValue(envs, this.config.env)
215
- if (!keys(envs).includes(this.config.env)) throw this.error('unknownEnv%s%s', this.config.env, this.join(keys(envs), { lastSeparator: this.t('or') }))
216
- process.env.NODE_ENV = envs[this.config.env]
217
- if (!this.config.log.level) this.config.log.level = this.config.env === 'dev' ? 'debug' : 'info'
218
- // misc
219
- const obj = this.app.applet ? this.config : pick(this.config, keys(defConfig))
220
- this.config = this.parseObject(obj, { parseValue: true })
221
- const exts = this.app.getConfigFormats()
222
- if (this.app.applet) {
223
- if (!this.app.pluginPkgs.includes('bajo-cli')) throw this.error('appletNeedsBajoCli')
224
- if (!this.config.log.applet) this.config.log.level = 'silent'
225
- this.config.exitHandler = false
226
- }
227
- this.log.debug('configHandlers%s', this.join(exts))
228
- }
229
-
230
- /**
231
- * Setup plugins boot orders by reading plugin's ```.bootorder``` file if provided.
232
- *
233
- * @async
234
- */
235
- export async function bootOrder () {
236
- this.log.debug('setupBootOrder')
237
- const order = reduce(this.app.pluginPkgs, (o, k, i) => {
238
- const key = map(k.split(':'), m => trim(m))
239
- if (key[1] &amp;&amp; !isNaN(Number(key[1]))) o[key[0]] = Number(key[1])
240
- else o[key[0]] = 10000 + i
241
- return o
242
- }, {})
243
- const norder = {}
244
- for (let n of this.app.pluginPkgs) {
245
- n = map(n.split(':'), m => trim(m))[0]
246
- const dir = n === this.app.mainNs ? (`${this.dir.base}/${this.app.mainNs}`) : this.getModuleDir(n)
247
- if (n !== this.app.mainNs &amp;&amp; !fs.existsSync(dir)) throw this.error('packageNotFoundOrNotBajo%s', n)
248
- norder[n] = NaN
249
- try {
250
- norder[n] = Number(trim(await fs.readFile(`${dir}/.bootorder`, 'utf8')))
251
- } catch (err) {}
252
- }
253
- const result = []
254
- forOwn(order, (v, k) => {
255
- const item = { k, v: isNaN(norder[k]) ? v : norder[k] }
256
- result.push(item)
257
- })
258
- this.app.pluginPkgs = map(orderBy(result, ['v']), 'k')
259
- this.log.debug('runInEnv%s', this.t(this.app.constructor.envs[this.config.env]))
260
- // misc
261
- this.freeze(this.config)
262
- }
263
-
264
- /**
265
- * Iterate through all plugins loaded and do:
266
- *
267
- * 1. {@link module:Helper/Base.buildConfigs|build configs}
268
- * 2. {@link module:Helper/Base.checkNameAliases|ensure names &amp; aliases uniqueness}
269
- * 3. {@link module:Helper/Base.checkDependencies|ensure dependencies are met}
270
- * 4. {@link module:Helper/Base.attachMethods|build and attach dynamic methods}
271
- * 5. {@link module:Helper/Base.collectHooks|collect hooks}
272
- * 6. {@link module:Helper/Base.run|run plugins}
273
- *
274
- * @async
275
- */
276
- export async function bootPlugins () {
277
- await buildConfigs.call(this.app)
278
- await checkNameAliases.call(this.app)
279
- await checkDependencies.call(this.app)
280
- await attachMethods.call(this.app)
281
- await collectHooks.call(this.app)
282
- await run.call(this.app)
283
- }
284
-
285
- /**
286
- * Attach plugins exit handlers and make sure the app shutdowns gracefully
287
- *
288
- * @async
289
- */
290
- export async function exitHandler () {
291
- if (!this.config.exitHandler) return
292
-
293
- async function exit (signal) {
294
- const { eachPlugins } = this
295
- if (signal) this.log.warn('signalReceived%s', signal)
296
- await eachPlugins(async function ({ ns }) {
297
- try {
298
- await this.exit()
299
- } catch (err) {}
300
- this.log.trace('exited')
301
- })
302
- this.log.debug('appShutdown')
303
- process.exit(0)
304
- }
305
-
306
- process.on('SIGINT', async () => {
307
- await exit.call(this, 'SIGINT')
308
- })
309
-
310
- process.on('SIGTERM', async () => {
311
- await exit.call(this, 'SIGTERM')
312
- })
313
-
314
- process.on('beforeExit', async () => {
315
- await exit.call(this)
316
- })
317
-
318
- process.on('uncaughtException', (error, origin) => {
319
- setTimeout(() => {
320
- console.error(error)
321
- // process.exit(1)
322
- }, 50)
323
- })
324
-
325
- process.on('unhandledRejection', (reason, promise) => {
326
- const stackFile = reason.stack.split('\n')[1]
327
- let file
328
- const info = stackFile.match(/\((.*)\)/) // file is in (&lt;file>)
329
- if (info) file = info[1]
330
- else if (stackFile.startsWith(' at ')) file = stackFile.slice(7) // file is stackFile itself
331
- if (!file) return
332
- const parts = file.split(':')
333
- const column = parseInt(parts[parts.length - 1])
334
- const line = parseInt(parts[parts.length - 2])
335
- parts.pop()
336
- parts.pop()
337
- file = parts.join(':')
338
- this.log.error({ file, line, column }, '%s', reason.message)
339
- })
340
-
341
- process.on('warning', warning => {
342
- this.log.error('%s', warning.message)
343
- })
344
- }
345
-
346
- /**
347
- * If app is in ```applet``` mode, this little helper should take care plugin's applet boot process
348
- *
349
- * @async
350
- * @fires {ns}:beforeAppletRun
351
- * @fires {ns}:afterAppletRun
352
- */
353
- export async function runAsApplet () {
354
- const { isString, map, find } = this.app.lib._
355
- await this.eachPlugins(async function ({ file }) {
356
- const { ns } = this
357
- const { alias } = this.constructor
358
- this.app.applets.push({ ns, file, alias })
359
- }, { glob: 'applet.js', prefix: 'bajoCli' })
360
-
361
- this.log.debug('appletModeActivated')
362
- this.print.info('appRunningAsApplet')
363
- if (this.app.applets.length === 0) this.print.fatal('noAppletLoaded')
364
- let name = this.app.applet
365
- if (!isString(name)) {
366
- const select = await this.importPkg('bajoCli:@inquirer/select')
367
- name = await select({
368
- message: this.t('Please select:'),
369
- choices: map(this.app.applets, t => ({ value: t.ns }))
370
- })
371
- }
372
- const [ns, path] = name.split(':')
373
- const applet = find(this.app.applets, a => (a.ns === ns || a.alias === ns))
374
- if (!applet) this.print.fatal('notFound%s%s', this.app.t('applet'), name)
375
-
376
- /**
377
- * Run before applet is run. ```[ns]``` is applet's namespace
378
- *
379
- * @global
380
- * @event {ns}:beforeAppletRun
381
- * @param {...any} params
382
- * @see {@tutorial hook}
383
- * @see module:Helper/Bajo.runAsApplet
384
- */
385
- await this.runHook(`${this.app[applet.ns]}:beforeAppletRun`, ...this.app.args)
386
- await this.app.bajoCli.runApplet(applet, path, ...this.app.args)
387
- /**
388
- * Run after applet is run. ```[ns]``` is applet's namespace
389
- *
390
- * @global
391
- * @event {ns}:afterAppletRun
392
- * @param {...any} params
393
- * @see {@tutorial hook}
394
- * @see module:Helper/Bajo.runAsApplet
395
- */
396
- await this.runHook(`${this.app[applet.ns]}:afterAppletRun`, ...this.app.args)
397
- }
398
- </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 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>