@cparra/apexdocs 2.24.0 → 2.25.0-alpha.1

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 (375) hide show
  1. package/.github/workflows/ci.yaml +22 -0
  2. package/.github/workflows/close_stale.yml +22 -22
  3. package/.prettierrc.js +7 -7
  4. package/LICENSE +21 -21
  5. package/README.md +742 -718
  6. package/__mocks__/chalk.js +12 -0
  7. package/__mocks__/log-update.js +6 -0
  8. package/apexdocs.config.ts +13 -13
  9. package/docs/{README.md → __old/README.md} +1 -1
  10. package/docs/{restapi.json → __old/restapi.json} +589 -589
  11. package/docs/{types → __old/types}/Classes/nspc.ChildClass.md +97 -97
  12. package/docs/{types → __old/types}/Main/nspc.SampleClass.md +189 -189
  13. package/eslint.config.mjs +10 -0
  14. package/examples/force-app/main/default/classes/AnotherInterface.cls +16 -16
  15. package/examples/force-app/main/default/classes/ChildClass.cls +42 -42
  16. package/examples/force-app/main/default/classes/EscapedAnnotations.cls +5 -5
  17. package/examples/force-app/main/default/classes/GrandparentClass.cls +4 -4
  18. package/examples/force-app/main/default/classes/GroupedClass.cls +8 -8
  19. package/examples/force-app/main/default/classes/MemberGrouping.cls +17 -17
  20. package/examples/force-app/main/default/classes/ParentClass.cls +16 -16
  21. package/examples/force-app/main/default/classes/SampleClass.cls +166 -166
  22. package/examples/force-app/main/default/classes/SampleClass.cls-meta.xml +5 -5
  23. package/examples/force-app/main/default/classes/SampleClassWithoutModifier.cls +9 -9
  24. package/examples/force-app/main/default/classes/SampleInterface.cls +16 -16
  25. package/examples/force-app/main/default/restapi/SampleRestResource.cls +195 -195
  26. package/examples/force-app/main/default/restapi/SampleRestResourceToSkip.cls +35 -35
  27. package/examples/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls +24 -24
  28. package/examples/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls +15 -15
  29. package/examples/force-app/main/default/restapi/references/Reference1.cls +9 -9
  30. package/examples/force-app/main/default/restapi/references/Reference2.cls +9 -9
  31. package/examples/force-app/main/default/restapi/references/Reference3.cls +3 -3
  32. package/examples/force-app/main/default/restapi/references/Reference4.cls +3 -3
  33. package/examples/force-app/main/default/restapi/references/Reference5.cls +3 -3
  34. package/examples/force-app/main/default/restapi/references/Reference6.cls +6 -6
  35. package/examples/force-app/main/default/restapi/references/Reference7.cls +3 -3
  36. package/examples/includes/header.md +3 -3
  37. package/examples/plain-markdown/.forceignore +12 -0
  38. package/examples/plain-markdown/config/project-scratch-def.json +5 -0
  39. package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +16 -0
  40. package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +15 -0
  41. package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +8 -0
  42. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +7 -0
  43. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +115 -0
  44. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +36 -0
  45. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +173 -0
  46. package/examples/plain-markdown/docs/index.md +36 -0
  47. package/examples/plain-markdown/force-app/classes/BaseClass.cls +3 -0
  48. package/examples/plain-markdown/force-app/classes/ParentInterface.cls +3 -0
  49. package/examples/plain-markdown/force-app/classes/ReferencedEnum.cls +3 -0
  50. package/examples/plain-markdown/force-app/classes/SampleClass.cls +72 -0
  51. package/examples/plain-markdown/force-app/classes/SampleEnum.cls +30 -0
  52. package/examples/plain-markdown/force-app/classes/SampleException.cls +1 -0
  53. package/examples/plain-markdown/force-app/classes/SampleInterface.cls +46 -0
  54. package/examples/plain-markdown/package-lock.json +665 -0
  55. package/examples/plain-markdown/package.json +20 -0
  56. package/examples/plain-markdown/sfdx-project.json +12 -0
  57. package/examples/plain-markdown/template.md +3 -0
  58. package/jest.config.js +9 -5
  59. package/jest.d.ts +7 -0
  60. package/lib/__spec__/core/expect-extensions.d.ts +3 -0
  61. package/lib/__spec__/core/expect-extensions.js +54 -0
  62. package/lib/__spec__/core/expect-extensions.js.map +1 -0
  63. package/lib/__spec__/core/generating-class-docs.spec.d.ts +1 -0
  64. package/lib/__spec__/core/generating-class-docs.spec.js +427 -0
  65. package/lib/__spec__/core/generating-class-docs.spec.js.map +1 -0
  66. package/lib/__spec__/core/generating-enum-docs.spec.d.ts +1 -0
  67. package/lib/__spec__/core/generating-enum-docs.spec.js +303 -0
  68. package/lib/__spec__/core/generating-enum-docs.spec.js.map +1 -0
  69. package/lib/__spec__/core/generating-interface-docs.spec.d.ts +1 -0
  70. package/lib/__spec__/core/generating-interface-docs.spec.js +361 -0
  71. package/lib/__spec__/core/generating-interface-docs.spec.js.map +1 -0
  72. package/lib/__spec__/core/generating-reference-guide.spec.d.ts +1 -0
  73. package/lib/__spec__/core/generating-reference-guide.spec.js +161 -0
  74. package/lib/__spec__/core/generating-reference-guide.spec.js.map +1 -0
  75. package/lib/adapters/apex-types.d.ts +7 -0
  76. package/lib/adapters/apex-types.js +112 -0
  77. package/lib/adapters/apex-types.js.map +1 -0
  78. package/lib/adapters/documentables.d.ts +7 -0
  79. package/lib/adapters/documentables.js +56 -0
  80. package/lib/adapters/documentables.js.map +1 -0
  81. package/lib/adapters/fields-and-properties.d.ts +4 -0
  82. package/lib/adapters/fields-and-properties.js +32 -0
  83. package/lib/adapters/fields-and-properties.js.map +1 -0
  84. package/lib/adapters/methods-and-constructors.d.ts +5 -0
  85. package/lib/adapters/methods-and-constructors.js +92 -0
  86. package/lib/adapters/methods-and-constructors.js.map +1 -0
  87. package/lib/adapters/references.d.ts +5 -0
  88. package/lib/adapters/references.js +82 -0
  89. package/lib/adapters/references.js.map +1 -0
  90. package/lib/adapters/type-utils.d.ts +2 -0
  91. package/lib/adapters/type-utils.js +7 -0
  92. package/lib/adapters/type-utils.js.map +1 -0
  93. package/lib/application/Apexdocs.d.ts +13 -13
  94. package/lib/application/Apexdocs.js +79 -76
  95. package/lib/application/Apexdocs.js.map +1 -1
  96. package/lib/cli/generate.d.ts +2 -2
  97. package/lib/cli/generate.js +156 -130
  98. package/lib/cli/generate.js.map +1 -1
  99. package/lib/core/generate-docs.d.ts +23 -0
  100. package/lib/core/generate-docs.js +241 -0
  101. package/lib/core/generate-docs.js.map +1 -0
  102. package/lib/core/template.d.ts +10 -0
  103. package/lib/core/template.js +92 -0
  104. package/lib/core/template.js.map +1 -0
  105. package/lib/core/templates/reference-guide.d.ts +1 -0
  106. package/lib/core/templates/reference-guide.js +18 -0
  107. package/lib/core/templates/reference-guide.js.map +1 -0
  108. package/lib/index.d.ts +2 -1
  109. package/lib/index.js +28 -17
  110. package/lib/index.js.map +1 -1
  111. package/lib/model/apex-bundle.d.ts +6 -6
  112. package/lib/model/apex-bundle.js +10 -10
  113. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +7 -7
  114. package/lib/model/apex-type-wrappers/ClassMirrorWrapper.js +13 -13
  115. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +7 -7
  116. package/lib/model/apex-type-wrappers/MethodMirrorWrapper.js +11 -11
  117. package/lib/model/inheritance.d.ts +8 -8
  118. package/lib/model/inheritance.js +2 -2
  119. package/lib/model/manifest.d.ts +22 -22
  120. package/lib/model/manifest.js +52 -46
  121. package/lib/model/manifest.js.map +1 -1
  122. package/lib/model/markdown-file.d.ts +16 -16
  123. package/lib/model/markdown-file.js +110 -106
  124. package/lib/model/markdown-file.js.map +1 -1
  125. package/lib/model/markdown-generation-util/doc-comment-annotation-util.d.ts +8 -8
  126. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +45 -43
  127. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -1
  128. package/lib/model/markdown-generation-util/field-declaration-util.d.ts +3 -3
  129. package/lib/model/markdown-generation-util/field-declaration-util.js +53 -54
  130. package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -1
  131. package/lib/model/markdown-generation-util/index.d.ts +3 -3
  132. package/lib/model/markdown-generation-util/index.js +19 -19
  133. package/lib/model/markdown-generation-util/method-declaration-util.d.ts +4 -4
  134. package/lib/model/markdown-generation-util/method-declaration-util.js +113 -114
  135. package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -1
  136. package/lib/model/markdown-generation-util/type-declaration-util.d.ts +3 -3
  137. package/lib/model/markdown-generation-util/type-declaration-util.js +80 -81
  138. package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -1
  139. package/lib/model/markdown-home-file.d.ts +11 -11
  140. package/lib/model/markdown-home-file.js +56 -53
  141. package/lib/model/markdown-home-file.js.map +1 -1
  142. package/lib/model/markdown-type-file.d.ts +26 -26
  143. package/lib/model/markdown-type-file.js +136 -133
  144. package/lib/model/markdown-type-file.js.map +1 -1
  145. package/lib/model/openapi/apex-doc-types.d.ts +19 -19
  146. package/lib/model/openapi/apex-doc-types.js +4 -4
  147. package/lib/model/openapi/open-api-types.d.ts +93 -93
  148. package/lib/model/openapi/open-api-types.js +2 -2
  149. package/lib/model/openapi/open-api.d.ts +16 -16
  150. package/lib/model/openapi/open-api.js +33 -33
  151. package/lib/model/openapi/open-api.js.map +1 -1
  152. package/lib/model/openapi/openapi-type-file.d.ts +7 -7
  153. package/lib/model/openapi/openapi-type-file.js +16 -16
  154. package/lib/model/outputFile.d.ts +10 -10
  155. package/lib/model/outputFile.js +21 -28
  156. package/lib/model/outputFile.js.map +1 -1
  157. package/lib/model/types-repository.d.ts +16 -16
  158. package/lib/model/types-repository.js +53 -53
  159. package/lib/model/types-repository.js.map +1 -1
  160. package/lib/service/apex-file-reader.d.ts +14 -14
  161. package/lib/service/apex-file-reader.js +48 -45
  162. package/lib/service/apex-file-reader.js.map +1 -1
  163. package/lib/service/file-system.d.ts +14 -14
  164. package/lib/service/file-system.js +47 -24
  165. package/lib/service/file-system.js.map +1 -1
  166. package/lib/service/file-writer.d.ts +6 -6
  167. package/lib/service/file-writer.js +56 -33
  168. package/lib/service/file-writer.js.map +1 -1
  169. package/lib/service/manifest-factory.d.ts +10 -10
  170. package/lib/service/manifest-factory.js +15 -13
  171. package/lib/service/manifest-factory.js.map +1 -1
  172. package/lib/service/metadata-processor.d.ts +3 -3
  173. package/lib/service/metadata-processor.js +16 -16
  174. package/lib/service/metadata-processor.js.map +1 -1
  175. package/lib/service/parser.d.ts +21 -21
  176. package/lib/service/parser.js +137 -134
  177. package/lib/service/parser.js.map +1 -1
  178. package/lib/service/state.d.ts +9 -9
  179. package/lib/service/state.js +19 -19
  180. package/lib/service/state.js.map +1 -1
  181. package/lib/service/walkers/class-walker.d.ts +4 -4
  182. package/lib/service/walkers/class-walker.js +32 -32
  183. package/lib/service/walkers/class-walker.js.map +1 -1
  184. package/lib/service/walkers/enum-walker.d.ts +4 -4
  185. package/lib/service/walkers/enum-walker.js +10 -10
  186. package/lib/service/walkers/interface-walker.d.ts +4 -4
  187. package/lib/service/walkers/interface-walker.js +14 -14
  188. package/lib/service/walkers/interface-walker.js.map +1 -1
  189. package/lib/service/walkers/walker-factory.d.ts +5 -5
  190. package/lib/service/walkers/walker-factory.js +20 -20
  191. package/lib/service/walkers/walker-factory.js.map +1 -1
  192. package/lib/service/walkers/walker.d.ts +19 -19
  193. package/lib/service/walkers/walker.js +16 -16
  194. package/lib/service/walkers/walker.js.map +1 -1
  195. package/lib/settings.d.ts +64 -64
  196. package/lib/settings.js +88 -88
  197. package/lib/settings.js.map +1 -1
  198. package/lib/test-helpers/AnnotationBuilder.d.ts +12 -12
  199. package/lib/test-helpers/AnnotationBuilder.js +30 -30
  200. package/lib/test-helpers/ClassMirrorBuilder.d.ts +18 -18
  201. package/lib/test-helpers/ClassMirrorBuilder.js +53 -53
  202. package/lib/test-helpers/DocCommentAnnotationBuilder.d.ts +8 -8
  203. package/lib/test-helpers/DocCommentAnnotationBuilder.js +25 -25
  204. package/lib/test-helpers/DocCommentBuilder.d.ts +12 -12
  205. package/lib/test-helpers/DocCommentBuilder.js +37 -37
  206. package/lib/test-helpers/FieldMirrorBuilder.d.ts +18 -18
  207. package/lib/test-helpers/FieldMirrorBuilder.js +53 -53
  208. package/lib/test-helpers/InterfaceMirrorBuilder.d.ts +16 -0
  209. package/lib/test-helpers/InterfaceMirrorBuilder.js +43 -0
  210. package/lib/test-helpers/InterfaceMirrorBuilder.js.map +1 -0
  211. package/lib/test-helpers/MethodMirrorBuilder.d.ts +29 -10
  212. package/lib/test-helpers/MethodMirrorBuilder.js +71 -36
  213. package/lib/test-helpers/MethodMirrorBuilder.js.map +1 -1
  214. package/lib/test-helpers/SettingsBuilder.d.ts +8 -8
  215. package/lib/test-helpers/SettingsBuilder.js +26 -26
  216. package/lib/transpiler/factory.d.ts +6 -6
  217. package/lib/transpiler/factory.js +34 -31
  218. package/lib/transpiler/factory.js.map +1 -1
  219. package/lib/transpiler/file-container.d.ts +6 -6
  220. package/lib/transpiler/file-container.js +15 -15
  221. package/lib/transpiler/generator-choices.d.ts +1 -1
  222. package/lib/transpiler/generator-choices.js +2 -2
  223. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +11 -8
  224. package/lib/transpiler/markdown/class-file-generatorHelper.js +74 -55
  225. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
  226. package/lib/transpiler/markdown/docsify/docsify-docs-processor.d.ts +6 -6
  227. package/lib/transpiler/markdown/docsify/docsify-docs-processor.js +12 -12
  228. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +11 -11
  229. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js +50 -50
  230. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -1
  231. package/lib/transpiler/markdown/markdown-transpiler-base.d.ts +11 -11
  232. package/lib/transpiler/markdown/markdown-transpiler-base.js +26 -23
  233. package/lib/transpiler/markdown/markdown-transpiler-base.js.map +1 -1
  234. package/lib/transpiler/markdown/plain-markdown/class-template.d.ts +1 -0
  235. package/lib/transpiler/markdown/plain-markdown/class-template.js +77 -0
  236. package/lib/transpiler/markdown/plain-markdown/class-template.js.map +1 -0
  237. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +1 -0
  238. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +36 -0
  239. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +1 -0
  240. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +1 -0
  241. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +28 -0
  242. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -0
  243. package/lib/transpiler/markdown/plain-markdown/enum-template.d.ts +1 -0
  244. package/lib/transpiler/markdown/plain-markdown/enum-template.js +16 -0
  245. package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +1 -0
  246. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +1 -0
  247. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +27 -0
  248. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +1 -0
  249. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +1 -0
  250. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +10 -0
  251. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +1 -0
  252. package/lib/transpiler/markdown/plain-markdown/interface-template.d.ts +1 -0
  253. package/lib/transpiler/markdown/plain-markdown/interface-template.js +20 -0
  254. package/lib/transpiler/markdown/plain-markdown/interface-template.js.map +1 -0
  255. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +1 -0
  256. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +47 -0
  257. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +1 -0
  258. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +9 -6
  259. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +41 -13
  260. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -1
  261. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +1 -0
  262. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js +31 -0
  263. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js.map +1 -0
  264. package/lib/transpiler/openapi/open-api-docs-processor.d.ts +13 -13
  265. package/lib/transpiler/openapi/open-api-docs-processor.js +77 -74
  266. package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -1
  267. package/lib/transpiler/openapi/parsers/Builder.d.ts +16 -16
  268. package/lib/transpiler/openapi/parsers/Builder.js +29 -29
  269. package/lib/transpiler/openapi/parsers/Builder.js.map +1 -1
  270. package/lib/transpiler/openapi/parsers/MethodParser.d.ts +20 -20
  271. package/lib/transpiler/openapi/parsers/MethodParser.js +189 -166
  272. package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -1
  273. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +7 -7
  274. package/lib/transpiler/openapi/parsers/ParameterObjectBuilder.js +10 -10
  275. package/lib/transpiler/openapi/parsers/ReferenceBuilder.d.ts +39 -39
  276. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +249 -225
  277. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -1
  278. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +10 -10
  279. package/lib/transpiler/openapi/parsers/RequestBodyBuilder.js +19 -19
  280. package/lib/transpiler/openapi/parsers/ResponsesBuilder.d.ts +7 -7
  281. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js +21 -21
  282. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +1 -1
  283. package/lib/transpiler/processor-type-transpiler.d.ts +10 -10
  284. package/lib/transpiler/processor-type-transpiler.js +8 -8
  285. package/lib/transpiler/transpiler.d.ts +5 -5
  286. package/lib/transpiler/transpiler.js +29 -26
  287. package/lib/transpiler/transpiler.js.map +1 -1
  288. package/lib/util/error-logger.d.ts +8 -8
  289. package/lib/util/error-logger.js +89 -89
  290. package/lib/util/error-logger.js.map +1 -1
  291. package/lib/util/logger.d.ts +21 -21
  292. package/lib/util/logger.js +60 -57
  293. package/lib/util/logger.js.map +1 -1
  294. package/lib/util/string-utils.d.ts +2 -2
  295. package/lib/util/string-utils.js +14 -14
  296. package/lib/util/string-utils.js.map +1 -1
  297. package/package.json +79 -78
  298. package/src/__spec__/core/expect-extensions.ts +32 -0
  299. package/src/__spec__/core/generating-class-docs.spec.ts +511 -0
  300. package/src/__spec__/core/generating-enum-docs.spec.ts +355 -0
  301. package/src/__spec__/core/generating-interface-docs.spec.ts +431 -0
  302. package/src/__spec__/core/generating-reference-guide.spec.ts +163 -0
  303. package/src/adapters/__tests__/interface-adapter.spec.ts +80 -0
  304. package/src/adapters/__tests__/references.spec.ts +115 -0
  305. package/src/adapters/apex-types.ts +224 -0
  306. package/src/adapters/documentables.ts +93 -0
  307. package/src/adapters/fields-and-properties.ts +38 -0
  308. package/src/adapters/methods-and-constructors.ts +117 -0
  309. package/src/adapters/references.ts +113 -0
  310. package/src/adapters/type-utils.ts +5 -0
  311. package/src/adapters/types.d.ts +8 -0
  312. package/src/cli/generate.ts +96 -93
  313. package/src/core/generate-docs.ts +357 -0
  314. package/src/core/renderable/types.d.ts +131 -0
  315. package/src/core/template.ts +108 -0
  316. package/src/core/templates/reference-guide.ts +14 -0
  317. package/src/index.ts +3 -1
  318. package/src/model/__tests__/manifest.spec.ts +1 -0
  319. package/src/model/manifest.ts +15 -5
  320. package/src/model/markdown-file.ts +6 -5
  321. package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +1 -1
  322. package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
  323. package/src/model/openapi/open-api-types.ts +2 -2
  324. package/src/model/outputFile.ts +2 -11
  325. package/src/service/__tests__/apex-file-reader.spec.ts +4 -4
  326. package/src/service/__tests__/manifest-factory.spec.ts +1 -2
  327. package/src/service/parser.ts +1 -1
  328. package/src/test-helpers/FieldMirrorBuilder.ts +1 -1
  329. package/src/test-helpers/InterfaceMirrorBuilder.ts +44 -0
  330. package/src/test-helpers/MethodMirrorBuilder.ts +46 -6
  331. package/src/transpiler/markdown/class-file-generatorHelper.ts +22 -2
  332. package/src/transpiler/markdown/plain-markdown/class-template.ts +73 -0
  333. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +32 -0
  334. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +24 -0
  335. package/src/transpiler/markdown/plain-markdown/enum-template.ts +12 -0
  336. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +23 -0
  337. package/src/transpiler/markdown/plain-markdown/grouped-members-partial-template.ts +6 -0
  338. package/src/transpiler/markdown/plain-markdown/interface-template.ts +16 -0
  339. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +43 -0
  340. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +30 -0
  341. package/src/transpiler/markdown/plain-markdown/type-doc-partial.ts +27 -0
  342. package/src/transpiler/openapi/parsers/Builder.ts +1 -1
  343. package/src/transpiler/openapi/parsers/MethodParser.ts +1 -1
  344. package/src/transpiler/openapi/parsers/ReferenceBuilder.ts +4 -3
  345. package/src/util/error-logger.ts +4 -4
  346. package/src/util/logger.ts +3 -3
  347. package/tsconfig.json +21 -20
  348. package/tslint.json +5 -5
  349. package/.eslintrc.js +0 -12
  350. package/lib/model/manifest-diff.d.ts +0 -27
  351. package/lib/model/manifest-diff.js +0 -69
  352. package/lib/model/manifest-diff.js.map +0 -1
  353. package/src/model/__tests__/manifest-diff.spec.ts +0 -139
  354. package/src/model/manifest-diff.ts +0 -94
  355. /package/docs/{index.html → __old/index.html} +0 -0
  356. /package/docs/{types → __old/types}/Classes/nspc.AnotherInterface.md +0 -0
  357. /package/docs/{types → __old/types}/Main/nspc.GroupedClass.md +0 -0
  358. /package/docs/{types → __old/types}/Misc-Group/nspc.EscapedAnnotations.md +0 -0
  359. /package/docs/{types → __old/types}/Misc-Group/nspc.GrandparentClass.md +0 -0
  360. /package/docs/{types → __old/types}/Misc-Group/nspc.InterfaceWithInheritance.md +0 -0
  361. /package/docs/{types → __old/types}/Misc-Group/nspc.MemberGrouping.md +0 -0
  362. /package/docs/{types → __old/types}/Misc-Group/nspc.ParentClass.md +0 -0
  363. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference1.md +0 -0
  364. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference2.md +0 -0
  365. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference3.md +0 -0
  366. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference4.md +0 -0
  367. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference5.md +0 -0
  368. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference6.md +0 -0
  369. /package/docs/{types → __old/types}/Misc-Group/nspc.Reference7.md +0 -0
  370. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -0
  371. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResource.md +0 -0
  372. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -0
  373. /package/docs/{types → __old/types}/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -0
  374. /package/docs/{types → __old/types}/README.md +0 -0
  375. /package/docs/{types → __old/types}/Sample-Interfaces/nspc.SampleInterface.md +0 -0
