@prosopo/datasets-fs 3.0.8 → 3.0.34

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 (112) hide show
  1. package/CHANGELOG.md +289 -0
  2. package/coverage/base.css +224 -0
  3. package/coverage/block-navigation.js +87 -0
  4. package/coverage/clover.xml +1397 -0
  5. package/coverage/coverage-final.json +18 -0
  6. package/coverage/favicon.png +0 -0
  7. package/coverage/index.html +161 -0
  8. package/coverage/prettify.css +1 -0
  9. package/coverage/prettify.js +2 -0
  10. package/coverage/sort-arrow-sprite.png +0 -0
  11. package/coverage/sorter.js +210 -0
  12. package/coverage/src/cli/cli.ts.html +334 -0
  13. package/coverage/src/cli/cliCommand.ts.html +289 -0
  14. package/coverage/src/cli/cliCommandComposite.ts.html +247 -0
  15. package/coverage/src/cli/index.html +146 -0
  16. package/coverage/src/cli.ts.html +235 -0
  17. package/coverage/src/commands/flatten.ts.html +547 -0
  18. package/coverage/src/commands/generate.ts.html +739 -0
  19. package/coverage/src/commands/generateV1.ts.html +904 -0
  20. package/coverage/src/commands/generateV2.ts.html +952 -0
  21. package/coverage/src/commands/get.ts.html +430 -0
  22. package/coverage/src/commands/index.html +221 -0
  23. package/coverage/src/commands/labels.ts.html +319 -0
  24. package/coverage/src/commands/relocate.ts.html +412 -0
  25. package/coverage/src/commands/resize.ts.html +598 -0
  26. package/coverage/src/dummy.ts.html +241 -0
  27. package/coverage/src/index.html +146 -0
  28. package/coverage/src/index.ts.html +127 -0
  29. package/coverage/src/utils/index.html +146 -0
  30. package/coverage/src/utils/input.ts.html +259 -0
  31. package/coverage/src/utils/inputOutput.ts.html +172 -0
  32. package/coverage/src/utils/output.ts.html +343 -0
  33. package/dist/cjs/cli/cli.cjs +2 -1
  34. package/dist/cli/cli.d.ts +9 -0
  35. package/dist/cli/cli.d.ts.map +1 -0
  36. package/dist/cli/cli.js.map +1 -0
  37. package/dist/cli/cliCommand.d.ts +17 -0
  38. package/dist/cli/cliCommand.d.ts.map +1 -0
  39. package/dist/cli/cliCommand.js +31 -0
  40. package/dist/cli/cliCommand.js.map +1 -0
  41. package/dist/cli/cliCommandComposite.d.ts +14 -0
  42. package/dist/cli/cliCommandComposite.d.ts.map +1 -0
  43. package/dist/cli/cliCommandComposite.js +32 -0
  44. package/dist/cli/cliCommandComposite.js.map +1 -0
  45. package/dist/cli.d.ts +2 -0
  46. package/dist/cli.d.ts.map +1 -0
  47. package/dist/cli.js +34 -0
  48. package/dist/cli.js.map +1 -0
  49. package/dist/commands/flatten.d.ts +59 -0
  50. package/dist/commands/flatten.d.ts.map +1 -0
  51. package/dist/commands/flatten.js +97 -0
  52. package/dist/commands/flatten.js.map +1 -0
  53. package/dist/commands/generate.d.ts +115 -0
  54. package/dist/commands/generate.d.ts.map +1 -0
  55. package/dist/commands/generate.js +150 -0
  56. package/dist/commands/generate.js.map +1 -0
  57. package/dist/commands/generateV1.d.ts +179 -0
  58. package/dist/commands/generateV1.d.ts.map +1 -0
  59. package/dist/commands/generateV1.js +169 -0
  60. package/dist/commands/generateV1.js.map +1 -0
  61. package/dist/commands/generateV2.d.ts +189 -0
  62. package/dist/commands/generateV2.d.ts.map +1 -0
  63. package/dist/commands/generateV2.js +200 -0
  64. package/dist/commands/generateV2.js.map +1 -0
  65. package/dist/commands/get.d.ts +35 -0
  66. package/dist/commands/get.d.ts.map +1 -0
  67. package/dist/commands/get.js +92 -0
  68. package/dist/commands/get.js.map +1 -0
  69. package/dist/commands/labels.d.ts +47 -0
  70. package/dist/commands/labels.d.ts.map +1 -0
  71. package/dist/commands/labels.js +48 -0
  72. package/dist/commands/labels.js.map +1 -0
  73. package/dist/commands/relocate.d.ts +71 -0
  74. package/dist/commands/relocate.d.ts.map +1 -0
  75. package/dist/commands/relocate.js +81 -0
  76. package/dist/commands/relocate.js.map +1 -0
  77. package/dist/commands/resize.d.ts +69 -0
  78. package/dist/commands/resize.d.ts.map +1 -0
  79. package/dist/commands/resize.js +112 -0
  80. package/dist/commands/resize.js.map +1 -0
  81. package/dist/dummy.d.ts +2 -0
  82. package/dist/dummy.d.ts.map +1 -0
  83. package/dist/dummy.js +28 -0
  84. package/dist/dummy.js.map +1 -0
  85. package/dist/index.d.ts +2 -0
  86. package/dist/index.d.ts.map +1 -0
  87. package/dist/index.js.map +1 -0
  88. package/dist/tests/lodash.unit.test.d.ts +2 -0
  89. package/dist/tests/lodash.unit.test.d.ts.map +1 -0
  90. package/dist/tests/lodash.unit.test.js +29 -0
  91. package/dist/tests/lodash.unit.test.js.map +1 -0
  92. package/dist/tests/mocked.unit.test.d.ts +2 -0
  93. package/dist/tests/mocked.unit.test.d.ts.map +1 -0
  94. package/dist/tests/mocked.unit.test.js +253 -0
  95. package/dist/tests/mocked.unit.test.js.map +1 -0
  96. package/dist/tests/utils.d.ts +35 -0
  97. package/dist/tests/utils.d.ts.map +1 -0
  98. package/dist/tests/utils.js +101 -0
  99. package/dist/tests/utils.js.map +1 -0
  100. package/dist/utils/input.d.ts +24 -0
  101. package/dist/utils/input.d.ts.map +1 -0
  102. package/dist/utils/input.js +35 -0
  103. package/dist/utils/input.js.map +1 -0
  104. package/dist/utils/inputOutput.d.ts +21 -0
  105. package/dist/utils/inputOutput.d.ts.map +1 -0
  106. package/dist/utils/inputOutput.js +10 -0
  107. package/dist/utils/inputOutput.js.map +1 -0
  108. package/dist/utils/output.d.ts +36 -0
  109. package/dist/utils/output.d.ts.map +1 -0
  110. package/dist/utils/output.js +62 -0
  111. package/dist/utils/output.js.map +1 -0
  112. package/package.json +16 -20
