@appium/docutils 0.2.1 → 0.3.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 (201) hide show
  1. package/LICENSE +1 -1
  2. package/build/lib/builder/deploy.d.ts.map +1 -1
  3. package/build/lib/builder/deploy.js +6 -2
  4. package/build/lib/builder/deploy.js.map +1 -1
  5. package/build/lib/builder/index.d.ts +4 -0
  6. package/build/lib/builder/index.d.ts.map +1 -1
  7. package/build/lib/builder/index.js +4 -0
  8. package/build/lib/builder/index.js.map +1 -1
  9. package/build/lib/builder/nav.d.ts +1 -1
  10. package/build/lib/builder/nav.d.ts.map +1 -1
  11. package/build/lib/builder/nav.js +3 -3
  12. package/build/lib/builder/nav.js.map +1 -1
  13. package/build/lib/builder/reference.d.ts +1 -1
  14. package/build/lib/builder/reference.d.ts.map +1 -1
  15. package/build/lib/builder/reference.js +1 -19
  16. package/build/lib/builder/reference.js.map +1 -1
  17. package/build/lib/builder/site.d.ts.map +1 -1
  18. package/build/lib/builder/site.js +4 -3
  19. package/build/lib/builder/site.js.map +1 -1
  20. package/build/lib/cli/check.d.ts +19 -0
  21. package/build/lib/cli/check.d.ts.map +1 -0
  22. package/build/lib/cli/check.js +58 -0
  23. package/build/lib/cli/check.js.map +1 -0
  24. package/build/lib/cli/command/build.d.ts +42 -29
  25. package/build/lib/cli/command/build.d.ts.map +1 -1
  26. package/build/lib/cli/command/build.js +55 -39
  27. package/build/lib/cli/command/build.js.map +1 -1
  28. package/build/lib/cli/command/index.d.ts +4 -0
  29. package/build/lib/cli/command/index.d.ts.map +1 -1
  30. package/build/lib/cli/command/index.js +4 -0
  31. package/build/lib/cli/command/index.js.map +1 -1
  32. package/build/lib/cli/command/init.d.ts +42 -27
  33. package/build/lib/cli/command/init.d.ts.map +1 -1
  34. package/build/lib/cli/command/init.js +51 -28
  35. package/build/lib/cli/command/init.js.map +1 -1
  36. package/build/lib/cli/command/validate.d.ts +21 -15
  37. package/build/lib/cli/command/validate.d.ts.map +1 -1
  38. package/build/lib/cli/command/validate.js +30 -21
  39. package/build/lib/cli/command/validate.js.map +1 -1
  40. package/build/lib/cli/config.js +1 -1
  41. package/build/lib/cli/config.js.map +1 -1
  42. package/build/lib/cli/index.d.ts.map +1 -1
  43. package/build/lib/cli/index.js +29 -12
  44. package/build/lib/cli/index.js.map +1 -1
  45. package/build/lib/constants.d.ts +4 -0
  46. package/build/lib/constants.d.ts.map +1 -1
  47. package/build/lib/constants.js +5 -1
  48. package/build/lib/constants.js.map +1 -1
  49. package/build/lib/error.d.ts +5 -0
  50. package/build/lib/error.d.ts.map +1 -1
  51. package/build/lib/error.js +5 -0
  52. package/build/lib/error.js.map +1 -1
  53. package/build/lib/fs.d.ts +1 -1
  54. package/build/lib/fs.d.ts.map +1 -1
  55. package/build/lib/fs.js +2 -2
  56. package/build/lib/fs.js.map +1 -1
  57. package/build/lib/index.d.ts +4 -0
  58. package/build/lib/index.d.ts.map +1 -1
  59. package/build/lib/index.js +4 -0
  60. package/build/lib/index.js.map +1 -1
  61. package/build/lib/init.d.ts +24 -26
  62. package/build/lib/init.d.ts.map +1 -1
  63. package/build/lib/init.js +12 -7
  64. package/build/lib/init.js.map +1 -1
  65. package/build/lib/logger.js +0 -4
  66. package/build/lib/logger.js.map +1 -1
  67. package/build/lib/mike.d.ts.map +1 -1
  68. package/build/lib/mike.js +4 -0
  69. package/build/lib/mike.js.map +1 -1
  70. package/build/lib/model.d.ts +6 -10
  71. package/build/lib/model.d.ts.map +1 -1
  72. package/build/lib/scaffold.d.ts +5 -5
  73. package/build/lib/scaffold.d.ts.map +1 -1
  74. package/build/lib/util.d.ts +6 -3
  75. package/build/lib/util.d.ts.map +1 -1
  76. package/build/lib/util.js.map +1 -1
  77. package/build/lib/validate.d.ts +5 -2
  78. package/build/lib/validate.d.ts.map +1 -1
  79. package/build/lib/validate.js +9 -7
  80. package/build/lib/validate.js.map +1 -1
  81. package/lib/builder/deploy.ts +9 -3
  82. package/lib/builder/index.ts +5 -0
  83. package/lib/builder/nav.ts +2 -3
  84. package/lib/builder/reference.ts +2 -22
  85. package/lib/builder/site.ts +6 -5
  86. package/lib/cli/check.ts +87 -0
  87. package/lib/cli/command/build.ts +61 -46
  88. package/lib/cli/command/index.ts +5 -0
  89. package/lib/cli/command/init.ts +54 -32
  90. package/lib/cli/command/validate.ts +35 -28
  91. package/lib/cli/index.ts +23 -4
  92. package/lib/constants.ts +5 -0
  93. package/lib/error.ts +6 -0
  94. package/lib/fs.ts +6 -3
  95. package/lib/index.ts +5 -0
  96. package/lib/init.ts +23 -6
  97. package/lib/logger.ts +6 -11
  98. package/lib/mike.js +5 -0
  99. package/lib/model.ts +3 -9
  100. package/lib/util.ts +4 -1
  101. package/lib/validate.ts +10 -9
  102. package/package.json +10 -12
  103. package/requirements.txt +1 -1
  104. package/build/lib/build/mkdocs.d.ts +0 -58
  105. package/build/lib/build/mkdocs.d.ts.map +0 -1
  106. package/build/lib/build/mkdocs.js +0 -80
  107. package/build/lib/build/mkdocs.js.map +0 -1
  108. package/build/lib/build/typedoc.d.ts +0 -55
  109. package/build/lib/build/typedoc.d.ts.map +0 -1
  110. package/build/lib/build/typedoc.js +0 -120
  111. package/build/lib/build/typedoc.js.map +0 -1
  112. package/build/lib/build-api.d.ts +0 -18
  113. package/build/lib/build-api.d.ts.map +0 -1
  114. package/build/lib/build-api.js +0 -75
  115. package/build/lib/build-api.js.map +0 -1
  116. package/build/lib/build.d.ts +0 -21
  117. package/build/lib/build.d.ts.map +0 -1
  118. package/build/lib/build.js +0 -71
  119. package/build/lib/build.js.map +0 -1
  120. package/build/lib/cli/command/deploy.d.ts +0 -1
  121. package/build/lib/cli/command/deploy.d.ts.map +0 -1
  122. package/build/lib/cli/command/deploy.js +0 -2
  123. package/build/lib/cli/command/deploy.js.map +0 -1
  124. package/build/lib/cli/command-init.d.ts +0 -143
  125. package/build/lib/cli/command-init.d.ts.map +0 -1
  126. package/build/lib/cli/command-init.js +0 -164
  127. package/build/lib/cli/command-init.js.map +0 -1
  128. package/build/lib/cli/command-validate.d.ts +0 -52
  129. package/build/lib/cli/command-validate.d.ts.map +0 -1
  130. package/build/lib/cli/command-validate.js +0 -66
  131. package/build/lib/cli/command-validate.js.map +0 -1
  132. package/build/lib/cli/init.d.ts +0 -143
  133. package/build/lib/cli/init.d.ts.map +0 -1
  134. package/build/lib/cli/init.js +0 -164
  135. package/build/lib/cli/init.js.map +0 -1
  136. package/build/lib/cli/options.d.ts +0 -1
  137. package/build/lib/cli/options.d.ts.map +0 -1
  138. package/build/lib/cli/options.js +0 -2
  139. package/build/lib/cli/options.js.map +0 -1
  140. package/build/lib/cli/validate.d.ts +0 -1
  141. package/build/lib/cli/validate.d.ts.map +0 -1
  142. package/build/lib/cli/validate.js +0 -2
  143. package/build/lib/cli/validate.js.map +0 -1
  144. package/build/lib/cli.d.ts +0 -10
  145. package/build/lib/cli.d.ts.map +0 -1
  146. package/build/lib/cli.js +0 -328
  147. package/build/lib/cli.js.map +0 -1
  148. package/build/lib/init-task.d.ts +0 -49
  149. package/build/lib/init-task.d.ts.map +0 -1
  150. package/build/lib/init-task.js +0 -95
  151. package/build/lib/init-task.js.map +0 -1
  152. package/build/lib/io.d.ts +0 -1
  153. package/build/lib/io.d.ts.map +0 -1
  154. package/build/lib/io.js +0 -2
  155. package/build/lib/io.js.map +0 -1
  156. package/build/lib/mkdocs.d.ts +0 -58
  157. package/build/lib/mkdocs.d.ts.map +0 -1
  158. package/build/lib/mkdocs.js +0 -77
  159. package/build/lib/mkdocs.js.map +0 -1
  160. package/build/lib/nav.d.ts +0 -47
  161. package/build/lib/nav.d.ts.map +0 -1
  162. package/build/lib/nav.js +0 -132
  163. package/build/lib/nav.js.map +0 -1
  164. package/build/lib/test.d.ts +0 -9
  165. package/build/lib/test.d.ts.map +0 -1
  166. package/build/lib/test.js +0 -2
  167. package/build/lib/test.js.map +0 -1
  168. package/build/lib/typedoc.d.ts +0 -55
  169. package/build/lib/typedoc.d.ts.map +0 -1
  170. package/build/lib/typedoc.js +0 -122
  171. package/build/lib/typedoc.js.map +0 -1
  172. package/build/lib/types.d.ts +0 -52
  173. package/build/lib/types.d.ts.map +0 -1
  174. package/build/lib/types.js +0 -7
  175. package/build/lib/types.js.map +0 -1
  176. package/build/lib/validation/base-validator.d.ts +0 -218
  177. package/build/lib/validation/base-validator.d.ts.map +0 -1
  178. package/build/lib/validation/base-validator.js +0 -453
  179. package/build/lib/validation/base-validator.js.map +0 -1
  180. package/build/lib/validation/mkdocs-validator.d.ts +0 -5
  181. package/build/lib/validation/mkdocs-validator.d.ts.map +0 -1
  182. package/build/lib/validation/mkdocs-validator.js +0 -54
  183. package/build/lib/validation/mkdocs-validator.js.map +0 -1
  184. package/build/lib/validation/python-validator.d.ts +0 -1
  185. package/build/lib/validation/python-validator.d.ts.map +0 -1
  186. package/build/lib/validation/python-validator.js +0 -2
  187. package/build/lib/validation/python-validator.js.map +0 -1
  188. package/build/lib/validation/python.d.ts +0 -1
  189. package/build/lib/validation/python.d.ts.map +0 -1
  190. package/build/lib/validation/python.js +0 -2
  191. package/build/lib/validation/python.js.map +0 -1
  192. package/build/lib/validation/validate.d.ts +0 -221
  193. package/build/lib/validation/validate.d.ts.map +0 -1
  194. package/build/lib/validation/validate.js +0 -508
  195. package/build/lib/validation/validate.js.map +0 -1
  196. package/build/lib/validation/validator.d.ts +0 -220
  197. package/build/lib/validation/validator.d.ts.map +0 -1
  198. package/build/lib/validation/validator.js +0 -470
  199. package/build/lib/validation/validator.js.map +0 -1
  200. package/build/test/unit/mike.spec.js +0 -17
  201. package/build/test/unit/mike.spec.js.map +0 -1