@@ -1,22 +1,22 @@
1
- import { Type, Annotation, DocComment } from '@cparra/apex-reflection';
2
- type AccessAndDocAware = {
3
- access_modifier: string;
4
- annotations: Annotation[];
5
- docComment?: DocComment;
6
- };
7
- /**
8
- * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
9
- */
10
- export default class Manifest {
11
- types: Type[];
12
- isForInnerTypes: boolean;
13
- /**
14
- * Constructs a new Manifest object.
15
- * @param types List of types to be wrapped by this object.
16
- * @param isForInnerTypes Whether this manifest represent an inner type or not.
17
- */
18
- constructor(types: Type[], isForInnerTypes?: boolean);
19
- filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
20
- filterAccessibleModifier(accessAndDocAwares: AccessAndDocAware[], modifiers: string[]): AccessAndDocAware[];
21
- }
22
- export {};
1
+ import { Type, Annotation, DocComment } from '@cparra/apex-reflection';
2
+ type AccessAndDocAware = {
3
+ access_modifier: string;
4
+ annotations: Annotation[];
5
+ docComment?: DocComment;
6
+ };
7
+ /**
8
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
9
+ */
10
+ export default class Manifest {
11
+ types: Type[];
12
+ isForInnerTypes: boolean;
13
+ /**
14
+ * Constructs a new Manifest object.
15
+ * @param types List of types to be wrapped by this object.
16
+ * @param isForInnerTypes Whether this manifest represent an inner type or not.
17
+ */
18
+ constructor(types: Type[], isForInnerTypes?: boolean);
19
+ filteredByAccessModifierAndAnnotations(modifiers: string[]): Type[];
20
+ filterAccessibleModifier(accessAndDocAware: AccessAndDocAware[], modifiers: string[]): AccessAndDocAware[];
21
+ }
22
+ export {};
@@ -1,47 +1,53 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- /**
4
- * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
5
- */
6
- class Manifest {
7
- /**
8
- * Constructs a new Manifest object.
9
- * @param types List of types to be wrapped by this object.
10
- * @param isForInnerTypes Whether this manifest represent an inner type or not.
11
- */
12
- constructor(types, isForInnerTypes = false) {
13
- this.types = types;
14
- this.isForInnerTypes = isForInnerTypes;
15
- }
16
- filteredByAccessModifierAndAnnotations(modifiers) {
17
- const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
18
- const typesToReturn = [];
19
- for (const filteredType of filteredTypes) {
20
- const currentType = filteredType;
21
- if (currentType.type_name !== 'class') {
22
- typesToReturn.push(currentType);
23
- continue;
24
- }
25
- const currentClass = currentType;
26
- let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
27
- if (!this.isForInnerTypes) {
28
- filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
29
- }
30
- typesToReturn.push(filteredClass);
31
- }
32
- return typesToReturn;
33
- }
34
- filterAccessibleModifier(accessAndDocAwares, modifiers) {
35
- return accessAndDocAwares.filter((currentType) => {
36
- var _a;
37
- const hasIgnoreDocAnnotation = (_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name === 'ignore');
38
- if (hasIgnoreDocAnnotation) {
39
- return false;
40
- }
41
- return (modifiers.includes(currentType.access_modifier) ||
42
- currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
43
- });
44
- }
45
- }
46
- exports.default = Manifest;
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ /**
4
+ * Represents the full library of Apex top-level types (classes, enums, and interface) for a Salesforce project.
5
+ */
6
+ class Manifest {
7
+ /**
8
+ * Constructs a new Manifest object.
9
+ * @param types List of types to be wrapped by this object.
10
+ * @param isForInnerTypes Whether this manifest represent an inner type or not.
11
+ */
12
+ constructor(types, isForInnerTypes = false) {
13
+ this.types = types;
14
+ this.isForInnerTypes = isForInnerTypes;
15
+ }
16
+ filteredByAccessModifierAndAnnotations(modifiers) {
17
+ const filteredTypes = this.filterAccessibleModifier(this.types, modifiers);
18
+ const typesToReturn = [];
19
+ for (const filteredType of filteredTypes) {
20
+ const currentType = filteredType;
21
+ if (currentType.type_name === 'enum') {
22
+ // Ignoring enum values is not supported.
23
+ typesToReturn.push(currentType);
24
+ continue;
25
+ }
26
+ if (currentType.type_name === 'interface') {
27
+ const currentInterface = currentType;
28
+ typesToReturn.push(Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentInterface.methods, modifiers) }));
29
+ continue;
30
+ }
31
+ const currentClass = currentType;
32
+ let filteredClass = Object.assign(Object.assign({}, currentType), { methods: this.filterAccessibleModifier(currentClass.methods, modifiers), properties: this.filterAccessibleModifier(currentClass.properties, modifiers), fields: this.filterAccessibleModifier(currentClass.fields, modifiers), constructors: this.filterAccessibleModifier(currentClass.constructors, modifiers) });
33
+ if (!this.isForInnerTypes) {
34
+ filteredClass = Object.assign(Object.assign({}, filteredClass), { enums: this.filterAccessibleModifier(currentClass.enums, modifiers), interfaces: this.filterAccessibleModifier(currentClass.interfaces, modifiers), classes: new Manifest(currentClass.classes, true).filteredByAccessModifierAndAnnotations(modifiers) });
35
+ }
36
+ typesToReturn.push(filteredClass);
37
+ }
38
+ return typesToReturn;
39
+ }
40
+ filterAccessibleModifier(accessAndDocAware, modifiers) {
41
+ return accessAndDocAware.filter((currentType) => {
42
+ var _a;
43
+ const hasIgnoreDocAnnotation = (_a = currentType.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === 'ignore');
44
+ if (hasIgnoreDocAnnotation) {
45
+ return false;
46
+ }
47
+ return (modifiers.includes(currentType.access_modifier) ||
48
+ currentType.annotations.some((annotation) => modifiers.includes(annotation.type.toLowerCase())));
49
+ });
50
+ }
51
+ }
52
+ exports.default = Manifest;
47
53
  //# sourceMappingURL=manifest.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../src/model/manifest.ts"],"names":[],"mappings":";;AAYA;;GAEG;AACH,MAAqB,QAAQ;IAC3B;;;;OAIG;IACH,YAAmB,KAAa,EAAS,kBAA2B,KAAK;QAAtD,UAAK,GAAL,KAAK,CAAQ;QAAS,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAE7E,sCAAsC,CAAC,SAAmB;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAW,EAAE,CAAC;QACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE;YACxC,MAAM,WAAW,GAAG,YAAoB,CAAC;YACzC,IAAI,WAAW,CAAC,SAAS,KAAK,OAAO,EAAE;gBACrC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChC,SAAS;aACV;YAED,MAAM,YAAY,GAAG,WAA0B,CAAC;YAChD,IAAI,aAAa,mCACZ,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EACvE,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,EAC7E,MAAM,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,EACrE,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,GAClF,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE;gBACzB,aAAa,mCACR,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAiB,EACnF,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAsB,EAClG,OAAO,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,sCAAsC,CACtF,SAAS,CACO,GACnB,CAAC;aACH;YAED,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;SACnC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wBAAwB,CAAC,kBAAuC,EAAE,SAAmB;QACnF,OAAO,kBAAkB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;;YAC/C,MAAM,sBAAsB,GAAG,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACrE,CAAC,UAAgC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,QAAQ,CACnE,CAAC;YACF,IAAI,sBAAsB,EAAE;gBAC1B,OAAO,KAAK,CAAC;aACd;YACD,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC;gBAC/C,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAsB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAC5G,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA1DD,2BA0DC"}
