javadoc

<!doctype html> <html lang="en"> <head> <title>Code coverage report for javadoc.js</title> <meta charset="utf-8" /> <link rel="stylesheet" href="prettify.css" /> <link rel="stylesheet" href="base.css" /> <link rel="shortcut icon" type="image/x-icon" href="favicon.png" /> <meta name="viewport" content="width=device-width, initial-scale=1" /> <style type='text/css'> .coverage-summary .sorter { background-image: url(sort-arrow-sprite.png); } </style> </head> <body> <div class='wrapper'> <div class='pad1'> <h1><a href="index.html">All files</a> javadoc.js</h1> <div class='clearfix'> <div class='fl pad1y space-right2'> 91.1% Statements 133/146 </div> <div class='fl pad1y space-right2'> 74.42% Branches 32/43 </div> <div class='fl pad1y space-right2'> 92.86% Functions 26/28 </div> <div class='fl pad1y space-right2'> 90.71% Lines 127/140 </div> </div> Press n or j to go to the next uncovered block, b, p or k for the previous block. </div> <div class='status-line high'></div> <pre><table class="coverage"> <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a> <a name='L2'></a><a href='#L2'>2</a> <a name='L3'></a><a href='#L3'>3</a> <a name='L4'></a><a href='#L4'>4</a> <a name='L5'></a><a href='#L5'>5</a> <a name='L6'></a><a href='#L6'>6</a> <a name='L7'></a><a href='#L7'>7</a> <a name='L8'></a><a href='#L8'>8</a> <a name='L9'></a><a href='#L9'>9</a> <a name='L10'></a><a href='#L10'>10</a> <a name='L11'></a><a href='#L11'>11</a> <a name='L12'></a><a href='#L12'>12</a> <a name='L13'></a><a href='#L13'>13</a> <a name='L14'></a><a href='#L14'>14</a> <a name='L15'></a><a href='#L15'>15</a> <a name='L16'></a><a href='#L16'>16</a> <a name='L17'></a><a href='#L17'>17</a> <a name='L18'></a><a href='#L18'>18</a> <a name='L19'></a><a href='#L19'>19</a> <a name='L20'></a><a href='#L20'>20</a> <a name='L21'></a><a href='#L21'>21</a> <a name='L22'></a><a href='#L22'>22</a> <a name='L23'></a><a href='#L23'>23</a> <a name='L24'></a><a href='#L24'>24</a> <a name='L25'></a><a href='#L25'>25</a> <a name='L26'></a><a href='#L26'>26</a> <a name='L27'></a><a href='#L27'>27</a> <a name='L28'></a><a href='#L28'>28</a> <a name='L29'></a><a href='#L29'>29</a> <a name='L30'></a><a href='#L30'>30</a> <a name='L31'></a><a href='#L31'>31</a> <a name='L32'></a><a href='#L32'>32</a> <a name='L33'></a><a href='#L33'>33</a> <a name='L34'></a><a href='#L34'>34</a> <a name='L35'></a><a href='#L35'>35</a> <a name='L36'></a><a href='#L36'>36</a> <a name='L37'></a><a href='#L37'>37</a> <a name='L38'></a><a href='#L38'>38</a> <a name='L39'></a><a href='#L39'>39</a> <a name='L40'></a><a href='#L40'>40</a> <a name='L41'></a><a href='#L41'>41</a> <a name='L42'></a><a href='#L42'>42</a> <a name='L43'></a><a href='#L43'>43</a> <a name='L44'></a><a href='#L44'>44</a> <a name='L45'></a><a href='#L45'>45</a> <a name='L46'></a><a href='#L46'>46</a> <a name='L47'></a><a href='#L47'>47</a> <a name='L48'></a><a href='#L48'>48</a> <a name='L49'></a><a href='#L49'>49</a> <a name='L50'></a><a href='#L50'>50</a> <a name='L51'></a><a href='#L51'>51</a> <a name='L52'></a><a href='#L52'>52</a> <a name='L53'></a><a href='#L53'>53</a> <a name='L54'></a><a href='#L54'>54</a> <a name='L55'></a><a href='#L55'>55</a> <a name='L56'></a><a href='#L56'>56</a> <a name='L57'></a><a href='#L57'>57</a> <a name='L58'></a><a href='#L58'>58</a> <a name='L59'></a><a href='#L59'>59</a> <a name='L60'></a><a href='#L60'>60</a> <a name='L61'></a><a href='#L61'>61</a> <a name='L62'></a><a href='#L62'>62</a> <a name='L63'></a><a href='#L63'>63</a> <a name='L64'></a><a href='#L64'>64</a> <a name='L65'></a><a href='#L65'>65</a> <a name='L66'></a><a href='#L66'>66</a> <a name='L67'></a><a href='#L67'>67</a> <a name='L68'></a><a href='#L68'>68</a> <a name='L69'></a><a href='#L69'>69</a> <a name='L70'></a><a href='#L70'>70</a> <a name='L71'></a><a href='#L71'>71</a> <a name='L72'></a><a href='#L72'>72</a> <a name='L73'></a><a href='#L73'>73</a> <a name='L74'></a><a href='#L74'>74</a> <a name='L75'></a><a href='#L75'>75</a> <a name='L76'></a><a href='#L76'>76</a> <a name='L77'></a><a href='#L77'>77</a> <a name='L78'></a><a href='#L78'>78</a> <a name='L79'></a><a href='#L79'>79</a> <a name='L80'></a><a href='#L80'>80</a> <a name='L81'></a><a href='#L81'>81</a> <a name='L82'></a><a href='#L82'>82</a> <a name='L83'></a><a href='#L83'>83</a> <a name='L84'></a><a href='#L84'>84</a> <a name='L85'></a><a href='#L85'>85</a> <a name='L86'></a><a href='#L86'>86</a> <a name='L87'></a><a href='#L87'>87</a> <a name='L88'></a><a href='#L88'>88</a> <a name='L89'></a><a href='#L89'>89</a> <a name='L90'></a><a href='#L90'>90</a> <a name='L91'></a><a href='#L91'>91</a> <a name='L92'></a><a href='#L92'>92</a> <a name='L93'></a><a href='#L93'>93</a> <a name='L94'></a><a href='#L94'>94</a> <a name='L95'></a><a href='#L95'>95</a> <a name='L96'></a><a href='#L96'>96</a> <a name='L97'></a><a href='#L97'>97</a> <a name='L98'></a><a href='#L98'>98</a> <a name='L99'></a><a href='#L99'>99</a> <a name='L100'></a><a href='#L100'>100</a> <a name='L101'></a><a href='#L101'>101</a> <a name='L102'></a><a href='#L102'>102</a> <a name='L103'></a><a href='#L103'>103</a> <a name='L104'></a><a href='#L104'>104</a> <a name='L105'></a><a href='#L105'>105</a> <a name='L106'></a><a href='#L106'>106</a> <a name='L107'></a><a href='#L107'>107</a> <a name='L108'></a><a href='#L108'>108</a> <a name='L109'></a><a href='#L109'>109</a> <a name='L110'></a><a href='#L110'>110</a> <a name='L111'></a><a href='#L111'>111</a> <a name='L112'></a><a href='#L112'>112</a> <a name='L113'></a><a href='#L113'>113</a> <a name='L114'></a><a href='#L114'>114</a> <a name='L115'></a><a href='#L115'>115</a> <a name='L116'></a><a href='#L116'>116</a> <a name='L117'></a><a href='#L117'>117</a> <a name='L118'></a><a href='#L118'>118</a> <a name='L119'></a><a href='#L119'>119</a> <a name='L120'></a><a href='#L120'>120</a> <a name='L121'></a><a href='#L121'>121</a> <a name='L122'></a><a href='#L122'>122</a> <a name='L123'></a><a href='#L123'>123</a> <a name='L124'></a><a href='#L124'>124</a> <a name='L125'></a><a href='#L125'>125</a> <a name='L126'></a><a href='#L126'>126</a> <a name='L127'></a><a href='#L127'>127</a> <a name='L128'></a><a href='#L128'>128</a> <a name='L129'></a><a href='#L129'>129</a> <a name='L130'></a><a href='#L130'>130</a> <a name='L131'></a><a href='#L131'>131</a> <a name='L132'></a><a href='#L132'>132</a> <a name='L133'></a><a href='#L133'>133</a> <a name='L134'></a><a href='#L134'>134</a> <a name='L135'></a><a href='#L135'>135</a> <a name='L136'></a><a href='#L136'>136</a> <a name='L137'></a><a href='#L137'>137</a> <a name='L138'></a><a href='#L138'>138</a> <a name='L139'></a><a href='#L139'>139</a> <a name='L140'></a><a href='#L140'>140</a> <a name='L141'></a><a href='#L141'>141</a> <a name='L142'></a><a href='#L142'>142</a> <a name='L143'></a><a href='#L143'>143</a> <a name='L144'></a><a href='#L144'>144</a> <a name='L145'></a><a href='#L145'>145</a> <a name='L146'></a><a href='#L146'>146</a> <a name='L147'></a><a href='#L147'>147</a> <a name='L148'></a><a href='#L148'>148</a> <a name='L149'></a><a href='#L149'>149</a> <a name='L150'></a><a href='#L150'>150</a> <a name='L151'></a><a href='#L151'>151</a> <a name='L152'></a><a href='#L152'>152</a> <a name='L153'></a><a href='#L153'>153</a> <a name='L154'></a><a href='#L154'>154</a> <a name='L155'></a><a href='#L155'>155</a> <a name='L156'></a><a href='#L156'>156</a> <a name='L157'></a><a href='#L157'>157</a> <a name='L158'></a><a href='#L158'>158</a> <a name='L159'></a><a href='#L159'>159</a> <a name='L160'></a><a href='#L160'>160</a> <a name='L161'></a><a href='#L161'>161</a> <a name='L162'></a><a href='#L162'>162</a> <a name='L163'></a><a href='#L163'>163</a> <a name='L164'></a><a href='#L164'>164</a> <a name='L165'></a><a href='#L165'>165</a> <a name='L166'></a><a href='#L166'>166</a> <a name='L167'></a><a href='#L167'>167</a> <a name='L168'></a><a href='#L168'>168</a> <a name='L169'></a><a href='#L169'>169</a> <a name='L170'></a><a href='#L170'>170</a> <a name='L171'></a><a href='#L171'>171</a> <a name='L172'></a><a href='#L172'>172</a> <a name='L173'></a><a href='#L173'>173</a> <a name='L174'></a><a href='#L174'>174</a> <a name='L175'></a><a href='#L175'>175</a> <a name='L176'></a><a href='#L176'>176</a> <a name='L177'></a><a href='#L177'>177</a> <a name='L178'></a><a href='#L178'>178</a> <a name='L179'></a><a href='#L179'>179</a> <a name='L180'></a><a href='#L180'>180</a> <a name='L181'></a><a href='#L181'>181</a> <a name='L182'></a><a href='#L182'>182</a> <a name='L183'></a><a href='#L183'>183</a> <a name='L184'></a><a href='#L184'>184</a> <a name='L185'></a><a href='#L185'>185</a> <a name='L186'></a><a href='#L186'>186</a> <a name='L187'></a><a href='#L187'>187</a> <a name='L188'></a><a href='#L188'>188</a> <a name='L189'></a><a href='#L189'>189</a> <a name='L190'></a><a href='#L190'>190</a> <a name='L191'></a><a href='#L191'>191</a> <a name='L192'></a><a href='#L192'>192</a> <a name='L193'></a><a href='#L193'>193</a> <a name='L194'></a><a href='#L194'>194</a> <a name='L195'></a><a href='#L195'>195</a> <a name='L196'></a><a href='#L196'>196</a> <a name='L197'></a><a href='#L197'>197</a> <a name='L198'></a><a href='#L198'>198</a> <a name='L199'></a><a href='#L199'>199</a> <a name='L200'></a><a href='#L200'>200</a> <a name='L201'></a><a href='#L201'>201</a> <a name='L202'></a><a href='#L202'>202</a> <a name='L203'></a><a href='#L203'>203</a> <a name='L204'></a><a href='#L204'>204</a> <a name='L205'></a><a href='#L205'>205</a> <a name='L206'></a><a href='#L206'>206</a> <a name='L207'></a><a href='#L207'>207</a> <a name='L208'></a><a href='#L208'>208</a> <a name='L209'></a><a href='#L209'>209</a> <a name='L210'></a><a href='#L210'>210</a> <a name='L211'></a><a href='#L211'>211</a> <a name='L212'></a><a href='#L212'>212</a> <a name='L213'></a><a href='#L213'>213</a> <a name='L214'></a><a href='#L214'>214</a> <a name='L215'></a><a href='#L215'>215</a> <a name='L216'></a><a href='#L216'>216</a> <a name='L217'></a><a href='#L217'>217</a> <a name='L218'></a><a href='#L218'>218</a> <a name='L219'></a><a href='#L219'>219</a> <a name='L220'></a><a href='#L220'>220</a> <a name='L221'></a><a href='#L221'>221</a> <a name='L222'></a><a href='#L222'>222</a> <a name='L223'></a><a href='#L223'>223</a> <a name='L224'></a><a href='#L224'>224</a> <a name='L225'></a><a href='#L225'>225</a> <a name='L226'></a><a href='#L226'>226</a> <a name='L227'></a><a href='#L227'>227</a> <a name='L228'></a><a href='#L228'>228</a> <a name='L229'></a><a href='#L229'>229</a> <a name='L230'></a><a href='#L230'>230</a> <a name='L231'></a><a href='#L231'>231</a> <a name='L232'></a><a href='#L232'>232</a> <a name='L233'></a><a href='#L233'>233</a> <a name='L234'></a><a href='#L234'>234</a> <a name='L235'></a><a href='#L235'>235</a> <a name='L236'></a><a href='#L236'>236</a> <a name='L237'></a><a href='#L237'>237</a> <a name='L238'></a><a href='#L238'>238</a> <a name='L239'></a><a href='#L239'>239</a> <a name='L240'></a><a href='#L240'>240</a> <a name='L241'></a><a href='#L241'>241</a> <a name='L242'></a><a href='#L242'>242</a> <a name='L243'></a><a href='#L243'>243</a> <a name='L244'></a><a href='#L244'>244</a> <a name='L245'></a><a href='#L245'>245</a> <a name='L246'></a><a href='#L246'>246</a> <a name='L247'></a><a href='#L247'>247</a> <a name='L248'></a><a href='#L248'>248</a> <a name='L249'></a><a href='#L249'>249</a> <a name='L250'></a><a href='#L250'>250</a> <a name='L251'></a><a href='#L251'>251</a> <a name='L252'></a><a href='#L252'>252</a> <a name='L253'></a><a href='#L253'>253</a> <a name='L254'></a><a href='#L254'>254</a> <a name='L255'></a><a href='#L255'>255</a> <a name='L256'></a><a href='#L256'>256</a> <a name='L257'></a><a href='#L257'>257</a> <a name='L258'></a><a href='#L258'>258</a> <a name='L259'></a><a href='#L259'>259</a> <a name='L260'></a><a href='#L260'>260</a> <a name='L261'></a><a href='#L261'>261</a> <a name='L262'></a><a href='#L262'>262</a> <a name='L263'></a><a href='#L263'>263</a> <a name='L264'></a><a href='#L264'>264</a> <a name='L265'></a><a href='#L265'>265</a> <a name='L266'></a><a href='#L266'>266</a> <a name='L267'></a><a href='#L267'>267</a> <a name='L268'></a><a href='#L268'>268</a> <a name='L269'></a><a href='#L269'>269</a> <a name='L270'></a><a href='#L270'>270</a> <a name='L271'></a><a href='#L271'>271</a> <a name='L272'></a><a href='#L272'>272</a> <a name='L273'></a><a href='#L273'>273</a> <a name='L274'></a><a href='#L274'>274</a> <a name='L275'></a><a href='#L275'>275</a> <a name='L276'></a><a href='#L276'>276</a> <a name='L277'></a><a href='#L277'>277</a> <a name='L278'></a><a href='#L278'>278</a> <a name='L279'></a><a href='#L279'>279</a> <a name='L280'></a><a href='#L280'>280</a> <a name='L281'></a><a href='#L281'>281</a> <a name='L282'></a><a href='#L282'>282</a> <a name='L283'></a><a href='#L283'>283</a> <a name='L284'></a><a href='#L284'>284</a> <a name='L285'></a><a href='#L285'>285</a> <a name='L286'></a><a href='#L286'>286</a> <a name='L287'></a><a href='#L287'>287</a> <a name='L288'></a><a href='#L288'>288</a> <a name='L289'></a><a href='#L289'>289</a> <a name='L290'></a><a href='#L290'>290</a> <a name='L291'></a><a href='#L291'>291</a> <a name='L292'></a><a href='#L292'>292</a> <a name='L293'></a><a href='#L293'>293</a> <a name='L294'></a><a href='#L294'>294</a> <a name='L295'></a><a href='#L295'>295</a> <a name='L296'></a><a href='#L296'>296</a> <a name='L297'></a><a href='#L297'>297</a> <a name='L298'></a><a href='#L298'>298</a> <a name='L299'></a><a href='#L299'>299</a> <a name='L300'></a><a href='#L300'>300</a> <a name='L301'></a><a href='#L301'>301</a> <a name='L302'></a><a href='#L302'>302</a> <a name='L303'></a><a href='#L303'>303</a> <a name='L304'></a><a href='#L304'>304</a> <a name='L305'></a><a href='#L305'>305</a> <a name='L306'></a><a href='#L306'>306</a> <a name='L307'></a><a href='#L307'>307</a> <a name='L308'></a><a href='#L308'>308</a> <a name='L309'></a><a href='#L309'>309</a> <a name='L310'></a><a href='#L310'>310</a> <a name='L311'></a><a href='#L311'>311</a> <a name='L312'></a><a href='#L312'>312</a> <a name='L313'></a><a href='#L313'>313</a> <a name='L314'></a><a href='#L314'>314</a> <a name='L315'></a><a href='#L315'>315</a> <a name='L316'></a><a href='#L316'>316</a> <a name='L317'></a><a href='#L317'>317</a> <a name='L318'></a><a href='#L318'>318</a> <a name='L319'></a><a href='#L319'>319</a> <a name='L320'></a><a href='#L320'>320</a> <a name='L321'></a><a href='#L321'>321</a> <a name='L322'></a><a href='#L322'>322</a> <a name='L323'></a><a href='#L323'>323</a> <a name='L324'></a><a href='#L324'>324</a> <a name='L325'></a><a href='#L325'>325</a> <a name='L326'></a><a href='#L326'>326</a> <a name='L327'></a><a href='#L327'>327</a> <a name='L328'></a><a href='#L328'>328</a> <a name='L329'></a><a href='#L329'>329</a> <a name='L330'></a><a href='#L330'>330</a> <a name='L331'></a><a href='#L331'>331</a> <a name='L332'></a><a href='#L332'>332</a> <a name='L333'></a><a href='#L333'>333</a> <a name='L334'></a><a href='#L334'>334</a> <a name='L335'></a><a href='#L335'>335</a> <a name='L336'></a><a href='#L336'>336</a> <a name='L337'></a><a href='#L337'>337</a> <a name='L338'></a><a href='#L338'>338</a> <a name='L339'></a><a href='#L339'>339</a> <a name='L340'></a><a href='#L340'>340</a> <a name='L341'></a><a href='#L341'>341</a> <a name='L342'></a><a href='#L342'>342</a> <a name='L343'></a><a href='#L343'>343</a> <a name='L344'></a><a href='#L344'>344</a> <a name='L345'></a><a href='#L345'>345</a> <a name='L346'></a><a href='#L346'>346</a> <a name='L347'></a><a href='#L347'>347</a> <a name='L348'></a><a href='#L348'>348</a> <a name='L349'></a><a href='#L349'>349</a> <a name='L350'></a><a href='#L350'>350</a> <a name='L351'></a><a href='#L351'>351</a> <a name='L352'></a><a href='#L352'>352</a> <a name='L353'></a><a href='#L353'>353</a> <a name='L354'></a><a href='#L354'>354</a> <a name='L355'></a><a href='#L355'>355</a> <a name='L356'></a><a href='#L356'>356</a> <a name='L357'></a><a href='#L357'>357</a> <a name='L358'></a><a href='#L358'>358</a> <a name='L359'></a><a href='#L359'>359</a> <a name='L360'></a><a href='#L360'>360</a> <a name='L361'></a><a href='#L361'>361</a> <a name='L362'></a><a href='#L362'>362</a></td><td class="line-coverage quiet">1x 1x 1x 1x   1x 5x                                             3x                                         4x                                       3x                                           4x 4x 4x 8x   4x 4x 12x   4x 4x 12x   4x 8x     4x 4x 4x 12x 12x 4x     4x     4x 12x 12x 12x     12x 3x 3x 3x     12x                                   3x 3x 3x     3x 3x                                 3x             3x   3x 3x       3x 6x 6x 6x 6x   6x   6x 6x   54x   54x 54x   54x   54x   54x 6x     48x   48x 23x     48x   21x     27x     48x 48x       6x   3x                             1x 1x 1x 1x 2x 2x 7x 7x 5x 1x   5x   7x 4x   3x         1x                             3x 3x 3x 3x 3x 3x 3x       3x 1x   2x 2x 2x 2x 2x 2x   2x   2x 2x 2x 2x 1x 1x 1x 1x 1x 1x             1x   1x 1x 1x 1x 1x             1x       2x 2x 2x 2x 2x 2x 2x                                 1x</td><td class="text"><pre class="prettyprint lang-js">const fs = require("fs-extra"); const glob = require("glob"); const path = require("path"); const {EOL} = require("os");   const capitalizeString = (s) => { return s.substr(0,1).toUpperCase() + s.substr(1); };   /** * ----------------- * * @name Javadoc * @type Class. * @type Function. * @description Master class of the `javadoc` package. */ class Javadoc {   /** * * ------------------- * * @name Javadoc.REGEX_PATTERNS * @type Static property. * @type Object. * @description Regular expression patterns used by the class. */ static get REGEX_PATTERNS() { return { JAVADOC_COMMENT: /\/\*\*[\t ]*((\r?\n)([\t ]*\*[\t ]*).*)*/g, JAVADOC_ENTRY: /^\/\*\*[\t ]*/g, JAVADOC_LINE_ENTRY: /^\r?\n[\t ]*\*[\t ]*/g, JAVADOC_PROPERTY: /^\@[^\n\r\t ]*/g, JAVADOC_VALUE: /^.*/g, } }   /** * * ------------------------- * * @name Javadoc.DEFAULT_GLOB_OPTIONS * @type Static property. * @type Object. * @property `cwd`. Defaults to `process.cwd()`. Allowed options at [glob package](https://www.npmjs.com/package/glob#options) * @property `dot`. Defaults to `true`. Allowed options at [glob package](https://www.npmjs.com/package/glob#options) * @description Default options used by the `glob` package. */ static get DEFAULT_GLOB_OPTIONS() { return { cwd: process.cwd(), dot: true, } }   /** * * --------------------------- * * @name Javadoc.DEFAULT_OPTIONS * @type Static property. * @type Object. * @property include:Array<String>. Defaults to `["** /*.js"]`. Allowed rules at [glob package](https://www.npmjs.com/package/glob). * @property exclude:Array<String>. Defaults to `["** /node_modules/**.js"]`. Allowed rules at [glob package](https://www.npmjs.com/package/glob). * @property format:String. Defaults to `"markdown"`. Allowed values: `"md"` | `"json"`. * @property output:String. Defaults to `undefined`. File into which dump the results. **Required value**. * @description General options of the `Javadoc.generate` main method. */ static get DEFAULT_OPTIONS() { return { include: ["**/*.js"], exclude: ["**/node_modules/**"], format: "markdown", output: undefined } }   /** * * ------------------------ * * @name Javadoc.findFiles * @type Static method. * @type Function. * @parameter parameterIncludes:Array<String>. Replaces `DEFAULT_OPTIONS.include` as value. * @parameter parameterExcludes:Array<String>. Replaces `DEFAULT_OPTIONS.exclude` as value. * @parameter parameterOptions:Object. Overrides `DEFAULT_GLOB_OPTIONS` as object. * @returns files:Promise<Array<String>>. Asynchronously, returns an array of matched files (as Strings). * @description Finds files based on glob patterns ([more info](https://www.npmjs.com/package/glob#usage)) included, excluded and glob options ([more info](https://www.npmjs.com/package/glob#options)). */ static findFiles(parameterIncludes, parameterExcludes = [], parameterOptions = {}) { return new Promise((success, failure) => { const options = Object.assign({}, this.DEFAULT_GLOB_OPTIONS, parameterOptions); const excludes = [].concat(parameterExcludes).map(f => { return path.resolve(options.cwd, f); }); options.ignore = excludes; const includez = [].concat(parameterIncludes).map(f => { return path.resolve(options.cwd, f); }); console.log("[javadoc] Patterns:"); includez.forEach(includezItem => { console.log("[javadoc] - (include) " + includezItem); }); excludes.forEach(excluded => { console.log("[javadoc] - (exclude) " + excluded); }); // @TODO: match all included glob patterns in a loop... const files = []; let counterIncluded = 0; const finalize = () => { counterIncluded++; if(counterIncluded >= includez.length) { return success(files); } } Iif(includez.length === 0) { return finalize(); } for(let includeIndex = 0; includeIndex < includez.length; includeIndex++) { const includePattern = includez[includeIndex]; glob(includePattern, options, (error, filesMatched) => { Iif (error) { return finalize(); } for(let indexMatched = 0; indexMatched < filesMatched.length; indexMatched++) { const fileMatched = filesMatched[indexMatched]; Eif(files.indexOf(fileMatched) === -1) { files.push(fileMatched); } } return finalize(); }); } }); }   /** * * ------------------------------- * * @name Javadoc.findCommentsInFile * @type Static method. * @type Function. * @parameter file:String. File into which look for the javadoc-comments. * @returns matches:Promise<Array<Object>>. Asynchronously, returns a list of matched javadoc-comments (as Objects) found in the passed file. * @description From a file, it returns (asynchronously, by a Promise) javadoc-comments represented as Objects. */ static findCommentsInFile(file) { return new Promise((success, failure) => { return fs.readFile(file, "utf8", (error, contents) => { Iif (error) { return failure(error); } const matches = this.findCommentsInString(contents); return success(matches); }); }); }   /** * * -------------------------------- * * @name Javadoc.findCommentsInString * @type Static method. * @type Function. * @parameter text:String. Text into which look for the javadoc-comments. * @returns totalMatches:Array<Object>. List of javadoc-comments (as Objects) found in the passed String. * @description Finds javadoc-comments (as Objects) from a String. */ static findCommentsInString(text) { const totalMatches = []; const { JAVADOC_COMMENT, JAVADOC_ENTRY, JAVADOC_LINE_ENTRY, JAVADOC_PROPERTY, JAVADOC_VALUE, } = this.REGEX_PATTERNS; // 1. Get all javadoc-comment matches. const allMatches = text.match(JAVADOC_COMMENT); Iif(allMatches === null) { return totalMatches; } // 2. For each javadoc-comment... for (let indexMatch = 0; indexMatch < allMatches.length; indexMatch++) { const matches = {}; let lastProperty = "_"; let wasStarted = false; let token = allMatches[indexMatch]; // 3. Remove the entry token = token.replace(JAVADOC_ENTRY, ""); // 4. For each line of the javadoc-comment... starts the extraction. Extraction: while (JAVADOC_LINE_ENTRY.test(token)) { // 5. Remove the line entry. token = token.replace(JAVADOC_LINE_ENTRY, ""); // 6. Get the current property of the line (description by default) const isPropertyLine = JAVADOC_PROPERTY.test(token); const property = isPropertyLine ? token.match(JAVADOC_PROPERTY)[0] : lastProperty; // 7. Remove the property. token = token.replace(JAVADOC_PROPERTY, ""); // 8. Get the current value. Also, replace "* /" for "*/" (in order to escape closed comments). const value = token.match(JAVADOC_VALUE)[0].replace(/^[\t ]+/g, "").replace(/\* \//g, "*/"); // 9. If it is the last line of the javadoc, get out of the extraction of that javadoc-comment. if (value === "/") { continue Extraction; } // 10. Remove the value. token = token.replace(JAVADOC_VALUE, ""); // 11. If the property did not exist, create it. if (!(property in matches)) { matches[property] = []; } // 12. Add the value to that property. if ((!isPropertyLine) && wasStarted) { // a. Inline if it is a new-property-line matches[property][matches[property].length - 1] += "\n" + value; } else { // b. Otherwise as a new entry matches[property].push(value); } // 13. Assign the last property to the current property. lastProperty = property; wasStarted = true; // 14. Go for the next javadoc-comment line extraction. } // 15. Once all the lines were extracted, push the data for this javadoc-comment. totalMatches.push(matches); } return totalMatches; }   /** * * ----------------------------------- * * @name Javadoc.formatJsonToMarkdown * @type Static method. * @type Function. * @parameter fileComments:Array<Object>. List of javadoc-comments (as Object) to convert to markdown format. * @returns formatted:String. Markdown code from passed javadoc-comments. * @description Generates `markdown` code from a list of javadoc-comments. */ static formatJsonToMarkdown(filesAndComments) { let formatted = ""; for (let indexFiles = 0; indexFiles < filesAndComments.length; indexFiles++) { const fileComments = filesAndComments[indexFiles]; for(let indexComments = 0; indexComments < fileComments.length; indexComments++) { const fileComment = fileComments[indexComments]; Object.keys(fileComment).forEach(property => { const value = fileComment[property].join(EOL + EOL + EOL); if (property !== "_") { const propertyTransformed = capitalizeString(property.replace(/^@/g, "").replace(/\-[a-z]/g, (match) => { return " " + match.substr(1).toUpperCase(); })); formatted += `**${propertyTransformed}**`; } if (value) { formatted += (property.startsWith("@") ? ": " : "") + value + "" + EOL + EOL + EOL; } else { formatted += "." + EOL + EOL + EOL; } }); } } return formatted; }   /** * * ----------------------------------- * * @name Javadoc.generate * @type Static method. * @type Function. * @parameter parameters:Object. Overrides `Javadoc.DEFAULT_OPTIONS` as Object. To see more about properties, go to that static property of Javadoc class. * @returns output:Promise<String|Array<Object>>. Depending on `parameters.format` (`"json"`|`"markdown"`), it can return an Array or a String. * @description Finds included files, dismisses excluded files, extracts javadoc-comments, formats them adecuately, and dumps the results into output file, while returning the output asynchronously (as a Promise). */ static generate(parameters = {}) { return new Promise((success, failure) => { const options = Object.assign({}, this.DEFAULT_OPTIONS, parameters); console.log("[javadoc] Start extracting javadoc comments."); return this.findFiles(options.include, options.exclude).then(files => { console.log(`[javadoc] Total of files matched: ${files.length}.`); let counter = 0; const output = { success: [], error: [] }; if(files.length === 0) { return success([]); } const endExecution = (result) => { console.log("[javadoc] Final javadoc report per file:"); console.log(`[javadoc] - ${output.success.length} success(es).`); console.log(`[javadoc] - ${output.error.length} error(s).`); Eif(output.error.length === 0) { console.log("[javadoc] Successfully finished."); } return success(result); } const finalize = () => { counter++; Eif (counter >= files.length) { if (["md", "markdown"].indexOf(options.format) !== -1) { const formatted = this.formatJsonToMarkdown(output.success); Eif (options.output) { const outputFile = path.resolve(options.output); try { fs.outputFileSync(outputFile, formatted, "utf8"); console.log(`[javadoc] File output (markdown) written successfully at ${path.basename(outputFile)}.`); } catch (error) { <span class="cstat-no" title="statement not