@@ -1 +0,0 @@
1
- {"version":3,"file":"base-validator.js","sourceRoot":"","sources":["../../../lib/validation/base-validator.ts"],"names":[],"mappings":";;;;;;AAAA,qBAAmB;AACnB;;;;GAIG;AAEH,6CAAmC;AACnC,kDAA0B;AAC1B,oDAAuB;AACvB,6CAAyC;AACzC,0DAA6B;AAC7B,0DAAkC;AAClC,mCAAiC;AACjC,+CAAkC;AAClC,4CAiBsB;AACtB,oCAAuC;AACvC,8BASe;AACf,uDAA+B;AAE/B,kCAAiC;AAEjC;;GAEG;AACH,MAAM,cAAc,GAAG,WAAW,CAAC;AAEnC;;GAEG;AACH,MAAM,wBAAwB,GAAG,yBAAyB,CAAC;AAE3D;;GAEG;AACH,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAExD,MAAM,GAAG,GAAG,gBAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;AAYvC;;;;;;;;GAQG;AACH,MAAsB,aAAc,SAAQ,0BAAY;IA0EtD;;OAEG;IACH,YAAY,OAAuC,EAAE;QACnD,KAAK,EAAE,CAAC;QA9DV;;WAEG;QACgB,iBAAY,GAAG,IAAI,GAAG,EAAkB,CAAC;QAE5D;;;;;;;WAOG;QACO,kBAAa,GAAG,IAAI,GAAG,EAAyB,CAAC;QAmDzD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,gBAAC,CAAC,YAAY,CAAC,IAAI,EAAE,EAAC,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE,EAAC,CAAC,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QAC7C,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;QACvC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QACzB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC;QAC/C,IAAI,CAAC,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QAC7C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC;QAEzC,sCAAsC;QACtC,IAAI,CAAC,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,GAAkB,EAAE,EAAE;YACpD,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC;QAC3C,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,QAAQ;QACnB,IAAI;YACF,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;YAEvD,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,uBAAW,CAAC,EAAE;gBACtC,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;gBACnC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;aACjC;YAED,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,uBAAW,CAAC,EAAE;gBACtC,+BAA+B;gBAC/B,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;aACnC;YAED,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,oBAAQ,CAAC,EAAE;gBACnC,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;aACjC;YAED,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,2BAAe,CAAC,EAAE;gBAC1C,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;gBAChC,MAAM,IAAI,CAAC,wBAAwB,EAAE,CAAC;aACvC;YAED,IAAI,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,wBAAY,CAAC,EAAE;gBACvC,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC,qBAAqB,EAAE,CAAC;aACpC;YAED,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SACvD;gBAAS;YACR,IAAI,CAAC,KAAK,EAAE,CAAC;SACd;IACH,CAAC;IAED;;;;;OAKG;IACO,IAAI,CAAC,GAA2B;QACxC,MAAM,IAAI,GAAG,gBAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;QAC5D,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACzC,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;SACxC;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,UAAU;QACxB,OAAO,CACL,IAAI,CAAC,MAAM;YACX,CAAC,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,eAAe;gBACjC,CAAC,CAAC,mBAAI,CAAC,OAAO,CAAC,IAAI,CAAC,eAAe,CAAC;gBACpC,CAAC,CAAC,MAAM,IAAA,eAAU,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAChC,CAAC;IACJ,CAAC;IAED;;;OAGG;IACO,EAAE,CAAC,OAAe;QAC1B,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,oBAAoB;QAClC,IAAI,IAAI,CAAC,eAAe,EAAE;YACxB,OAAO,IAAI,CAAC,eAAe,CAAC;SAC7B;QAED,IAAI,gBAAgB,GAAiB,EAAE,CAAC;QAExC,IAAI;YACF,IAAI,eAAe,GAAG,MAAM,YAAE,CAAC,QAAQ,CAAC,iCAAqB,EAAE,MAAM,CAAC,CAAC;YACvE,eAAe,GAAG,eAAe,CAAC,IAAI,EAAE,CAAC;YACzC,GAAG,CAAC,KAAK,CAAC,YAAY,EAAE,iCAAqB,EAAE,eAAe,CAAC,CAAC;YAChE,KAAK,MAAM,IAAI,IAAI,eAAe,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;gBACjD,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;gBAChD,gBAAgB,CAAC,IAAI,CAAC,EAAC,IAAI,EAAE,OAAO,EAAC,CAAC,CAAC;aACxC;YACD,GAAG,CAAC,KAAK,CAAC,eAAe,EAAE,iCAAqB,EAAE,gBAAgB,CAAC,CAAC;SACrE;QAAC,MAAM;YACN,MAAM,IAAI,qBAAa,CAAC,kBAAkB,iCAAqB,iBAAiB,CAAC,CAAC;SACnF;QAED,OAAO,CAAC,IAAI,CAAC,eAAe,GAAG,gBAAgB,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACO,KAAK;QACb,IAAI,CAAC,aAAa,CAAC,KAAK,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,oBAAoB,CAAC,aAAsB;QACzD,aAAa,GAAG,aAAa,IAAI,IAAI,CAAC,aAAa,IAAI,CAAC,MAAM,IAAA,kBAAa,EAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;QACvF,IAAI,CAAC,aAAa,EAAE;YAClB,OAAO,IAAI,CAAC,IAAI,CACd,kBAAkB,2BAAe,SAAS,IAAI,CAAC,GAAG,UAAU,oBAAQ,qBAAqB,CAC1F,CAAC;SACH;QACD,IAAI,SAAoB,CAAC;QACzB,IAAI;YACF,SAAS,GAAG,MAAM,IAAA,kBAAa,EAAC,aAAa,CAAC,CAAC;SAChD;QAAC,OAAO,CAAC,EAAE;YACV,MAAM,GAAG,GAAG,CAA0B,CAAC;YACvC,IAAI,GAAG,CAAC,IAAI,KAAK,2BAAe,EAAE;gBAChC,OAAO,IAAI,CAAC,IAAI,CACd,kBAAkB,2BAAe,OAAO,aAAa,iDAAiD,CACvG,CAAC;aACH;YACD,OAAO,IAAI,CAAC,IAAI,CAAC,mBAAmB,aAAa,KAAK,GAAG,EAAE,CAAC,CAAC;SAC9D;QAED,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE;YACxB,OAAO,IAAI,CAAC,IAAI,CAAC,mDAAmD,aAAa,EAAE,CAAC,CAAC;SACtF;QAED,IAAI,CAAC,EAAE,CAAC,oBAAoB,aAAa,KAAK,CAAC,CAAC;IAClD,CAAC;IAED;;;;OAIG;IACO,KAAK,CAAC,kBAAkB;QAChC,MAAM,cAAc,GAAG,wBAAY,CAAC,OAAO,EAAE,GAAG,CAAC;QACjD,IAAI,CAAC,cAAc,EAAE;YACnB,MAAM,IAAI,qBAAa,CAAC,oEAAoE,CAAC,CAAC;SAC/F;QACD,IAAI;YACF,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,CAAC,MAAM,IAAA,aAAQ,GAAE,CAAC,CAAC;YACnD,IAAI,CAAC,OAAO,EAAE;gBACZ,MAAM,IAAI,qBAAa,CACrB,kBAAkB,oBAAQ,yCAAyC,CACpE,CAAC;aACH;YACD,MAAM,EAAC,MAAM,EAAE,UAAU,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;YACzD,IAAI,CAAC,IAAA,kBAAS,EAAC,UAAU,CAAC,IAAI,EAAE,EAAE,cAAc,CAAC,EAAE;gBACjD,IAAI,CAAC,IAAI,CAAC,GAAG,oBAAQ,eAAe,UAAU,SAAS,cAAc,cAAc,CAAC,CAAC;gBACrF,OAAO;aACR;SACF;QAAC,MAAM;YACN,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,OAAO,4BAA4B,CAAC,CAAC;SAC9E;QACD,IAAI,CAAC,EAAE,CAAC,GAAG,oBAAQ,aAAa,CAAC,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,kBAAkB;QAChC,IAAI,aAAqB,CAAC;QAC1B,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,uBAAW,4BAA4B,CAAC,CAAC;SAC7E;QACD,IAAI;YACF,CAAC,EAAC,MAAM,EAAE,aAAa,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE;gBAChD,IAAI;gBACJ,oBAAQ;gBACR,MAAM;gBACN,UAAU;gBACV,MAAM;aACP,CAAC,CAAC,CAAC;SACL;QAAC,MAAM;YACN,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,oBAAQ,4BAA4B,CAAC,CAAC;SAC1E;QAED,IAAI,aAA2B,CAAC;QAChC,IAAI;YACF,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAiB,CAAC;SAC3D;QAAC,MAAM;YACN,MAAM,IAAI,qBAAa,CACrB,8BAA8B,oBAAQ,mBAAmB,aAAa,EAAE,CACzE,CAAC;SACH;QAED,MAAM,UAAU,GAAG,gBAAC,CAAC,SAAS,CAAC,gBAAC,CAAC,KAAK,CAAC,aAAa,EAAE,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;QAC1E,GAAG,CAAC,KAAK,CAAC,+BAA+B,EAAE,UAAU,CAAC,CAAC;QAEvD,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;QAC3D,MAAM,eAAe,GAAiB,EAAE,CAAC;QACzC,MAAM,sBAAsB,GAAiD,EAAE,CAAC;QAChF,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;YACtC,MAAM,OAAO,GAAG,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,CAAC,OAAO,EAAE;gBACZ,eAAe,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;aAC/B;YACD,IAAI,OAAO,KAAK,OAAO,CAAC,OAAO,EAAE;gBAC/B,sBAAsB,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,EAAC,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,EAAC,CAAC,CAAC,CAAC;aACvE;SACF;QAED,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,IAAI,eAAe,CAAC,MAAM,EAAE;YAC1B,QAAQ,CAAC,IAAI,CACX,0BAA0B,IAAA,mBAAS,EACjC,SAAS,EACT,eAAe,CAAC,MAAM,CACvB,yBAAyB,eAAe;iBACtC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,eAAK,EAAA,aAAa,CAAC,CAAC,IAAI,eAAe,CAAC,CAAC,OAAO,GAAG,CAAC;iBAC/D,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;SACH;QACD,IAAI,sBAAsB,CAAC,MAAM,EAAE;YACjC,QAAQ,CAAC,IAAI,CACX,0BAA0B,IAAA,mBAAS,EACjC,SAAS,EACT,sBAAsB,CAAC,MAAM,CAC9B,8CAA8C,sBAAsB;iBAClE,GAAG,CACF,CAAC,CAAC,QAAQ,EAAE,MAAM,CAAC,EAAE,EAAE,CACrB,IAAA,eAAK,EAAA,aAAa,QAAQ,CAAC,IAAI,eAAe,QAAQ,CAAC,OAAO,iBAAiB,MAAM,CAAC,OAAO,IAAI,CACpG;iBACA,IAAI,CAAC,IAAI,CAAC,EAAE,CAChB,CAAC;SACH;QACD,IAAI,QAAQ,CAAC,MAAM,EAAE;YACnB,OAAO,IAAI,CAAC,IAAI,CAAC,oDAAoD,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;SAC/F;QAED,IAAI,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAC;IACpC,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,qBAAqB;QACnC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,IAAI,CAAC,MAAM,IAAA,gBAAW,GAAE,CAAC,CAAC;QAC5D,IAAI,CAAC,UAAU,EAAE;YACf,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,uBAAW,4BAA4B,CAAC,CAAC;SAC7E;QAED,IAAI;YACF,MAAM,EAAC,MAAM,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;gBACpC,OAAO,IAAI,CAAC,IAAI,CACd,4CAA4C,MAAM,6BAA6B,CAChF,CAAC;aACH;SACF;QAAC,MAAM;YACN,OAAO,IAAI,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;SACxD;QACD,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAC/B,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,eAAe;QAC7B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,iBAAyB,CAAC;QAC9B,IAAI,cAAsB,CAAC;QAC3B,IAAI;YACF,CAAC,EAAC,MAAM,EAAE,iBAAiB,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,KAAK,EAAE,CAAC,MAAM,EAAE,wBAAY,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE;gBAC1F,GAAG,EAAE,MAAM;aACZ,CAAC,CAAC,CAAC;SACL;QAAC,MAAM;YACN,OAAO,IAAI,CAAC,IAAI,CAAC,kBAAkB,wBAAY,oBAAoB,MAAM,EAAE,CAAC,CAAC;SAC9E;QAED,IAAI,iBAAiB,EAAE;YACrB,IAAI,KAAK,GAAG,iBAAiB,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;YAC3D,IAAI,KAAK,EAAE;gBACT,cAAc,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;aAC3B;iBAAM;gBACL,MAAM,IAAI,qBAAa,CACrB,2EAA2E,iBAAiB,EAAE,CAC/F,CAAC;aACH;YAED,MAAM,kBAAkB,GAAG,wBAAY,CAAC,YAAa,CAAC,OAAQ,CAAC;YAC/D,IAAI,CAAC,IAAA,kBAAS,EAAC,cAAc,EAAE,kBAAkB,CAAC,EAAE;gBAClD,OAAO,IAAI,CAAC,IAAI,CACd,yBAAyB,cAAc,SAAS,kBAAkB,cAAc,CACjF,CAAC;aACH;YACD,IAAI,CAAC,EAAE,CAAC,oBAAoB,CAAC,CAAC;SAC/B;IACH,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,qBAAqB;QACnC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,qBAAa,CAAC,kCAAkC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;SACnF;QACD,MAAM,eAAe,GAAG,CAAC,IAAI,CAAC,eAAe;YAC3C,IAAI,CAAC,eAAe,IAAI,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,6BAAiB,CAAC,CAAC,CAAC;QAChE,MAAM,kBAAkB,GAAG,IAAA,eAAQ,EAAC,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;QAC/D,IAAI,WAAwB,CAAC;QAE7B,wEAAwE;QACxE,gCAAgC;QAChC,IAAI,eAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;YACnC,IAAI;gBACF,WAAW,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;aACxC;YAAC,OAAO,GAAG,EAAE;gBACZ,MAAM,IAAI,qBAAa,CACrB,qBAAqB,kBAAkB,wBAAwB,GAAG,EAAE,CACrE,CAAC;aACH;SACF;aAAM;YACL,IAAI;gBACF,WAAW,GAAG,IAAA,oBAAe,EAAC,eAAe,CAAC,CAAC;aAChD;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,YAAY,WAAW,EAAE;oBAC5B,OAAO,IAAI,CAAC,IAAI,CACd,IAAI,qBAAa,CAAC,eAAe,6BAAiB,OAAO,kBAAkB,KAAK,CAAC,EAAE,CAAC,CACrF,CAAC;iBACH;gBACD,OAAO,IAAI,CAAC,IAAI,CACd,IAAI,qBAAa,CACf,WAAW,6BAAiB,OAAO,kBAAkB,MAAM,oBAAQ,iBAAiB,CACrF,CACF,CAAC;aACH;SACF;QAED,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE;YACpB,OAAO,IAAI,CAAC,IAAI,CACd,IAAI,qBAAa,CACf,6BAA6B,kBAAkB,WAAW,wCAA4B,iBAAiB,CACxG,CACF,CAAC;SACH;QAED,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAC/B,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,kBAAkB;QAChC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC,IAAI,CAAC,kCAAkC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC;SAChE;QACD,IAAI,iBAAyB,CAAC;QAC9B,IAAI,oBAA4B,CAAC;QACjC,IAAI;YACF,CAAC,EAAC,MAAM,EAAE,oBAAoB,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,oBAAQ,EAAE,CAAC,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,WAAW,CAAC,EAAE;gBACzF,GAAG,EAAE,MAAM;aACZ,CAAC,CAAC,CAAC;SACL;QAAC,MAAM;YACN,OAAO,IAAI,CAAC,IAAI,CAAC,mDAAmD,MAAM,EAAE,CAAC,CAAC;SAC/E;QAED,IAAI,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;QACjE,IAAI,KAAK,EAAE;YACT,iBAAiB,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;SAC9B;aAAM;YACL,OAAO,IAAI,CAAC,IAAI,CACd,0EAA0E,oBAAoB,EAAE,CACjG,CAAC;SACH;QAED,MAAM,qBAAqB,GAAG,wBAAY,CAAC,YAAY,EAAE,UAAU,CAAC;QAEpE,IAAI,CAAC,qBAAqB,EAAE;YAC1B,MAAM,IAAI,qBAAa,CACrB,4BAA4B,2BAAe,OAAO,6BAAiB,kBAAkB,CACtF,CAAC;SACH;QAED,IAAI,CAAC,IAAA,kBAAS,EAAC,iBAAiB,EAAE,qBAAqB,CAAC,EAAE;YACxD,OAAO,IAAI,CAAC,IAAI,CACd,4BAA4B,iBAAiB,SAAS,qBAAqB,cAAc,CAC1F,CAAC;SACH;QACD,IAAI,CAAC,EAAE,CAAC,uBAAuB,CAAC,CAAC;IACnC,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,wBAAwB;QACtC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,UAAU,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,EAAE;YACX,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,qBAAa,CAAC,kCAAkC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;SACnF;QACD,MAAM,gBAAgB,GAAG,CAAC,IAAI,CAAC,gBAAgB;YAC7C,IAAI,CAAC,gBAAgB,IAAI,mBAAI,CAAC,IAAI,CAAC,MAAM,EAAE,8BAAkB,CAAC,CAAC,CAAC;QAClE,MAAM,mBAAmB,GAAG,IAAA,eAAQ,EAAC,IAAI,CAAC,GAAG,EAAE,gBAAgB,CAAC,CAAC;QACjE,IAAI;YACF,MAAM,IAAA,cAAS,EAAC,gBAAgB,CAAC,CAAC;SACnC;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,YAAY,WAAW,EAAE;gBAC5B,OAAO,IAAI,CAAC,IAAI,CACd,IAAI,qBAAa,CAAC,eAAe,8BAAkB,OAAO,mBAAmB,KAAK,CAAC,EAAE,CAAC,CACvF,CAAC;aACH;YACD,OAAO,IAAI,CAAC,IAAI,CACd,IAAI,qBAAa,CACf,WAAW,8BAAkB,OAAO,mBAAmB,MAAM,oBAAQ,iBAAiB,CACvF,CACF,CAAC;SACH;QAED,IAAI,CAAC,EAAE,CAAC,sBAAsB,CAAC,CAAC;IAClC,CAAC;;AA5gBH,sCA6gBC;AA1dC;;;GAGG;AACoB,mBAAK,GAAG,OAAO,CAAC;AACvC;;;GAGG;AACoB,iBAAG,GAAG,KAAK,CAAC;AACnC;;;GAGG;AACoB,qBAAO,GAAG,MAAM,CAAC;AACxC;;;GAGG;AACoB,qBAAO,GAAG,IAAI,CAAC"}
@@ -1,5 +0,0 @@
1
- import { DocutilsValidator } from './validator';
2
- export declare class MkDocsValidator extends DocutilsValidator {
3
- protected validateMkDocs(): Promise<void>;
4
- }
5
- //# sourceMappingURL=mkdocs-validator.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"mkdocs-validator.d.ts","sourceRoot":"","sources":["../../../lib/validation/mkdocs-validator.ts"],"names":[],"mappings":"AAKA,OAAO,EAAC,iBAAiB,EAAC,MAAM,aAAa,CAAC;AAO9C,qBAAa,eAAgB,SAAQ,iBAAiB;cACpC,cAAc;CAyC/B"}
@@ -1,54 +0,0 @@
1
- "use strict";
2
- var __importDefault = (this && this.__importDefault) || function (mod) {
3
- return (mod && mod.__esModule) ? mod : { "default": mod };
4
- };
5
- Object.defineProperty(exports, "__esModule", { value: true });
6
- exports.MkDocsValidator = void 0;
7
- const lodash_1 = __importDefault(require("lodash"));
8
- const teen_process_1 = require("teen_process");
9
- const constants_1 = require("../constants");
10
- const error_1 = require("../error");
11
- const fs_1 = require("../fs");
12
- const validator_1 = require("./validator");
13
- /**
14
- * Matches the MkDocs version string from `mkdocs --version`
15
- */
16
- const MKDOCS_VERSION_REGEX = /mkdocs,\s+version\s+(\d+\.\d+\.\S+)/;
17
- class MkDocsValidator extends validator_1.DocutilsValidator {
18
- async validateMkDocs() {
19
- let mkDocsPath;
20
- try {
21
- mkDocsPath = await (0, fs_1.whichMkDocs)();
22
- }
23
- catch {
24
- // _pretty sure_ the exception code is always ENOENT
25
- return this.fail(`Could not find ${constants_1.NAME_MKDOCS} executable in PATH. If it is installed, check your PATH environment variable.`);
26
- }
27
- let rawMkDocsVersion;
28
- try {
29
- ({ stdout: rawMkDocsVersion } = await (0, teen_process_1.exec)(mkDocsPath, ['--version']));
30
- }
31
- catch (err) {
32
- return this.fail(`${mkDocsPath} --version failed: ${err}`);
33
- }
34
- const match = rawMkDocsVersion.match(MKDOCS_VERSION_REGEX);
35
- if (match) {
36
- const version = match[1];
37
- const reqs = await this.parseRequirementsTxt();
38
- const mkDocsPipPkg = lodash_1.default.find(reqs, { name: constants_1.NAME_MKDOCS });
39
- if (!mkDocsPipPkg) {
40
- throw new error_1.DocutilsError(`No ${constants_1.NAME_MKDOCS} package in ${constants_1.REQUIREMENTS_TXT_PATH}. This is a bug.`);
41
- }
42
- const { version: mkDocsReqdVersion } = mkDocsPipPkg;
43
- if (version !== mkDocsReqdVersion) {
44
- return this.fail(`${constants_1.NAME_MKDOCS} at ${mkDocsPath} is v${version}, but ${constants_1.REQUIREMENTS_TXT_PATH} requires v${mkDocsReqdVersion}`);
45
- }
46
- }
47
- else {
48
- throw new error_1.DocutilsError(`Could not parse version from "${mkDocsPath} --version". This is a bug. Output was ${rawMkDocsVersion}`);
49
- }
50
- this.ok('MkDocs install OK');
51
- }
52
- }
53
- exports.MkDocsValidator = MkDocsValidator;
54
- //# sourceMappingURL=mkdocs-validator.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"mkdocs-validator.js","sourceRoot":"","sources":["../../../lib/validation/mkdocs-validator.ts"],"names":[],"mappings":";;;;;;AAAA,oDAAuB;AACvB,+CAAkC;AAClC,4CAAgE;AAChE,oCAAuC;AACvC,8BAAkC;AAClC,2CAA8C;AAE9C;;GAEG;AACH,MAAM,oBAAoB,GAAG,qCAAqC,CAAC;AAEnE,MAAa,eAAgB,SAAQ,6BAAiB;IAC1C,KAAK,CAAC,cAAc;QAC5B,IAAI,UAA8B,CAAC;QACnC,IAAI;YACF,UAAU,GAAG,MAAM,IAAA,gBAAW,GAAE,CAAC;SAClC;QAAC,MAAM;YACN,oDAAoD;YACpD,OAAO,IAAI,CAAC,IAAI,CACd,kBAAkB,uBAAW,gFAAgF,CAC9G,CAAC;SACH;QAED,IAAI,gBAAoC,CAAC;QACzC,IAAI;YACF,CAAC,EAAC,MAAM,EAAE,gBAAgB,EAAC,GAAG,MAAM,IAAA,mBAAI,EAAC,UAAU,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC;SACtE;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,UAAU,sBAAsB,GAAG,EAAE,CAAC,CAAC;SAC5D;QACD,MAAM,KAAK,GAAG,gBAAgB,CAAC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAC3D,IAAI,KAAK,EAAE;YACT,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YACzB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC/C,MAAM,YAAY,GAAG,gBAAC,CAAC,IAAI,CAAC,IAAI,EAAE,EAAC,IAAI,EAAE,uBAAW,EAAC,CAAC,CAAC;YACvD,IAAI,CAAC,YAAY,EAAE;gBACjB,MAAM,IAAI,qBAAa,CACrB,MAAM,uBAAW,eAAe,iCAAqB,kBAAkB,CACxE,CAAC;aACH;YACD,MAAM,EAAC,OAAO,EAAE,iBAAiB,EAAC,GAAG,YAAY,CAAC;YAClD,IAAI,OAAO,KAAK,iBAAiB,EAAE;gBACjC,OAAO,IAAI,CAAC,IAAI,CACd,GAAG,uBAAW,OAAO,UAAU,QAAQ,OAAO,SAAS,iCAAqB,cAAc,iBAAiB,EAAE,CAC9G,CAAC;aACH;SACF;aAAM;YACL,MAAM,IAAI,qBAAa,CACrB,iCAAiC,UAAU,0CAA0C,gBAAgB,EAAE,CACxG,CAAC;SACH;QAED,IAAI,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC;IAC/B,CAAC;CACF;AA1CD,0CA0CC"}
@@ -1 +0,0 @@
1
- //# sourceMappingURL=python-validator.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"python-validator.d.ts","sourceRoot":"","sources":["../../../lib/validation/python-validator.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=python-validator.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"python-validator.js","sourceRoot":"","sources":["../../../lib/validation/python-validator.ts"],"names":[],"mappings":""}
@@ -1 +0,0 @@
1
- //# sourceMappingURL=python.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"python.d.ts","sourceRoot":"","sources":["../../../lib/validation/python.ts"],"names":[],"mappings":""}
@@ -1,2 +0,0 @@
1
- "use strict";
2
- //# sourceMappingURL=python.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"python.js","sourceRoot":"","sources":["../../../lib/validation/python.ts"],"names":[],"mappings":""}
@@ -1,221 +0,0 @@
1
- /**
2
- * Validates an environment for building documentation
3
- *
4
- * @module
5
- */
6
- /// <reference types="node" />
7
- import { EventEmitter } from 'node:events';
8
- import { NAME_MKDOCS, NAME_NPM, NAME_PYTHON, NAME_TYPEDOC, NAME_TYPESCRIPT } from '../constants';
9
- import { DocutilsError } from '../error';
10
- import { PipPackage } from '../model';
11
- /**
12
- * The "kinds" of validation which were requested to be performed
13
- */
14
- export declare type ValidationKind = typeof NAME_PYTHON | typeof NAME_TYPESCRIPT | typeof NAME_TYPEDOC | typeof NAME_NPM | typeof NAME_MKDOCS;
15
- /**
16
- * This class is designed to run _all_ validation checks (as requested by the user), and emit events for
17
- * each failure encountered.
18
- *
19
- * Whenever a method _rejects or throws_, this is considered an "unexpected" error, and the validation
20
- * will abort.
21
- *
22
- * @todo Use [`strict-event-emitter-types`](https://npm.im/strict-event-emitter-types)
23
- */
24
- export declare class DocutilsValidator extends EventEmitter {
25
- private requirementsTxt;
26
- /**
27
- * Current working directory. Defaults to `process.cwd()`
28
- * @todo This cannot yet be overriden by user
29
- */
30
- protected readonly cwd: string;
31
- /**
32
- * Path to `npm` executable.
33
- */
34
- protected readonly npmPath: string | undefined;
35
- /**
36
- * Path to `python` executable.
37
- */
38
- protected readonly pythonPath: string | undefined;
39
- /**
40
- * List of validations to perform
41
- */
42
- protected readonly _validations: Set<ValidationKind>;
43
- /**
44
- * Mapping of error messages to errors.
45
- *
46
- * Used to prevent duplicate emission of errors and track error count; if non-empty, the validation
47
- * process should be considered to have failed.
48
- *
49
- * Reset after {@linkcode DocutilsValidator.validate validate} completes.
50
- */
51
- protected emittedErrors: Map<string, DocutilsError>;
52
- /**
53
- * Path to `mkdocs.yml`. If not provided, will be lazily resolved.
54
- */
55
- protected mkDocsYmlPath: string | undefined;
56
- /**
57
- * Path to `package.json`. If not provided, will be lazily resolved.
58
- */
59
- protected packageJsonPath: string | undefined;
60
- /**
61
- * Path to the package directory. If not provided, will be lazily resolved.
62
- */
63
- protected pkgDir: string | undefined;
64
- /**
65
- * Path to `tsconfig.json`. If not provided, will be lazily resolved.
66
- */
67
- protected tsconfigJsonPath: string | undefined;
68
- /**
69
- * Path to `typedoc.json`. If not provided, will be lazily resolved.
70
- */
71
- protected typeDocJsonPath: string | undefined;
72
- /**
73
- * Emitted when validation begins with a list of validation kinds to be performed
74
- * @event
75
- */
76
- static readonly BEGIN = "begin";
77
- /**
78
- * Emitted when validation ends with an error count
79
- * @event
80
- */
81
- static readonly END = "end";
82
- /**
83
- * Emitted when a validation fails, with the associated {@linkcode DocutilsError}
84
- * @event
85
- */
86
- static readonly FAILURE = "fail";
87
- /**
88
- * Emitted when a validation succeeds
89
- * @event
90
- */
91
- static readonly SUCCESS = "ok";
92
- readonly opts: DocutilsValidatorOpts;
93
- /**
94
- * Creates a listener to track errors emitted
95
- */
96
- constructor(opts?: Partial<DocutilsValidatorOpts>);
97
- get errorCount(): number;
98
- get validations(): ValidationKind[];
99
- /**
100
- * Runs the configured validations, then resets internal state upon completion or rejection.
101
- */
102
- validate(): Promise<void>;
103
- /**
104
- * If a thing like `err` has not already been emitted, emit
105
- * {@linkcode DocutilsValidator.FAILURE}.
106
- * @param err A validation error
107
- * @returns
108
- */
109
- protected fail(err: DocutilsError | string): void;
110
- /**
111
- * Resolves with a the parent directory of `package.json`, if we can find it.
112
- */
113
- protected findPkgDir(): Promise<string | undefined>;
114
- /**
115
- * Emits a {@linkcode DocutilsValidator.SUCCESS} event
116
- * @param message Success message
117
- */
118
- protected ok(message: string): void;
119
- /**
120
- * Parses a `requirements.txt` file and returns an array of packages
121
- *
122
- * Caches the result.
123
- * @returns List of package data w/ name and version
124
- */
125
- protected parseRequirementsTxt(): Promise<PipPackage[]>;
126
- /**
127
- * Resets the cache of emitted errors
128
- */
129
- protected reset(): void;
130
- protected validateMkDocs(): Promise<void>;
131
- /**
132
- * Validates (sort of) an `mkdocs.yml` config file.
133
- *
134
- * It checks if the file exists, if it can be parsed as YAML, and if it has a `site_name` property.
135
- */
136
- protected validateMkDocsConfig(mkDocsYmlPath?: string): Promise<void>;
137
- /**
138
- * Validates that the version of `npm` matches what's described in this package's `engines` field.
139
- *
140
- * This is required because other validators need `npm exec` to work, which is only available in npm 7+.
141
- */
142
- protected validateNpmVersion(): Promise<void>;
143
- /**
144
- * Asserts that the dependencies as listed in `requirements.txt` are installed.
145
- *
146
- * @privateRemarks This lists all installed packages with `pip` and then compares them to the
147
- * contents of our `requirements.txt`. Versions _must_ match exactly.
148
- */
149
- protected validatePythonDeps(): Promise<void>;
150
- /**
151
- * Asserts that the Python version is 3.x
152
- */
153
- protected validatePythonVersion(): Promise<void>;
154
- /**
155
- * Asserts TypeDoc is installed, runnable, the correct version, and that the config file is readable
156
- * and constaints required options
157
- */
158
- protected validateTypeDoc(): Promise<void>;
159
- /**
160
- * Validates the `typedoc.json` file
161
- */
162
- protected validateTypeDocConfig(): Promise<void>;
163
- /**
164
- * Asserts that TypeScript is installed, runnable, the correct version, and a parseable `tsconfig.json` exists.
165
- */
166
- protected validateTypeScript(): Promise<void>;
167
- /**
168
- * Validates a `tsconfig.json` file
169
- */
170
- protected validateTypeScriptConfig(): Promise<void>;
171
- }
172
- /**
173
- * Options for {@linkcode DocutilsValidator} constructor
174
- */
175
- export interface DocutilsValidatorOpts {
176
- /**
177
- * Current working directory
178
- */
179
- cwd: string;
180
- /**
181
- * If `true`, run MkDocs validation
182
- */
183
- mkdocs?: boolean;
184
- /**
185
- * Path to `mkdocs.yml`
186
- */
187
- mkdocsYml?: string;
188
- /**
189
- * Path to `npm` executable
190
- */
191
- npm?: string;
192
- /**
193
- * Path to `package.json`
194
- */
195
- packageJson?: string;
196
- /**
197
- * If `true`, run Python validation
198
- */
199
- python?: boolean;
200
- /**
201
- * Path to `python` executable
202
- */
203
- pythonPath?: string;
204
- /**
205
- * Path to `tsconfig.json`
206
- */
207
- tsconfigJson?: string;
208
- /**
209
- * If `true`, run TypeDoc validation
210
- */
211
- typedoc?: boolean;
212
- /**
213
- * Path to `typedoc.json`
214
- */
215
- typedocJson?: string;
216
- /**
217
- * If `true`, run TypeScript validation
218
- */
219
- typescript?: boolean;
220
- }
221
- //# sourceMappingURL=validate.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"validate.d.ts","sourceRoot":"","sources":["../../../lib/validation/validate.ts"],"names":[],"mappings":"AAAA;;;;GAIG;;AAKH,OAAO,EAAC,YAAY,EAAC,MAAM,aAAa,CAAC;AAKzC,OAAO,EAKL,WAAW,EAEX,QAAQ,EAGR,WAAW,EAGX,YAAY,EAEZ,eAAe,EAEhB,MAAM,cAAc,CAAC;AACtB,OAAO,EAAC,aAAa,EAAC,MAAM,UAAU,CAAC;AAYvC,OAAO,EAAY,UAAU,EAAc,MAAM,UAAU,CAAC;AAyB5D;;GAEG;AACH,oBAAY,cAAc,GACtB,OAAO,WAAW,GAClB,OAAO,eAAe,GACtB,OAAO,YAAY,GACnB,OAAO,QAAQ,GACf,OAAO,WAAW,CAAC;AAEvB;;;;;;;;GAQG;AACH,qBAAa,iBAAkB,SAAQ,YAAY;IACjD,OAAO,CAAC,eAAe,CAA2B;IAElD;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAC/B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,SAAS,CAAC;IAClD;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,sBAA6B;IAE5D;;;;;;;OAOG;IACH,SAAS,CAAC,aAAa,6BAAoC;IAC3D;;OAEG;IACH,SAAS,CAAC,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9C;;OAEG;IACH,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IACrC;;OAEG;IACH,SAAS,CAAC,gBAAgB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC/C;;OAEG;IACH,SAAS,CAAC,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IAE9C;;;OAGG;IACH,gBAAuB,KAAK,WAAW;IACvC;;;OAGG;IACH,gBAAuB,GAAG,SAAS;IACnC;;;OAGG;IACH,gBAAuB,OAAO,UAAU;IACxC;;;OAGG;IACH,gBAAuB,OAAO,QAAQ;IAEtC,SAAgB,IAAI,EAAE,qBAAqB,CAAC;IAE5C;;OAEG;gBACS,IAAI,GAAE,OAAO,CAAC,qBAAqB,CAAM;IAkCrD,IAAW,UAAU,WAEpB;IAED,IAAW,WAAW,qBAErB;IAED;;OAEG;IACU,QAAQ;IAkCrB;;;;;OAKG;IACH,SAAS,CAAC,IAAI,CAAC,GAAG,EAAE,aAAa,GAAG,MAAM;IAO1C;;OAEG;cACa,UAAU,IAAI,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IASzD;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,MAAM;IAI5B;;;;;OAKG;cACa,oBAAoB,IAAI,OAAO,CAAC,UAAU,EAAE,CAAC;IAuB7D;;OAEG;IACH,SAAS,CAAC,KAAK;cAIC,cAAc;IA0C9B;;;;OAIG;cACa,oBAAoB,CAAC,aAAa,CAAC,EAAE,MAAM;IA2B3D;;;;OAIG;cACa,kBAAkB;IAuBlC;;;;;OAKG;cACa,kBAAkB;IA0ElC;;OAEG;cACa,qBAAqB;IAmBrC;;;OAGG;cACa,eAAe;IAgC/B;;OAEG;cACa,qBAAqB;IAgDrC;;OAEG;cACa,kBAAkB;IAwClC;;OAEG;cACa,wBAAwB;CAyBzC;AAED;;GAEG;AAEH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB"}