1
+ {"version":3,"file":"manifest.js","sourceRoot":"","sources":["../../src/model/manifest.ts"],"names":[],"mappings":";;AAYA;;GAEG;AACH,MAAqB,QAAQ;IAC3B;;;;OAIG;IACH,YAAmB,KAAa,EAAS,kBAA2B,KAAK;QAAtD,UAAK,GAAL,KAAK,CAAQ;QAAS,oBAAe,GAAf,eAAe,CAAiB;IAAG,CAAC;IAE7E,sCAAsC,CAAC,SAAmB;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;QAC3E,MAAM,aAAa,GAAW,EAAE,CAAC;QACjC,KAAK,MAAM,YAAY,IAAI,aAAa,EAAE,CAAC;YACzC,MAAM,WAAW,GAAG,YAAoB,CAAC;YACzC,IAAI,WAAW,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;gBACrC,yCAAyC;gBACzC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;gBAChC,SAAS;YACX,CAAC;YAED,IAAI,WAAW,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;gBAC1C,MAAM,gBAAgB,GAAG,WAA8B,CAAC;gBACxD,aAAa,CAAC,IAAI,CAAC,gCACd,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,gBAAgB,CAAC,OAAO,EAAE,SAAS,CAAC,GACzD,CAAC,CAAC;gBACtB,SAAS;YACX,CAAC;YAED,MAAM,YAAY,GAAG,WAA0B,CAAC;YAChD,IAAI,aAAa,GAAG,gCACf,WAAW,KACd,OAAO,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EACvE,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAC,EAC7E,MAAM,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,MAAM,EAAE,SAAS,CAAC,EACrE,YAAY,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,YAAY,EAAE,SAAS,CAAC,GACnE,CAAC;YAEjB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,CAAC;gBAC1B,aAAa,mCACR,aAAa,KAChB,KAAK,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,KAAK,EAAE,SAAS,CAAiB,EACnF,UAAU,EAAE,IAAI,CAAC,wBAAwB,CAAC,YAAY,CAAC,UAAU,EAAE,SAAS,CAAsB,EAClG,OAAO,EAAE,IAAI,QAAQ,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC,sCAAsC,CACtF,SAAS,CACO,GACnB,CAAC;YACJ,CAAC;YAED,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QACpC,CAAC;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED,wBAAwB,CAAC,iBAAsC,EAAE,SAAmB;QAClF,OAAO,iBAAiB,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE;;YAC9C,MAAM,sBAAsB,GAAG,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CACrE,CAAC,UAAgC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,QAAQ,CACjF,CAAC;YACF,IAAI,sBAAsB,EAAE,CAAC;gBAC3B,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,CACL,SAAS,CAAC,QAAQ,CAAC,WAAW,CAAC,eAAe,CAAC;gBAC/C,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,UAAsB,EAAE,EAAE,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC,CAC5G,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AApED,2BAoEC"}
@@ -1,16 +1,16 @@
1
- import { OutputFile } from './outputFile';
2
- export declare class MarkdownFile extends OutputFile {
3
- fileExtension(): string;
4
- addTitle(text: string, level?: number): void;
5
- addText(text: string, encodeHtml?: boolean): void;
6
- addLink(text: string, encodeHtml?: boolean): void;
7
- startCodeBlock(language?: string): void;
8
- endCodeBlock(): void;
9
- addHorizontalRule(): void;
10
- initializeTable(...headers: string[]): void;
11
- addTableRow(...columns: string[]): void;
12
- addListItem(text: string): void;
13
- protected static replaceInlineLinks(text: string): string;
14
- protected static replaceInlineEmails(text: string): string;
15
- private _replaceInlineReferences;
16
- }
1
+ import { OutputFile } from './outputFile';
2
+ export declare class MarkdownFile extends OutputFile {
3
+ fileExtension(): string;
4
+ addTitle(text: string, level?: number): void;
5
+ addText(text: string): void;
6
+ addLink(text: string): void;
7
+ startCodeBlock(language?: string): void;
8
+ endCodeBlock(): void;
9
+ addHorizontalRule(): void;
10
+ initializeTable(...headers: string[]): void;
11
+ addTableRow(...columns: string[]): void;
12
+ addListItem(text: string): void;
13
+ protected static replaceInlineLinks(text: string): string;
14
+ protected static replaceInlineEmails(text: string): string;
15
+ private _replaceInlineReferences;
16
+ }
@@ -1,107 +1,111 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MarkdownFile = void 0;
4
- const outputFile_1 = require("./outputFile");
5
- const class_file_generatorHelper_1 = require("../transpiler/markdown/class-file-generatorHelper");
6
- class MarkdownFile extends outputFile_1.OutputFile {
7
- fileExtension() {
8
- return '.md';
9
- }
10
- addTitle(text, level = 1) {
11
- let title = '';
12
- for (let i = 0; i < level; i++) {
13
- title += '#';
14
- }
15
- title += ' ';
16
- title += text;
17
- this._contents += title;
18
- this.addBlankLine();
19
- }
20
- addText(text, encodeHtml = true) {
21
- super.addText(this._replaceInlineReferences(text), encodeHtml);
22
- }
23
- addLink(text, encodeHtml = true) {
24
- this.addText(`\{@link ${text}\}`, encodeHtml);
25
- }
26
- startCodeBlock(language = 'apex') {
27
- this.addText(`\`\`\`${language}`);
28
- }
29
- endCodeBlock() {
30
- this.addText('```');
31
- this.addBlankLine();
32
- }
33
- addHorizontalRule() {
34
- this._contents += '---';
35
- this.addBlankLine();
36
- }
37
- initializeTable(...headers) {
38
- this.addBlankLine();
39
- this._contents += '|';
40
- headers.forEach((header) => {
41
- this._contents += header + '|';
42
- });
43
- this.addBlankLine();
44
- this._contents += '|';
45
- headers.forEach((_) => {
46
- this._contents += '---' + '|';
47
- });
48
- this.addBlankLine();
49
- }
50
- addTableRow(...columns) {
51
- this._contents += '|';
52
- columns.forEach((column) => {
53
- this._contents += this._replaceInlineReferences(column) + '|';
54
- });
55
- this.addBlankLine();
56
- }
57
- addListItem(text) {
58
- this._contents += `* ${text}`;
59
- }
60
- static replaceInlineLinks(text) {
61
- // Parsing text to extract possible linking classes.
62
- const possibleLinks = text.match(/<<.*?>>/g);
63
- possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
64
- const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
65
- text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
66
- });
67
- // Parsing links using {@link ClassName} format
68
- const linkFormatRegEx = '{@link (.*?)}';
69
- const expression = new RegExp(linkFormatRegEx, 'gi');
70
- let match;
71
- const matches = [];
72
- do {
73
- match = expression.exec(text);
74
- if (match) {
75
- matches.push(match);
76
- }
77
- } while (match);
78
- for (const currentMatch of matches) {
79
- text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
80
- }
81
- return text;
82
- }
83
- static replaceInlineEmails(text) {
84
- // Parsing links using {@link ClassName} format
85
- const linkFormatRegEx = '{@email (.*?)}';
86
- const expression = new RegExp(linkFormatRegEx, 'gi');
87
- let match;
88
- const matches = [];
89
- do {
90
- match = expression.exec(text);
91
- if (match) {
92
- matches.push(match);
93
- }
94
- } while (match);
95
- for (const currentMatch of matches) {
96
- text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
97
- }
98
- return text;
99
- }
100
- _replaceInlineReferences(text) {
101
- text = MarkdownFile.replaceInlineLinks(text);
102
- text = MarkdownFile.replaceInlineEmails(text);
103
- return text;
104
- }
105
- }
106
- exports.MarkdownFile = MarkdownFile;
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.MarkdownFile = void 0;
7
+ const outputFile_1 = require("./outputFile");
8
+ const class_file_generatorHelper_1 = __importDefault(require("../transpiler/markdown/class-file-generatorHelper"));
9
+ class MarkdownFile extends outputFile_1.OutputFile {
10
+ fileExtension() {
11
+ return '.md';
12
+ }
13
+ addTitle(text, level = 1) {
14
+ let title = '';
15
+ for (let i = 0; i < level; i++) {
16
+ title += '#';
17
+ }
18
+ title += ' ';
19
+ title += text;
20
+ this._contents += title;
21
+ this.addBlankLine();
22
+ }
23
+ addText(text) {
24
+ //super.addText(this._replaceInlineReferences(text), encodeHtml);
25
+ super.addText(text);
26
+ }
27
+ addLink(text) {
28
+ this.addText(`{@link ${text}}`);
29
+ }
30
+ startCodeBlock(language = 'apex') {
31
+ this.addText(`\`\`\`${language}`);
32
+ }
33
+ endCodeBlock() {
34
+ this.addText('```');
35
+ this.addBlankLine();
36
+ }
37
+ addHorizontalRule() {
38
+ this._contents += '---';
39
+ this.addBlankLine();
40
+ }
41
+ initializeTable(...headers) {
42
+ this.addBlankLine();
43
+ this._contents += '|';
44
+ headers.forEach((header) => {
45
+ this._contents += header + '|';
46
+ });
47
+ this.addBlankLine();
48
+ this._contents += '|';
49
+ headers.forEach(() => {
50
+ this._contents += '---' + '|';
51
+ });
52
+ this.addBlankLine();
53
+ }
54
+ addTableRow(...columns) {
55
+ this._contents += '|';
56
+ columns.forEach((column) => {
57
+ this._contents += this._replaceInlineReferences(column) + '|';
58
+ });
59
+ this.addBlankLine();
60
+ }
61
+ addListItem(text) {
62
+ this._contents += `* ${text}`;
63
+ }
64
+ static replaceInlineLinks(text) {
65
+ // Parsing text to extract possible linking classes.
66
+ const possibleLinks = text.match(/<<.*?>>/g);
67
+ possibleLinks === null || possibleLinks === void 0 ? void 0 : possibleLinks.forEach((currentMatch) => {
68
+ const classNameForMatch = currentMatch.replace('<<', '').replace('>>', '');
69
+ text = text.replace(currentMatch, class_file_generatorHelper_1.default.getFileLinkByTypeName(classNameForMatch));
70
+ });
71
+ // Parsing links using {@link ClassName} format
72
+ const linkFormatRegEx = '{@link (.*?)}';
73
+ const expression = new RegExp(linkFormatRegEx, 'gi');
74
+ let match;
75
+ const matches = [];
76
+ do {
77
+ match = expression.exec(text);
78
+ if (match) {
79
+ matches.push(match);
80
+ }
81
+ } while (match);
82
+ for (const currentMatch of matches) {
83
+ text = text.replace(currentMatch[0], class_file_generatorHelper_1.default.getFileLinkByTypeName(currentMatch[1]));
84
+ }
85
+ return text;
86
+ }
87
+ static replaceInlineEmails(text) {
88
+ // Parsing links using {@link ClassName} format
89
+ const linkFormatRegEx = '{@email (.*?)}';
90
+ const expression = new RegExp(linkFormatRegEx, 'gi');
91
+ let match;
92
+ const matches = [];
93
+ do {
94
+ match = expression.exec(text);
95
+ if (match) {
96
+ matches.push(match);
97
+ }
98
+ } while (match);
99
+ for (const currentMatch of matches) {
100
+ text = text.replace(currentMatch[0], `[${currentMatch[1]}](mailto:${currentMatch[1]})`);
101
+ }
102
+ return text;
103
+ }
104
+ _replaceInlineReferences(text) {
105
+ text = MarkdownFile.replaceInlineLinks(text);
106
+ text = MarkdownFile.replaceInlineEmails(text);
107
+ return text;
108
+ }
109
+ }
110
+ exports.MarkdownFile = MarkdownFile;
107
111
  //# sourceMappingURL=markdown-file.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;AAAA,6CAA0C;AAC1C,kGAAyF;AAEzF,MAAa,YAAa,SAAQ,uBAAU;IAC1C,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QAC9B,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE;YAC9B,KAAK,IAAI,GAAG,CAAC;SACd;QAED,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;IAEM,OAAO,CAAC,IAAY,EAAE,UAAU,GAAG,IAAI;QAC5C,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,EAAE,UAAU,CAAC,CAAC;IAChD,CAAC;IAED,cAAc,CAAC,QAAQ,GAAG,MAAM;QAC9B,IAAI,CAAC,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,YAAY;QACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAG,OAAiB;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,GAAG,OAAiB;QAC9B,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;QAChE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,SAAS,IAAI,KAAK,IAAI,EAAE,CAAC;IAChC,CAAC;IAES,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC9C,oDAAoD;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvG,CAAC,CAAC,CAAC;QAEH,+CAA+C;QAC/C,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SACvG;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,MAAM,CAAC,mBAAmB,CAAC,IAAY;QAC/C,+CAA+C;QAC/C,MAAM,eAAe,GAAG,gBAAgB,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG;YACD,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;aACrB;SACF,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE;YAClC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;SACzF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,wBAAwB,CAAC,IAAY;QAC3C,IAAI,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AArHD,oCAqHC"}