package/coverage/src/cli/cli.ts.html ADDED
@@ -0,0 +1,334 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/cli/cli.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../prettify.css" />
9
+ <link rel="stylesheet" href="../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../index.html">All files</a> / <a href="index.html">src/cli</a> cli.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">0% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>0/59</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">0% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>0/1</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">0% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>0/1</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">0% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>0/59</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line low'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a>
90
+ <a name='L25'></a><a href='#L25'>25</a>
91
+ <a name='L26'></a><a href='#L26'>26</a>
92
+ <a name='L27'></a><a href='#L27'>27</a>
93
+ <a name='L28'></a><a href='#L28'>28</a>
94
+ <a name='L29'></a><a href='#L29'>29</a>
95
+ <a name='L30'></a><a href='#L30'>30</a>
96
+ <a name='L31'></a><a href='#L31'>31</a>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a>
100
+ <a name='L35'></a><a href='#L35'>35</a>
101
+ <a name='L36'></a><a href='#L36'>36</a>
102
+ <a name='L37'></a><a href='#L37'>37</a>
103
+ <a name='L38'></a><a href='#L38'>38</a>
104
+ <a name='L39'></a><a href='#L39'>39</a>
105
+ <a name='L40'></a><a href='#L40'>40</a>
106
+ <a name='L41'></a><a href='#L41'>41</a>
107
+ <a name='L42'></a><a href='#L42'>42</a>
108
+ <a name='L43'></a><a href='#L43'>43</a>
109
+ <a name='L44'></a><a href='#L44'>44</a>
110
+ <a name='L45'></a><a href='#L45'>45</a>
111
+ <a name='L46'></a><a href='#L46'>46</a>
112
+ <a name='L47'></a><a href='#L47'>47</a>
113
+ <a name='L48'></a><a href='#L48'>48</a>
114
+ <a name='L49'></a><a href='#L49'>49</a>
115
+ <a name='L50'></a><a href='#L50'>50</a>
116
+ <a name='L51'></a><a href='#L51'>51</a>
117
+ <a name='L52'></a><a href='#L52'>52</a>
118
+ <a name='L53'></a><a href='#L53'>53</a>
119
+ <a name='L54'></a><a href='#L54'>54</a>
120
+ <a name='L55'></a><a href='#L55'>55</a>
121
+ <a name='L56'></a><a href='#L56'>56</a>
122
+ <a name='L57'></a><a href='#L57'>57</a>
123
+ <a name='L58'></a><a href='#L58'>58</a>
124
+ <a name='L59'></a><a href='#L59'>59</a>
125
+ <a name='L60'></a><a href='#L60'>60</a>
126
+ <a name='L61'></a><a href='#L61'>61</a>
127
+ <a name='L62'></a><a href='#L62'>62</a>
128
+ <a name='L63'></a><a href='#L63'>63</a>
129
+ <a name='L64'></a><a href='#L64'>64</a>
130
+ <a name='L65'></a><a href='#L65'>65</a>
131
+ <a name='L66'></a><a href='#L66'>66</a>
132
+ <a name='L67'></a><a href='#L67'>67</a>
133
+ <a name='L68'></a><a href='#L68'>68</a>
134
+ <a name='L69'></a><a href='#L69'>69</a>
135
+ <a name='L70'></a><a href='#L70'>70</a>
136
+ <a name='L71'></a><a href='#L71'>71</a>
137
+ <a name='L72'></a><a href='#L72'>72</a>
138
+ <a name='L73'></a><a href='#L73'>73</a>
139
+ <a name='L74'></a><a href='#L74'>74</a>
140
+ <a name='L75'></a><a href='#L75'>75</a>
141
+ <a name='L76'></a><a href='#L76'>76</a>
142
+ <a name='L77'></a><a href='#L77'>77</a>
143
+ <a name='L78'></a><a href='#L78'>78</a>
144
+ <a name='L79'></a><a href='#L79'>79</a>
145
+ <a name='L80'></a><a href='#L80'>80</a>
146
+ <a name='L81'></a><a href='#L81'>81</a>
147
+ <a name='L82'></a><a href='#L82'>82</a>
148
+ <a name='L83'></a><a href='#L83'>83</a>
149
+ <a name='L84'></a><a href='#L84'>84</a></td><td class="line-coverage quiet"><span class="cline-any cline-no">&nbsp;</span>
150
+ <span class="cline-any cline-no">&nbsp;</span>
151
+ <span class="cline-any cline-no">&nbsp;</span>
152
+ <span class="cline-any cline-neutral">&nbsp;</span>
153
+ <span class="cline-any cline-neutral">&nbsp;</span>
154
+ <span class="cline-any cline-neutral">&nbsp;</span>
155
+ <span class="cline-any cline-neutral">&nbsp;</span>
156
+ <span class="cline-any cline-neutral">&nbsp;</span>
157
+ <span class="cline-any cline-neutral">&nbsp;</span>
158
+ <span class="cline-any cline-neutral">&nbsp;</span>
159
+ <span class="cline-any cline-neutral">&nbsp;</span>
160
+ <span class="cline-any cline-neutral">&nbsp;</span>
161
+ <span class="cline-any cline-neutral">&nbsp;</span>
162
+ <span class="cline-any cline-neutral">&nbsp;</span>
163
+ <span class="cline-any cline-neutral">&nbsp;</span>
164
+ <span class="cline-any cline-neutral">&nbsp;</span>
165
+ <span class="cline-any cline-neutral">&nbsp;</span>
166
+ <span class="cline-any cline-neutral">&nbsp;</span>
167
+ <span class="cline-any cline-no">&nbsp;</span>
168
+ <span class="cline-any cline-neutral">&nbsp;</span>
169
+ <span class="cline-any cline-no">&nbsp;</span>
170
+ <span class="cline-any cline-no">&nbsp;</span>
171
+ <span class="cline-any cline-no">&nbsp;</span>
172
+ <span class="cline-any cline-neutral">&nbsp;</span>
173
+ <span class="cline-any cline-no">&nbsp;</span>
174
+ <span class="cline-any cline-no">&nbsp;</span>
175
+ <span class="cline-any cline-no">&nbsp;</span>
176
+ <span class="cline-any cline-neutral">&nbsp;</span>
177
+ <span class="cline-any cline-no">&nbsp;</span>
178
+ <span class="cline-any cline-no">&nbsp;</span>
179
+ <span class="cline-any cline-no">&nbsp;</span>
180
+ <span class="cline-any cline-no">&nbsp;</span>
181
+ <span class="cline-any cline-no">&nbsp;</span>
182
+ <span class="cline-any cline-no">&nbsp;</span>
183
+ <span class="cline-any cline-no">&nbsp;</span>
184
+ <span class="cline-any cline-no">&nbsp;</span>
185
+ <span class="cline-any cline-neutral">&nbsp;</span>
186
+ <span class="cline-any cline-no">&nbsp;</span>
187
+ <span class="cline-any cline-no">&nbsp;</span>
188
+ <span class="cline-any cline-no">&nbsp;</span>
189
+ <span class="cline-any cline-neutral">&nbsp;</span>
190
+ <span class="cline-any cline-no">&nbsp;</span>
191
+ <span class="cline-any cline-no">&nbsp;</span>
192
+ <span class="cline-any cline-no">&nbsp;</span>
193
+ <span class="cline-any cline-no">&nbsp;</span>
194
+ <span class="cline-any cline-no">&nbsp;</span>
195
+ <span class="cline-any cline-neutral">&nbsp;</span>
196
+ <span class="cline-any cline-no">&nbsp;</span>
197
+ <span class="cline-any cline-no">&nbsp;</span>
198
+ <span class="cline-any cline-no">&nbsp;</span>
199
+ <span class="cline-any cline-no">&nbsp;</span>
200
+ <span class="cline-any cline-no">&nbsp;</span>
201
+ <span class="cline-any cline-no">&nbsp;</span>
202
+ <span class="cline-any cline-no">&nbsp;</span>
203
+ <span class="cline-any cline-no">&nbsp;</span>
204
+ <span class="cline-any cline-no">&nbsp;</span>
205
+ <span class="cline-any cline-neutral">&nbsp;</span>
206
+ <span class="cline-any cline-no">&nbsp;</span>
207
+ <span class="cline-any cline-neutral">&nbsp;</span>
208
+ <span class="cline-any cline-no">&nbsp;</span>
209
+ <span class="cline-any cline-no">&nbsp;</span>
210
+ <span class="cline-any cline-no">&nbsp;</span>
211
+ <span class="cline-any cline-no">&nbsp;</span>
212
+ <span class="cline-any cline-no">&nbsp;</span>
213
+ <span class="cline-any cline-no">&nbsp;</span>
214
+ <span class="cline-any cline-no">&nbsp;</span>
215
+ <span class="cline-any cline-no">&nbsp;</span>
216
+ <span class="cline-any cline-no">&nbsp;</span>
217
+ <span class="cline-any cline-no">&nbsp;</span>
218
+ <span class="cline-any cline-no">&nbsp;</span>
219
+ <span class="cline-any cline-no">&nbsp;</span>
220
+ <span class="cline-any cline-no">&nbsp;</span>
221
+ <span class="cline-any cline-no">&nbsp;</span>
222
+ <span class="cline-any cline-no">&nbsp;</span>
223
+ <span class="cline-any cline-no">&nbsp;</span>
224
+ <span class="cline-any cline-no">&nbsp;</span>
225
+ <span class="cline-any cline-neutral">&nbsp;</span>
226
+ <span class="cline-any cline-no">&nbsp;</span>
227
+ <span class="cline-any cline-no">&nbsp;</span>
228
+ <span class="cline-any cline-no">&nbsp;</span>
229
+ <span class="cline-any cline-no">&nbsp;</span>
230
+ <span class="cline-any cline-no">&nbsp;</span>
231
+ <span class="cline-any cline-no">&nbsp;</span>
232
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js"><span class="cstat-no" title="statement not covered" >import { LogLevel, ProsopoCliError, getLogger } from "@prosopo/common";<span class="fstat-no" title="function not covered" ><span class="branch-0 cbranch-no" title="branch not covered" ></span></span></span>
233
+ <span class="cstat-no" title="statement not covered" >import yargs, { type Argv } from "yargs";</span>
234
+ <span class="cstat-no" title="statement not covered" >import { hideBin } from "yargs/helpers";</span>
235
+ // Copyright 2021-2025 Prosopo (UK) Ltd.
236
+ //
237
+ // Licensed under the Apache License, Version 2.0 (the "License");
238
+ // you may not use this file except in compliance with the License.
239
+ // You may obtain a copy of the License at
240
+ //
241
+ // http://www.apache.org/licenses/LICENSE-2.0
242
+ //
243
+ // Unless required by applicable law or agreed to in writing, software
244
+ // distributed under the License is distributed on an "AS IS" BASIS,
245
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
246
+ // See the License for the specific language governing permissions and
247
+ // limitations under the License.
248
+ import type { CliCommandAny } from "./cliCommand.js";
249
+ &nbsp;
250
+ <span class="cstat-no" title="statement not covered" >const dirname = process.cwd();</span>
251
+ &nbsp;
252
+ <span class="cstat-no" title="statement not covered" >export class Cli {</span>
253
+ <span class="cstat-no" title="statement not covered" > #commands: CliCommandAny[];</span>
254
+ <span class="cstat-no" title="statement not covered" > logger = getLogger("info", import.meta.url);</span>
255
+ &nbsp;
256
+ <span class="cstat-no" title="statement not covered" > constructor(commands: CliCommandAny[]) {</span>
257
+ <span class="cstat-no" title="statement not covered" > this.#commands = commands;</span>
258
+ <span class="cstat-no" title="statement not covered" > }</span>
259
+ &nbsp;
260
+ <span class="cstat-no" title="statement not covered" > private config() {</span>
261
+ <span class="cstat-no" title="statement not covered" > let y = yargs(hideBin(process.argv))</span>
262
+ <span class="cstat-no" title="statement not covered" > .option("log-level", {</span>
263
+ <span class="cstat-no" title="statement not covered" > type: "string",</span>
264
+ <span class="cstat-no" title="statement not covered" > choices: Object.values(LogLevel.options),</span>
265
+ <span class="cstat-no" title="statement not covered" > default: LogLevel.enum.info,</span>
266
+ <span class="cstat-no" title="statement not covered" > description: "The log level",</span>
267
+ <span class="cstat-no" title="statement not covered" > })</span>
268
+ // biome-ignore lint/suspicious/noExplicitAny: TODO fix
269
+ <span class="cstat-no" title="statement not covered" > .middleware((argv: any) =&gt; {</span>
270
+ <span class="cstat-no" title="statement not covered" > this.logger.setLogLevel(argv.logLevel);</span>
271
+ <span class="cstat-no" title="statement not covered" > }, true);</span>
272
+ &nbsp;
273
+ <span class="cstat-no" title="statement not covered" > for (const command of this.#commands) {</span>
274
+ <span class="cstat-no" title="statement not covered" > y = y.command({</span>
275
+ <span class="cstat-no" title="statement not covered" > command: command.getCommandName(),</span>
276
+ <span class="cstat-no" title="statement not covered" > describe: command.getDescription(),</span>
277
+ <span class="cstat-no" title="statement not covered" > builder: command.getOptions(),</span>
278
+ // biome-ignore lint/suspicious/noExplicitAny: TODO fix
279
+ <span class="cstat-no" title="statement not covered" > handler: async (argv: any) =&gt; {</span>
280
+ <span class="cstat-no" title="statement not covered" > this.logger.debug(() =&gt; ({</span>
281
+ <span class="cstat-no" title="statement not covered" > msg: `running ${command.getCommandName()}`,</span>
282
+ <span class="cstat-no" title="statement not covered" > }));</span>
283
+ <span class="cstat-no" title="statement not covered" > const args = await command.parse(argv);</span>
284
+ <span class="cstat-no" title="statement not covered" > await command.exec(args);</span>
285
+ <span class="cstat-no" title="statement not covered" > },</span>
286
+ <span class="cstat-no" title="statement not covered" > });</span>
287
+ <span class="cstat-no" title="statement not covered" > }</span>
288
+ &nbsp;
289
+ <span class="cstat-no" title="statement not covered" > if (!this.#commands.find((c) =&gt; c.getCommandName() === "$0")) {</span>
290
+ // no default command
291
+ <span class="cstat-no" title="statement not covered" > y = y.command(</span>
292
+ <span class="cstat-no" title="statement not covered" > "$0",</span>
293
+ <span class="cstat-no" title="statement not covered" > "default command",</span>
294
+ <span class="cstat-no" title="statement not covered" > (y: Argv) =&gt; y,</span>
295
+ <span class="cstat-no" title="statement not covered" > () =&gt; {</span>
296
+ <span class="cstat-no" title="statement not covered" > throw new ProsopoCliError("CLI.PARAMETER_ERROR", {</span>
297
+ <span class="cstat-no" title="statement not covered" > context: { error: "no command specified" },</span>
298
+ <span class="cstat-no" title="statement not covered" > });</span>
299
+ <span class="cstat-no" title="statement not covered" > },</span>
300
+ <span class="cstat-no" title="statement not covered" > );</span>
301
+ <span class="cstat-no" title="statement not covered" > }</span>
302
+ <span class="cstat-no" title="statement not covered" > y = y</span>
303
+ <span class="cstat-no" title="statement not covered" > .demandCommand()</span>
304
+ <span class="cstat-no" title="statement not covered" > .strict()</span>
305
+ <span class="cstat-no" title="statement not covered" > .showHelpOnFail(false, "Specify --help for available options");</span>
306
+ <span class="cstat-no" title="statement not covered" > return y;</span>
307
+ <span class="cstat-no" title="statement not covered" > }</span>
308
+ &nbsp;
309
+ <span class="cstat-no" title="statement not covered" > public async exec(args: string[] = process.argv.slice(2)) {</span>
310
+ <span class="cstat-no" title="statement not covered" > const config = this.config();</span>
311
+ <span class="cstat-no" title="statement not covered" > this.logger.debug(() =&gt; ({ data: { args }, msg: "parsing" }));</span>
312
+ <span class="cstat-no" title="statement not covered" > await config.parse(args);</span>
313
+ <span class="cstat-no" title="statement not covered" > }</span>
314
+ <span class="cstat-no" title="statement not covered" >}</span>
315
+ &nbsp;</pre></td></tr></table></pre>
316
+
317
+ <div class='push'></div><!-- for sticky footer -->
318
+ </div><!-- /wrapper -->
319
+ <div class='footer quiet pad2 space-top1 center small'>
320
+ Code coverage generated by
321
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
322
+ at 2025-09-08T13:12:46.532Z
323
+ </div>
324
+ <script src="../../prettify.js"></script>
325
+ <script>
326
+ window.onload = function () {
327
+ prettyPrint();
328
+ };
329
+ </script>
330
+ <script src="../../sorter.js"></script>
331
+ <script src="../../block-navigation.js"></script>
332
+ </body>
333
+ </html>
334
+
package/coverage/src/cli/cliCommand.ts.html ADDED
@@ -0,0 +1,289 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/cli/cliCommand.ts</title>
7
+ <meta charset="utf-8" />
8
+ <link rel="stylesheet" href="../../prettify.css" />
9
+ <link rel="stylesheet" href="../../base.css" />
10
+ <link rel="shortcut icon" type="image/x-icon" href="../../favicon.png" />
11
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
12
+ <style type='text/css'>
13
+ .coverage-summary .sorter {
14
+ background-image: url(../../sort-arrow-sprite.png);
15
+ }
16
+ </style>
17
+ </head>
18
+
19
+ <body>
20
+ <div class='wrapper'>
21
+ <div class='pad1'>
22
+ <h1><a href="../../index.html">All files</a> / <a href="index.html">src/cli</a> cliCommand.ts</h1>
23
+ <div class='clearfix'>
24
+
25
+ <div class='fl pad1y space-right2'>
26
+ <span class="strong">65.51% </span>
27
+ <span class="quiet">Statements</span>
28
+ <span class='fraction'>19/29</span>
29
+ </div>
30
+
31
+
32
+ <div class='fl pad1y space-right2'>
33
+ <span class="strong">100% </span>
34
+ <span class="quiet">Branches</span>
35
+ <span class='fraction'>4/4</span>
36
+ </div>
37
+
38
+
39
+ <div class='fl pad1y space-right2'>
40
+ <span class="strong">57.14% </span>
41
+ <span class="quiet">Functions</span>
42
+ <span class='fraction'>4/7</span>
43
+ </div>
44
+
45
+
46
+ <div class='fl pad1y space-right2'>
47
+ <span class="strong">65.51% </span>
48
+ <span class="quiet">Lines</span>
49
+ <span class='fraction'>19/29</span>
50
+ </div>
51
+
52
+
53
+ </div>
54
+ <p class="quiet">
55
+ Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
+ </p>
57
+ <template id="filterTemplate">
58
+ <div class="quiet">
59
+ Filter:
60
+ <input type="search" id="fileSearch">
61
+ </div>
62
+ </template>
63
+ </div>
64
+ <div class='status-line medium'></div>
65
+ <pre><table class="coverage">
66
+ <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
+ <a name='L2'></a><a href='#L2'>2</a>
68
+ <a name='L3'></a><a href='#L3'>3</a>
69
+ <a name='L4'></a><a href='#L4'>4</a>
70
+ <a name='L5'></a><a href='#L5'>5</a>
71
+ <a name='L6'></a><a href='#L6'>6</a>
72
+ <a name='L7'></a><a href='#L7'>7</a>
73
+ <a name='L8'></a><a href='#L8'>8</a>
74
+ <a name='L9'></a><a href='#L9'>9</a>
75
+ <a name='L10'></a><a href='#L10'>10</a>
76
+ <a name='L11'></a><a href='#L11'>11</a>
77
+ <a name='L12'></a><a href='#L12'>12</a>
78
+ <a name='L13'></a><a href='#L13'>13</a>
79
+ <a name='L14'></a><a href='#L14'>14</a>
80
+ <a name='L15'></a><a href='#L15'>15</a>
81
+ <a name='L16'></a><a href='#L16'>16</a>
82
+ <a name='L17'></a><a href='#L17'>17</a>
83
+ <a name='L18'></a><a href='#L18'>18</a>
84
+ <a name='L19'></a><a href='#L19'>19</a>
85
+ <a name='L20'></a><a href='#L20'>20</a>
86
+ <a name='L21'></a><a href='#L21'>21</a>
87
+ <a name='L22'></a><a href='#L22'>22</a>
88
+ <a name='L23'></a><a href='#L23'>23</a>
89
+ <a name='L24'></a><a href='#L24'>24</a>
90
+ <a name='L25'></a><a href='#L25'>25</a>
91
+ <a name='L26'></a><a href='#L26'>26</a>
92
+ <a name='L27'></a><a href='#L27'>27</a>
93
+ <a name='L28'></a><a href='#L28'>28</a>
94
+ <a name='L29'></a><a href='#L29'>29</a>
95
+ <a name='L30'></a><a href='#L30'>30</a>
96
+ <a name='L31'></a><a href='#L31'>31</a>
97
+ <a name='L32'></a><a href='#L32'>32</a>
98
+ <a name='L33'></a><a href='#L33'>33</a>
99
+ <a name='L34'></a><a href='#L34'>34</a>
100
+ <a name='L35'></a><a href='#L35'>35</a>
101
+ <a name='L36'></a><a href='#L36'>36</a>
102
+ <a name='L37'></a><a href='#L37'>37</a>
103
+ <a name='L38'></a><a href='#L38'>38</a>
104
+ <a name='L39'></a><a href='#L39'>39</a>
105
+ <a name='L40'></a><a href='#L40'>40</a>
106
+ <a name='L41'></a><a href='#L41'>41</a>
107
+ <a name='L42'></a><a href='#L42'>42</a>
108
+ <a name='L43'></a><a href='#L43'>43</a>
109
+ <a name='L44'></a><a href='#L44'>44</a>
110
+ <a name='L45'></a><a href='#L45'>45</a>
111
+ <a name='L46'></a><a href='#L46'>46</a>
112
+ <a name='L47'></a><a href='#L47'>47</a>
113
+ <a name='L48'></a><a href='#L48'>48</a>
114
+ <a name='L49'></a><a href='#L49'>49</a>
115
+ <a name='L50'></a><a href='#L50'>50</a>
116
+ <a name='L51'></a><a href='#L51'>51</a>
117
+ <a name='L52'></a><a href='#L52'>52</a>
118
+ <a name='L53'></a><a href='#L53'>53</a>
119
+ <a name='L54'></a><a href='#L54'>54</a>
120
+ <a name='L55'></a><a href='#L55'>55</a>
121
+ <a name='L56'></a><a href='#L56'>56</a>
122
+ <a name='L57'></a><a href='#L57'>57</a>
123
+ <a name='L58'></a><a href='#L58'>58</a>
124
+ <a name='L59'></a><a href='#L59'>59</a>
125
+ <a name='L60'></a><a href='#L60'>60</a>
126
+ <a name='L61'></a><a href='#L61'>61</a>
127
+ <a name='L62'></a><a href='#L62'>62</a>
128
+ <a name='L63'></a><a href='#L63'>63</a>
129
+ <a name='L64'></a><a href='#L64'>64</a>
130
+ <a name='L65'></a><a href='#L65'>65</a>
131
+ <a name='L66'></a><a href='#L66'>66</a>
132
+ <a name='L67'></a><a href='#L67'>67</a>
133
+ <a name='L68'></a><a href='#L68'>68</a>
134
+ <a name='L69'></a><a href='#L69'>69</a></td><td class="line-coverage quiet"><span class="cline-any cline-neutral">&nbsp;</span>
135
+ <span class="cline-any cline-neutral">&nbsp;</span>
136
+ <span class="cline-any cline-neutral">&nbsp;</span>
137
+ <span class="cline-any cline-neutral">&nbsp;</span>
138
+ <span class="cline-any cline-neutral">&nbsp;</span>
139
+ <span class="cline-any cline-neutral">&nbsp;</span>
140
+ <span class="cline-any cline-neutral">&nbsp;</span>
141
+ <span class="cline-any cline-neutral">&nbsp;</span>
142
+ <span class="cline-any cline-neutral">&nbsp;</span>
143
+ <span class="cline-any cline-neutral">&nbsp;</span>
144
+ <span class="cline-any cline-neutral">&nbsp;</span>
145
+ <span class="cline-any cline-neutral">&nbsp;</span>
146
+ <span class="cline-any cline-neutral">&nbsp;</span>
147
+ <span class="cline-any cline-neutral">&nbsp;</span>
148
+ <span class="cline-any cline-yes">1x</span>
149
+ <span class="cline-any cline-yes">1x</span>
150
+ <span class="cline-any cline-neutral">&nbsp;</span>
151
+ <span class="cline-any cline-neutral">&nbsp;</span>
152
+ <span class="cline-any cline-neutral">&nbsp;</span>
153
+ <span class="cline-any cline-yes">1x</span>
154
+ <span class="cline-any cline-yes">14x</span>
155
+ <span class="cline-any cline-neutral">&nbsp;</span>
156
+ <span class="cline-any cline-neutral">&nbsp;</span>
157
+ <span class="cline-any cline-yes">1x</span>
158
+ <span class="cline-any cline-neutral">&nbsp;</span>
159
+ <span class="cline-any cline-no">&nbsp;</span>
160
+ <span class="cline-any cline-no">&nbsp;</span>
161
+ <span class="cline-any cline-no">&nbsp;</span>
162
+ <span class="cline-any cline-neutral">&nbsp;</span>
163
+ <span class="cline-any cline-neutral">&nbsp;</span>
164
+ <span class="cline-any cline-neutral">&nbsp;</span>
165
+ <span class="cline-any cline-neutral">&nbsp;</span>
166
+ <span class="cline-any cline-neutral">&nbsp;</span>
167
+ <span class="cline-any cline-neutral">&nbsp;</span>
168
+ <span class="cline-any cline-yes">1x</span>
169
+ <span class="cline-any cline-no">&nbsp;</span>
170
+ <span class="cline-any cline-no">&nbsp;</span>
171
+ <span class="cline-any cline-no">&nbsp;</span>
172
+ <span class="cline-any cline-no">&nbsp;</span>
173
+ <span class="cline-any cline-no">&nbsp;</span>
174
+ <span class="cline-any cline-neutral">&nbsp;</span>
175
+ <span class="cline-any cline-neutral">&nbsp;</span>
176
+ <span class="cline-any cline-yes">1x</span>
177
+ <span class="cline-any cline-yes">8x</span>
178
+ <span class="cline-any cline-yes">8x</span>
179
+ <span class="cline-any cline-neutral">&nbsp;</span>
180
+ <span class="cline-any cline-neutral">&nbsp;</span>
181
+ <span class="cline-any cline-yes">1x</span>
182
+ <span class="cline-any cline-yes">10x</span>
183
+ <span class="cline-any cline-yes">10x</span>
184
+ <span class="cline-any cline-neutral">&nbsp;</span>
185
+ <span class="cline-any cline-neutral">&nbsp;</span>
186
+ <span class="cline-any cline-yes">1x</span>
187
+ <span class="cline-any cline-yes">6x</span>
188
+ <span class="cline-any cline-neutral">&nbsp;</span>
189
+ <span class="cline-any cline-yes">6x</span>
190
+ <span class="cline-any cline-neutral">&nbsp;</span>
191
+ <span class="cline-any cline-yes">6x</span>
192
+ <span class="cline-any cline-yes">6x</span>
193
+ <span class="cline-any cline-neutral">&nbsp;</span>
194
+ <span class="cline-any cline-yes">1x</span>
195
+ <span class="cline-any cline-no">&nbsp;</span>
196
+ <span class="cline-any cline-no">&nbsp;</span>
197
+ <span class="cline-any cline-neutral">&nbsp;</span>
198
+ <span class="cline-any cline-neutral">&nbsp;</span>
199
+ <span class="cline-any cline-yes">1x</span>
200
+ <span class="cline-any cline-neutral">&nbsp;</span>
201
+ <span class="cline-any cline-neutral">&nbsp;</span>
202
+ <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">// Copyright 2021-2025 Prosopo (UK) Ltd.
203
+ //
204
+ // Licensed under the Apache License, Version 2.0 (the "License");
205
+ // you may not use this file except in compliance with the License.
206
+ // You may obtain a copy of the License at
207
+ //
208
+ // http://www.apache.org/licenses/LICENSE-2.0
209
+ //
210
+ // Unless required by applicable law or agreed to in writing, software
211
+ // distributed under the License is distributed on an "AS IS" BASIS,
212
+ // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
213
+ // See the License for the specific language governing permissions and
214
+ // limitations under the License.
215
+ &nbsp;
216
+ import { getLogger } from "@prosopo/common";
217
+ import { kebabCase } from "@prosopo/util";
218
+ import type { Options } from "yargs";
219
+ import type * as z from "zod";
220
+ &nbsp;
221
+ export abstract class CliCommand&lt;T extends z.ZodTypeAny&gt; {
222
+ logger = getLogger("info", import.meta.url);
223
+ &nbsp;
224
+ // get the options for the CLI
225
+ public <span class="fstat-no" title="function not covered" >getOptions(): {</span>
226
+ [key: string]: Options;
227
+ <span class="cstat-no" title="statement not covered" > } {</span>
228
+ <span class="cstat-no" title="statement not covered" > return {};</span>
229
+ <span class="cstat-no" title="statement not covered" > }</span>
230
+ &nbsp;
231
+ // get the schema for the args to this command
232
+ public abstract getArgSchema(): T;
233
+ &nbsp;
234
+ // parse args using the schema
235
+ // use this when you have an args object but not sure if it's in the right format / contains the correct fields, e.g. args from cmdline
236
+ <span class="fstat-no" title="function not covered" > public async parse(args: unknown): Promise&lt;z.infer&lt;T&gt;&gt; {</span>
237
+ <span class="cstat-no" title="statement not covered" > const argsSchema = this.getArgSchema();</span>
238
+ <span class="cstat-no" title="statement not covered" > const parsed = await argsSchema.parse(args);</span>
239
+ <span class="cstat-no" title="statement not covered" > this.logger.debug(() =&gt; ({ data: { parsed }, msg: "parsed args:" }));</span>
240
+ <span class="cstat-no" title="statement not covered" > return parsed;</span>
241
+ <span class="cstat-no" title="statement not covered" > }</span>
242
+ &nbsp;
243
+ // run any checks before the main run function. This function should have no side effects, i.e. not write to disk. It's purely for conducting checks / setting up
244
+ public async _check(args: z.infer&lt;T&gt;) {
245
+ this.logger.debug(() =&gt; ({ msg: "runChecks", args }));
246
+ }
247
+ &nbsp;
248
+ // the main run function. This should be the function that does the work
249
+ public async _run(args: z.infer&lt;T&gt;) {
250
+ this.logger.debug(() =&gt; ({ msg: "run", args }));
251
+ }
252
+ &nbsp;
253
+ // exec is a public facing function that should be called by the CLI. It will run the preRun, run, and postRun functions in order
254
+ public async exec(args: z.infer&lt;T&gt;) {
255
+ this.logger.debug(() =&gt; ({ msg: "exec", args }));
256
+ // run any checks
257
+ await this._check(args);
258
+ // then run the command
259
+ await this._run(args);
260
+ }
261
+ &nbsp;
262
+ public <span class="fstat-no" title="function not covered" >getCommandName() {</span>
263
+ <span class="cstat-no" title="statement not covered" > return kebabCase(this.constructor.name);</span>
264
+ <span class="cstat-no" title="statement not covered" > }</span>
265
+ &nbsp;
266
+ public abstract getDescription(): string;
267
+ }
268
+ &nbsp;
269
+ export type CliCommandAny = CliCommand&lt;z.ZodTypeAny&gt;;
270
+ &nbsp;</pre></td></tr></table></pre>
271
+
272
+ <div class='push'></div><!-- for sticky footer -->
273
+ </div><!-- /wrapper -->
274
+ <div class='footer quiet pad2 space-top1 center small'>
275
+ Code coverage generated by
276
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
277
+ at 2025-09-08T13:12:46.532Z
278
+ </div>
279
+ <script src="../../prettify.js"></script>
280
+ <script>
281
+ window.onload = function () {
282
+ prettyPrint();
283
+ };
284
+ </script>
285
+ <script src="../../sorter.js"></script>
286
+ <script src="../../block-navigation.js"></script>
287
+ </body>
288
+ </html>
289
+