1
+ {"version":3,"file":"markdown-file.js","sourceRoot":"","sources":["../../src/model/markdown-file.ts"],"names":[],"mappings":";;;;;;AAAA,6CAA0C;AAC1C,mHAAyF;AAEzF,MAAa,YAAa,SAAQ,uBAAU;IAC1C,aAAa;QACX,OAAO,KAAK,CAAC;IACf,CAAC;IAED,QAAQ,CAAC,IAAY,EAAE,KAAK,GAAG,CAAC;QAC9B,IAAI,KAAK,GAAG,EAAE,CAAC;QACf,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC/B,KAAK,IAAI,GAAG,CAAC;QACf,CAAC;QAED,KAAK,IAAI,GAAG,CAAC;QACb,KAAK,IAAI,IAAI,CAAC;QACd,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,IAAY;QACzB,iEAAiE;QACjE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IACtB,CAAC;IAEM,OAAO,CAAC,IAAY;QACzB,IAAI,CAAC,OAAO,CAAC,UAAU,IAAI,GAAG,CAAC,CAAC;IAClC,CAAC;IAED,cAAc,CAAC,QAAQ,GAAG,MAAM;QAC9B,IAAI,CAAC,OAAO,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC;IACpC,CAAC;IAED,YAAY;QACV,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;QACpB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,iBAAiB;QACf,IAAI,CAAC,SAAS,IAAI,KAAK,CAAC;QACxB,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,eAAe,CAAC,GAAG,OAAiB;QAClC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,MAAM,GAAG,GAAG,CAAC;QACjC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE;YACnB,IAAI,CAAC,SAAS,IAAI,KAAK,GAAG,GAAG,CAAC;QAChC,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,GAAG,OAAiB;QAC9B,IAAI,CAAC,SAAS,IAAI,GAAG,CAAC;QACtB,OAAO,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;YACzB,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,wBAAwB,CAAC,MAAM,CAAC,GAAG,GAAG,CAAC;QAChE,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,YAAY,EAAE,CAAC;IACtB,CAAC;IAED,WAAW,CAAC,IAAY;QACtB,IAAI,CAAC,SAAS,IAAI,KAAK,IAAI,EAAE,CAAC;IAChC,CAAC;IAES,MAAM,CAAC,kBAAkB,CAAC,IAAY;QAC9C,oDAAoD;QACpD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAC7C,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,OAAO,CAAC,CAAC,YAAY,EAAE,EAAE;YACtC,MAAM,iBAAiB,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;YAC3E,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QACvG,CAAC,CAAC,CAAC;QAEH,+CAA+C;QAC/C,MAAM,eAAe,GAAG,eAAe,CAAC;QACxC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG,CAAC;YACF,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE,CAAC;YACnC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,oCAAwB,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QACxG,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAES,MAAM,CAAC,mBAAmB,CAAC,IAAY;QAC/C,+CAA+C;QAC/C,MAAM,eAAe,GAAG,gBAAgB,CAAC;QACzC,MAAM,UAAU,GAAG,IAAI,MAAM,CAAC,eAAe,EAAE,IAAI,CAAC,CAAC;QACrD,IAAI,KAAK,CAAC;QACV,MAAM,OAAO,GAAG,EAAE,CAAC;QAEnB,GAAG,CAAC;YACF,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAC9B,IAAI,KAAK,EAAE,CAAC;gBACV,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;QACH,CAAC,QAAQ,KAAK,EAAE;QAEhB,KAAK,MAAM,YAAY,IAAI,OAAO,EAAE,CAAC;YACnC,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,IAAI,YAAY,CAAC,CAAC,CAAC,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QAC1F,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,wBAAwB,CAAC,IAAY;QAC3C,IAAI,GAAG,YAAY,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC;QAC7C,IAAI,GAAG,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAtHD,oCAsHC"}
@@ -1,8 +1,8 @@
1
- import { DocComment } from '@cparra/apex-reflection';
2
- import { MarkdownFile } from '../markdown-file';
3
- interface DocCommentAware {
4
- docComment?: DocComment;
5
- }
6
- export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
7
- export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
8
- export {};
1
+ import { DocComment } from '@cparra/apex-reflection';
2
+ import { MarkdownFile } from '../markdown-file';
3
+ interface DocCommentAware {
4
+ docComment?: DocComment;
5
+ }
6
+ export declare function addMermaid(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
7
+ export declare function addCustomDocCommentAnnotations(markdownFile: MarkdownFile, docCommentAware: DocCommentAware): void;
8
+ export {};
@@ -1,44 +1,46 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.addCustomDocCommentAnnotations = exports.addMermaid = void 0;
4
- const class_file_generatorHelper_1 = require("../../transpiler/markdown/class-file-generatorHelper");
5
- function addMermaid(markdownFile, docCommentAware) {
6
- var _a;
7
- const mermaid = (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'mermaid');
8
- if (!mermaid) {
9
- return;
10
- }
11
- markdownFile.addBlankLine();
12
- markdownFile.startCodeBlock('mermaid');
13
- mermaid.bodyLines.forEach((line) => {
14
- markdownFile.addText(line, false);
15
- });
16
- markdownFile.endCodeBlock();
17
- markdownFile.addBlankLine();
18
- }
19
- exports.addMermaid = addMermaid;
20
- function addCustomDocCommentAnnotations(markdownFile, docCommentAware) {
21
- var _a;
22
- (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name !== 'description').filter((currentAnnotation) => currentAnnotation.name !== 'mermaid').forEach((currentAnnotation) => {
23
- markdownFile.addBlankLine();
24
- markdownFile.addText(buildDocAnnotationText(currentAnnotation));
25
- markdownFile.addBlankLine();
26
- });
27
- function splitAndCapitalize(text) {
28
- const words = text.split(/[-_]+/);
29
- const capitalizedWords = [];
30
- for (const word of words) {
31
- capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
32
- }
33
- return capitalizedWords.join(' ');
34
- }
35
- function buildDocAnnotationText(annotation) {
36
- let annotationBodyText = annotation.body;
37
- if (annotation.name.toLowerCase() === 'see') {
38
- annotationBodyText = class_file_generatorHelper_1.default.getFileLinkByTypeName(annotation.body);
39
- }
40
- return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
41
- }
42
- }
43
- exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;
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.addMermaid = addMermaid;
7
+ exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;
8
+ const class_file_generatorHelper_1 = __importDefault(require("../../transpiler/markdown/class-file-generatorHelper"));
9
+ function addMermaid(markdownFile, docCommentAware) {
10
+ var _a;
11
+ const mermaid = (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'mermaid');
12
+ if (!mermaid) {
13
+ return;
14
+ }
15
+ markdownFile.addBlankLine();
16
+ markdownFile.startCodeBlock('mermaid');
17
+ mermaid.bodyLines.forEach((line) => {
18
+ markdownFile.addText(line);
19
+ });
20
+ markdownFile.endCodeBlock();
21
+ markdownFile.addBlankLine();
22
+ }
23
+ function addCustomDocCommentAnnotations(markdownFile, docCommentAware) {
24
+ var _a;
25
+ (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.filter((currentAnnotation) => currentAnnotation.name !== 'description').filter((currentAnnotation) => currentAnnotation.name !== 'mermaid').forEach((currentAnnotation) => {
26
+ markdownFile.addBlankLine();
27
+ markdownFile.addText(buildDocAnnotationText(currentAnnotation));
28
+ markdownFile.addBlankLine();
29
+ });
30
+ function splitAndCapitalize(text) {
31
+ const words = text.split(/[-_]+/);
32
+ const capitalizedWords = [];
33
+ for (const word of words) {
34
+ capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
35
+ }
36
+ return capitalizedWords.join(' ');
37
+ }
38
+ function buildDocAnnotationText(annotation) {
39
+ let annotationBodyText = annotation.body;
40
+ if (annotation.name.toLowerCase() === 'see') {
41
+ annotationBodyText = class_file_generatorHelper_1.default.getFileLinkByTypeName(annotation.body);
42
+ }
43
+ return `**${splitAndCapitalize(annotation.name)}** ${annotationBodyText}`;
44
+ }
45
+ }
44
46
  //# sourceMappingURL=doc-comment-annotation-util.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;AACA,qGAA4F;AAO5F,SAAgB,UAAU,CAAC,YAA0B,EAAE,eAAgC;;IACrF,MAAM,OAAO,GAAG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAC5G,IAAI,CAAC,OAAO,EAAE;QACZ,OAAO;KACR;IAED,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjC,YAAY,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAbD,gCAaC;AAED,SAAgB,8BAA8B,CAAC,YAA0B,EAAE,eAAgC;;IACzG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CACpC,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,EAC5F,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,SAAS,EACxF,OAAO,CAAC,CAAC,iBAAuC,EAAE,EAAE;QACnD,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAChE,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEL,SAAS,kBAAkB,CAAC,IAAY;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;YACxB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;SACrE;QACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,SAAS,sBAAsB,CAAC,UAAgC;QAC9D,IAAI,kBAAkB,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE;YAC3C,kBAAkB,GAAG,oCAAwB,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;SACtF;QACD,OAAO,KAAK,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,CAAC;IAC5E,CAAC;AACH,CAAC;AA1BD,wEA0BC"}
1
+ {"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;;;AAQA,gCAaC;AAED,wEA0BC;AAhDD,sHAA4F;AAO5F,SAAgB,UAAU,CAAC,YAA0B,EAAE,eAAgC;;IACrF,MAAM,OAAO,GAAG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC;IAC5G,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO;IACT,CAAC;IAED,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IACvC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACjC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;IAC7B,CAAC,CAAC,CAAC;IACH,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAgB,8BAA8B,CAAC,YAA0B,EAAE,eAAgC;;IACzG,MAAA,eAAe,CAAC,UAAU,0CAAE,WAAW,CACpC,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,aAAa,EAC5F,MAAM,CAAC,CAAC,iBAAuC,EAAE,EAAE,CAAC,iBAAiB,CAAC,IAAI,KAAK,SAAS,EACxF,OAAO,CAAC,CAAC,iBAAuC,EAAE,EAAE;QACnD,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,sBAAsB,CAAC,iBAAiB,CAAC,CAAC,CAAC;QAChE,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC,CAAC,CAAC;IAEL,SAAS,kBAAkB,CAAC,IAAY;QACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;QAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;QACtE,CAAC;QACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACpC,CAAC;IAED,SAAS,sBAAsB,CAAC,UAAgC;QAC9D,IAAI,kBAAkB,GAAG,UAAU,CAAC,IAAI,CAAC;QACzC,IAAI,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,KAAK,EAAE,CAAC;YAC5C,kBAAkB,GAAG,oCAAwB,CAAC,qBAAqB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACvF,CAAC;QACD,OAAO,KAAK,kBAAkB,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,kBAAkB,EAAE,CAAC;IAC5E,CAAC;AACH,CAAC"}
@@ -1,3 +1,3 @@
1
- import { MarkdownFile } from '../markdown-file';
2
- import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../inheritance';
3
- export declare function declareField(markdownFile: MarkdownFile, fields: FieldMirrorWithInheritance[] | PropertyMirrorWithInheritance[], startingHeadingLevel: number, grouped?: boolean): void;
1
+ import { MarkdownFile } from '../markdown-file';
2
+ import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../inheritance';
3
+ export declare function declareField(markdownFile: MarkdownFile, fields: FieldMirrorWithInheritance[] | PropertyMirrorWithInheritance[], startingHeadingLevel: number, grouped?: boolean): void;