@cparra/apexdocs 2.25.0-alpha.3 → 2.25.0-alpha.4

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 (288) hide show
  1. package/dist/cli/generate.js +26 -26
  2. package/examples/plain-markdown/docs/Miscellaneous/ns.Url.md +320 -0
  3. package/examples/plain-markdown/docs/index.md +82 -0
  4. package/examples/plain-markdown/force-app/classes/Url.cls +194 -0
  5. package/examples/plain-markdown/package.json +2 -1
  6. package/package.json +1 -1
  7. package/src/application/Apexdocs.ts +0 -2
  8. package/src/cli/args.ts +3 -1
  9. package/src/cli/generate.ts +1 -3
  10. package/src/core/adapters/__tests__/documentables.spec.ts +109 -0
  11. package/src/core/adapters/__tests__/references.spec.ts +12 -1
  12. package/src/core/adapters/apex-types.ts +1 -1
  13. package/src/core/adapters/documentables.ts +2 -62
  14. package/src/core/adapters/fields-and-properties.ts +7 -2
  15. package/src/core/adapters/{references.ts → inline.ts} +43 -10
  16. package/src/core/adapters/methods-and-constructors.ts +7 -2
  17. package/src/core/adapters/type-utils.ts +5 -1
  18. package/src/core/adapters/types.d.ts +8 -1
  19. package/src/core/template.ts +4 -1
  20. package/src/service/apex-file-reader.ts +1 -5
  21. package/src/settings.ts +0 -10
  22. package/src/test-helpers/SettingsBuilder.ts +0 -2
  23. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +1 -1
  24. package/src/util/fp.ts +3 -0
  25. package/dist/__spec__/core/expect-extensions.d.ts +0 -3
  26. package/dist/__spec__/core/expect-extensions.js +0 -55
  27. package/dist/__spec__/core/expect-extensions.js.map +0 -1
  28. package/dist/__spec__/core/generating-class-docs.spec.d.ts +0 -1
  29. package/dist/__spec__/core/generating-class-docs.spec.js +0 -444
  30. package/dist/__spec__/core/generating-class-docs.spec.js.map +0 -1
  31. package/dist/__spec__/core/generating-enum-docs.spec.d.ts +0 -1
  32. package/dist/__spec__/core/generating-enum-docs.spec.js +0 -306
  33. package/dist/__spec__/core/generating-enum-docs.spec.js.map +0 -1
  34. package/dist/__spec__/core/generating-interface-docs.spec.d.ts +0 -1
  35. package/dist/__spec__/core/generating-interface-docs.spec.js +0 -364
  36. package/dist/__spec__/core/generating-interface-docs.spec.js.map +0 -1
  37. package/dist/__spec__/core/generating-reference-guide.spec.d.ts +0 -1
  38. package/dist/__spec__/core/generating-reference-guide.spec.js +0 -162
  39. package/dist/__spec__/core/generating-reference-guide.spec.js.map +0 -1
  40. package/dist/__spec__/core/test-helpers.d.ts +0 -2
  41. package/dist/__spec__/core/test-helpers.js +0 -12
  42. package/dist/__spec__/core/test-helpers.js.map +0 -1
  43. package/dist/application/Apexdocs.d.ts +0 -15
  44. package/dist/application/Apexdocs.js +0 -113
  45. package/dist/application/Apexdocs.js.map +0 -1
  46. package/dist/application/generators/generate-markdown-files.d.ts +0 -3
  47. package/dist/application/generators/generate-markdown-files.js +0 -64
  48. package/dist/application/generators/generate-markdown-files.js.map +0 -1
  49. package/dist/cli/args.d.ts +0 -39
  50. package/dist/cli/args.js +0 -154
  51. package/dist/cli/args.js.map +0 -1
  52. package/dist/cli/generate.d.ts +0 -2
  53. package/dist/cli/generate.js.map +0 -1
  54. package/dist/core/__test__/inheritance-chain.test.d.ts +0 -1
  55. package/dist/core/__test__/inheritance-chain.test.js +0 -42
  56. package/dist/core/__test__/inheritance-chain.test.js.map +0 -1
  57. package/dist/core/adapters/apex-types.d.ts +0 -6
  58. package/dist/core/adapters/apex-types.js +0 -109
  59. package/dist/core/adapters/apex-types.js.map +0 -1
  60. package/dist/core/adapters/documentables.d.ts +0 -7
  61. package/dist/core/adapters/documentables.js +0 -154
  62. package/dist/core/adapters/documentables.js.map +0 -1
  63. package/dist/core/adapters/fields-and-properties.d.ts +0 -3
  64. package/dist/core/adapters/fields-and-properties.js +0 -37
  65. package/dist/core/adapters/fields-and-properties.js.map +0 -1
  66. package/dist/core/adapters/methods-and-constructors.d.ts +0 -5
  67. package/dist/core/adapters/methods-and-constructors.js +0 -100
  68. package/dist/core/adapters/methods-and-constructors.js.map +0 -1
  69. package/dist/core/adapters/references.d.ts +0 -4
  70. package/dist/core/adapters/references.js +0 -78
  71. package/dist/core/adapters/references.js.map +0 -1
  72. package/dist/core/adapters/type-utils.d.ts +0 -3
  73. package/dist/core/adapters/type-utils.js +0 -12
  74. package/dist/core/adapters/type-utils.js.map +0 -1
  75. package/dist/core/apex-bundle.d.ts +0 -6
  76. package/dist/core/apex-bundle.js +0 -11
  77. package/dist/core/apex-bundle.js.map +0 -1
  78. package/dist/core/generate-docs.d.ts +0 -28
  79. package/dist/core/generate-docs.js +0 -296
  80. package/dist/core/generate-docs.js.map +0 -1
  81. package/dist/core/inheritance-chain.d.ts +0 -2
  82. package/dist/core/inheritance-chain.js +0 -36
  83. package/dist/core/inheritance-chain.js.map +0 -1
  84. package/dist/core/manifest.d.ts +0 -22
  85. package/dist/core/manifest.js +0 -53
  86. package/dist/core/manifest.js.map +0 -1
  87. package/dist/core/template.d.ts +0 -10
  88. package/dist/core/template.js +0 -97
  89. package/dist/core/template.js.map +0 -1
  90. package/dist/core/templates/reference-guide.d.ts +0 -1
  91. package/dist/core/templates/reference-guide.js +0 -18
  92. package/dist/core/templates/reference-guide.js.map +0 -1
  93. package/dist/index.js.map +0 -1
  94. package/dist/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -7
  95. package/dist/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -14
  96. package/dist/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -1
  97. package/dist/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -7
  98. package/dist/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -12
  99. package/dist/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -1
  100. package/dist/model/markdown-file.d.ts +0 -16
  101. package/dist/model/markdown-file.js +0 -111
  102. package/dist/model/markdown-file.js.map +0 -1
  103. package/dist/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -8
  104. package/dist/model/markdown-generation-util/doc-comment-annotation-util.js +0 -47
  105. package/dist/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
  106. package/dist/model/markdown-generation-util/field-declaration-util.d.ts +0 -3
  107. package/dist/model/markdown-generation-util/field-declaration-util.js +0 -55
  108. package/dist/model/markdown-generation-util/field-declaration-util.js.map +0 -1
  109. package/dist/model/markdown-generation-util/index.d.ts +0 -3
  110. package/dist/model/markdown-generation-util/index.js +0 -20
  111. package/dist/model/markdown-generation-util/index.js.map +0 -1
  112. package/dist/model/markdown-generation-util/method-declaration-util.d.ts +0 -4
  113. package/dist/model/markdown-generation-util/method-declaration-util.js +0 -115
  114. package/dist/model/markdown-generation-util/method-declaration-util.js.map +0 -1
  115. package/dist/model/markdown-generation-util/type-declaration-util.d.ts +0 -3
  116. package/dist/model/markdown-generation-util/type-declaration-util.js +0 -82
  117. package/dist/model/markdown-generation-util/type-declaration-util.js.map +0 -1
  118. package/dist/model/markdown-home-file.d.ts +0 -11
  119. package/dist/model/markdown-home-file.js +0 -57
  120. package/dist/model/markdown-home-file.js.map +0 -1
  121. package/dist/model/markdown-type-file.d.ts +0 -26
  122. package/dist/model/markdown-type-file.js +0 -137
  123. package/dist/model/markdown-type-file.js.map +0 -1
  124. package/dist/model/openapi/apex-doc-types.d.ts +0 -19
  125. package/dist/model/openapi/apex-doc-types.js +0 -5
  126. package/dist/model/openapi/apex-doc-types.js.map +0 -1
  127. package/dist/model/openapi/open-api-types.d.ts +0 -93
  128. package/dist/model/openapi/open-api-types.js +0 -3
  129. package/dist/model/openapi/open-api-types.js.map +0 -1
  130. package/dist/model/openapi/open-api.d.ts +0 -16
  131. package/dist/model/openapi/open-api.js +0 -34
  132. package/dist/model/openapi/open-api.js.map +0 -1
  133. package/dist/model/openapi/openapi-type-file.d.ts +0 -7
  134. package/dist/model/openapi/openapi-type-file.js +0 -17
  135. package/dist/model/openapi/openapi-type-file.js.map +0 -1
  136. package/dist/model/outputFile.d.ts +0 -10
  137. package/dist/model/outputFile.js +0 -22
  138. package/dist/model/outputFile.js.map +0 -1
  139. package/dist/model/types-repository.d.ts +0 -16
  140. package/dist/model/types-repository.js +0 -54
  141. package/dist/model/types-repository.js.map +0 -1
  142. package/dist/service/apex-file-reader.d.ts +0 -14
  143. package/dist/service/apex-file-reader.js +0 -49
  144. package/dist/service/apex-file-reader.js.map +0 -1
  145. package/dist/service/file-system.d.ts +0 -14
  146. package/dist/service/file-system.js +0 -48
  147. package/dist/service/file-system.js.map +0 -1
  148. package/dist/service/file-writer.d.ts +0 -6
  149. package/dist/service/file-writer.js +0 -57
  150. package/dist/service/file-writer.js.map +0 -1
  151. package/dist/service/manifest-factory.d.ts +0 -10
  152. package/dist/service/manifest-factory.js +0 -17
  153. package/dist/service/manifest-factory.js.map +0 -1
  154. package/dist/service/metadata-processor.d.ts +0 -3
  155. package/dist/service/metadata-processor.js +0 -17
  156. package/dist/service/metadata-processor.js.map +0 -1
  157. package/dist/service/parser.d.ts +0 -21
  158. package/dist/service/parser.js +0 -138
  159. package/dist/service/parser.js.map +0 -1
  160. package/dist/service/state.d.ts +0 -9
  161. package/dist/service/state.js +0 -20
  162. package/dist/service/state.js.map +0 -1
  163. package/dist/service/walkers/class-walker.d.ts +0 -4
  164. package/dist/service/walkers/class-walker.js +0 -33
  165. package/dist/service/walkers/class-walker.js.map +0 -1
  166. package/dist/service/walkers/enum-walker.d.ts +0 -4
  167. package/dist/service/walkers/enum-walker.js +0 -11
  168. package/dist/service/walkers/enum-walker.js.map +0 -1
  169. package/dist/service/walkers/interface-walker.d.ts +0 -4
  170. package/dist/service/walkers/interface-walker.js +0 -15
  171. package/dist/service/walkers/interface-walker.js.map +0 -1
  172. package/dist/service/walkers/walker-factory.d.ts +0 -5
  173. package/dist/service/walkers/walker-factory.js +0 -21
  174. package/dist/service/walkers/walker-factory.js.map +0 -1
  175. package/dist/service/walkers/walker.d.ts +0 -19
  176. package/dist/service/walkers/walker.js +0 -17
  177. package/dist/service/walkers/walker.js.map +0 -1
  178. package/dist/settings.d.ts +0 -67
  179. package/dist/settings.js +0 -92
  180. package/dist/settings.js.map +0 -1
  181. package/dist/test-helpers/AnnotationBuilder.d.ts +0 -12
  182. package/dist/test-helpers/AnnotationBuilder.js +0 -31
  183. package/dist/test-helpers/AnnotationBuilder.js.map +0 -1
  184. package/dist/test-helpers/ClassMirrorBuilder.d.ts +0 -22
  185. package/dist/test-helpers/ClassMirrorBuilder.js +0 -64
  186. package/dist/test-helpers/ClassMirrorBuilder.js.map +0 -1
  187. package/dist/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -8
  188. package/dist/test-helpers/DocCommentAnnotationBuilder.js +0 -26
  189. package/dist/test-helpers/DocCommentAnnotationBuilder.js.map +0 -1
  190. package/dist/test-helpers/DocCommentBuilder.d.ts +0 -12
  191. package/dist/test-helpers/DocCommentBuilder.js +0 -38
  192. package/dist/test-helpers/DocCommentBuilder.js.map +0 -1
  193. package/dist/test-helpers/FieldMirrorBuilder.d.ts +0 -18
  194. package/dist/test-helpers/FieldMirrorBuilder.js +0 -54
  195. package/dist/test-helpers/FieldMirrorBuilder.js.map +0 -1
  196. package/dist/test-helpers/InterfaceMirrorBuilder.d.ts +0 -16
  197. package/dist/test-helpers/InterfaceMirrorBuilder.js +0 -43
  198. package/dist/test-helpers/InterfaceMirrorBuilder.js.map +0 -1
  199. package/dist/test-helpers/MethodMirrorBuilder.d.ts +0 -29
  200. package/dist/test-helpers/MethodMirrorBuilder.js +0 -72
  201. package/dist/test-helpers/MethodMirrorBuilder.js.map +0 -1
  202. package/dist/test-helpers/SettingsBuilder.d.ts +0 -8
  203. package/dist/test-helpers/SettingsBuilder.js +0 -28
  204. package/dist/test-helpers/SettingsBuilder.js.map +0 -1
  205. package/dist/transpiler/factory.d.ts +0 -6
  206. package/dist/transpiler/factory.js +0 -33
  207. package/dist/transpiler/factory.js.map +0 -1
  208. package/dist/transpiler/file-container.d.ts +0 -6
  209. package/dist/transpiler/file-container.js +0 -16
  210. package/dist/transpiler/file-container.js.map +0 -1
  211. package/dist/transpiler/generator-choices.d.ts +0 -1
  212. package/dist/transpiler/generator-choices.js +0 -3
  213. package/dist/transpiler/generator-choices.js.map +0 -1
  214. package/dist/transpiler/markdown/class-file-generatorHelper.d.ts +0 -9
  215. package/dist/transpiler/markdown/class-file-generatorHelper.js +0 -61
  216. package/dist/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
  217. package/dist/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -6
  218. package/dist/transpiler/markdown/docsify/docsify-docs-processor.js +0 -13
  219. package/dist/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -1
  220. package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -11
  221. package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -51
  222. package/dist/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -1
  223. package/dist/transpiler/markdown/markdown-transpiler-base.d.ts +0 -11
  224. package/dist/transpiler/markdown/markdown-transpiler-base.js +0 -27
  225. package/dist/transpiler/markdown/markdown-transpiler-base.js.map +0 -1
  226. package/dist/transpiler/markdown/plain-markdown/class-template.d.ts +0 -1
  227. package/dist/transpiler/markdown/plain-markdown/class-template.js +0 -77
  228. package/dist/transpiler/markdown/plain-markdown/class-template.js.map +0 -1
  229. package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -1
  230. package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.js +0 -36
  231. package/dist/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -1
  232. package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -1
  233. package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.js +0 -30
  234. package/dist/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +0 -1
  235. package/dist/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -1
  236. package/dist/transpiler/markdown/plain-markdown/enum-template.js +0 -16
  237. package/dist/transpiler/markdown/plain-markdown/enum-template.js.map +0 -1
  238. package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -1
  239. package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +0 -27
  240. package/dist/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -1
  241. package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -1
  242. package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -10
  243. package/dist/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -1
  244. package/dist/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -1
  245. package/dist/transpiler/markdown/plain-markdown/interface-template.js +0 -20
  246. package/dist/transpiler/markdown/plain-markdown/interface-template.js.map +0 -1
  247. package/dist/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -1
  248. package/dist/transpiler/markdown/plain-markdown/methods-partial-template.js +0 -47
  249. package/dist/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -1
  250. package/dist/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -1
  251. package/dist/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -31
  252. package/dist/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -1
  253. package/dist/transpiler/openapi/open-api-docs-processor.d.ts +0 -13
  254. package/dist/transpiler/openapi/open-api-docs-processor.js +0 -78
  255. package/dist/transpiler/openapi/open-api-docs-processor.js.map +0 -1
  256. package/dist/transpiler/openapi/parsers/Builder.d.ts +0 -16
  257. package/dist/transpiler/openapi/parsers/Builder.js +0 -30
  258. package/dist/transpiler/openapi/parsers/Builder.js.map +0 -1
  259. package/dist/transpiler/openapi/parsers/MethodParser.d.ts +0 -20
  260. package/dist/transpiler/openapi/parsers/MethodParser.js +0 -190
  261. package/dist/transpiler/openapi/parsers/MethodParser.js.map +0 -1
  262. package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -7
  263. package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -11
  264. package/dist/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -1
  265. package/dist/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -39
  266. package/dist/transpiler/openapi/parsers/ReferenceBuilder.js +0 -250
  267. package/dist/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -1
  268. package/dist/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -10
  269. package/dist/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -20
  270. package/dist/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -1
  271. package/dist/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -7
  272. package/dist/transpiler/openapi/parsers/ResponsesBuilder.js +0 -22
  273. package/dist/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -1
  274. package/dist/transpiler/processor-type-transpiler.d.ts +0 -10
  275. package/dist/transpiler/processor-type-transpiler.js +0 -9
  276. package/dist/transpiler/processor-type-transpiler.js.map +0 -1
  277. package/dist/transpiler/transpiler.d.ts +0 -5
  278. package/dist/transpiler/transpiler.js +0 -30
  279. package/dist/transpiler/transpiler.js.map +0 -1
  280. package/dist/util/error-logger.d.ts +0 -8
  281. package/dist/util/error-logger.js +0 -90
  282. package/dist/util/error-logger.js.map +0 -1
  283. package/dist/util/logger.d.ts +0 -21
  284. package/dist/util/logger.js +0 -61
  285. package/dist/util/logger.js.map +0 -1
  286. package/dist/util/string-utils.d.ts +0 -2
  287. package/dist/util/string-utils.js +0 -15
  288. package/dist/util/string-utils.js.map +0 -1
@@ -1,12 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.MethodMirrorWrapper = void 0;
4
- class MethodMirrorWrapper {
5
- constructor(methodMirror) {
6
- this.methodMirror = methodMirror;
7
- this.hasDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.some((annotation) => annotation.name.toLowerCase() === annotationName); };
8
- this.getDocCommentAnnotation = (annotationName) => { var _a; return (_a = this.methodMirror.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name.toLowerCase() === annotationName); };
9
- }
10
- }
11
- exports.MethodMirrorWrapper = MethodMirrorWrapper;
12
- //# sourceMappingURL=MethodMirrorWrapper.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"MethodMirrorWrapper.js","sourceRoot":"","sources":["../../../src/model/apex-type-wrappers/MethodMirrorWrapper.ts"],"names":[],"mappings":";;;AAEA,MAAa,mBAAmB;IAC9B,YAAmB,YAA0B;QAA1B,iBAAY,GAAZ,YAAY,CAAc;QAEtC,4BAAuB,GAAG,CAAC,cAAsB,EAAE,EAAE,WAC1D,OAAA,MAAA,IAAI,CAAC,YAAY,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAA,EAAA,CAAC;QAE5G,4BAAuB,GAAG,CAAC,cAAsB,EAAoC,EAAE,WAC5F,OAAA,MAAA,IAAI,CAAC,YAAY,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,cAAc,CAAC,CAAA,EAAA,CAAC;IANnE,CAAC;CAOlD;AARD,kDAQC"}
@@ -1,16 +0,0 @@
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): this;
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,111 +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.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(text);
25
- return this;
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;
111
- //# sourceMappingURL=markdown-file.js.map
@@ -1 +0,0 @@
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,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACpB,OAAO,IAAI,CAAC;IACd,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 +0,0 @@
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,47 +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.addCustomDocCommentAnnotations = exports.addMermaid = void 0;
7
- const class_file_generatorHelper_1 = __importDefault(require("../../transpiler/markdown/class-file-generatorHelper"));
8
- function addMermaid(markdownFile, docCommentAware) {
9
- var _a;
10
- const mermaid = (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'mermaid');
11
- if (!mermaid) {
12
- return;
13
- }
14
- markdownFile.addBlankLine();
15
- markdownFile.startCodeBlock('mermaid');
16
- mermaid.bodyLines.forEach((line) => {
17
- markdownFile.addText(line);
18
- });
19
- markdownFile.endCodeBlock();
20
- markdownFile.addBlankLine();
21
- }
22
- exports.addMermaid = addMermaid;
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
- }
46
- exports.addCustomDocCommentAnnotations = addCustomDocCommentAnnotations;
47
- //# sourceMappingURL=doc-comment-annotation-util.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"doc-comment-annotation-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/doc-comment-annotation-util.ts"],"names":[],"mappings":";;;;;;AACA,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;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,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;AA1BD,wEA0BC"}
@@ -1,3 +0,0 @@
1
- import { MarkdownFile } from '../markdown-file';
2
- import { FieldMirrorWithInheritance, PropertyMirrorWithInheritance } from '../../core/adapters/types';
3
- export declare function declareField(markdownFile: MarkdownFile, fields: FieldMirrorWithInheritance[] | PropertyMirrorWithInheritance[], startingHeadingLevel: number, grouped?: boolean): void;
@@ -1,55 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.declareField = void 0;
4
- function declareField(markdownFile, fields, startingHeadingLevel, grouped = false) {
5
- markdownFile.addBlankLine();
6
- fields.forEach((propertyModel) => {
7
- addFieldSection(markdownFile, propertyModel, startingHeadingLevel, grouped);
8
- });
9
- markdownFile.addHorizontalRule();
10
- }
11
- exports.declareField = declareField;
12
- function addFieldSection(markdownFile, mirrorModel, startingHeadingLevel, grouped) {
13
- var _a, _b, _c;
14
- if (!grouped) {
15
- markdownFile.addTitle(`\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``, startingHeadingLevel + 2);
16
- markdownFile.addBlankLine();
17
- if (mirrorModel.inherited) {
18
- markdownFile.addText('*Inherited*');
19
- }
20
- mirrorModel.annotations.forEach((annotation) => {
21
- markdownFile.addText(`\`${annotation.type.toUpperCase()}\` `);
22
- });
23
- if ((_a = mirrorModel.docComment) === null || _a === void 0 ? void 0 : _a.description) {
24
- markdownFile.addBlankLine();
25
- markdownFile.addText(mirrorModel.docComment.description);
26
- }
27
- markdownFile.addBlankLine();
28
- }
29
- else {
30
- let annotations = '';
31
- const hasAnnotations = !!mirrorModel.annotations.length;
32
- if (hasAnnotations) {
33
- annotations += ' [';
34
- }
35
- mirrorModel.annotations.forEach((annotation) => {
36
- annotations += `\`${annotation.type.toUpperCase()}\` `;
37
- });
38
- if (hasAnnotations) {
39
- annotations += ']';
40
- }
41
- // If grouped we want to display these as a list
42
- let description = '';
43
- if ((_b = mirrorModel.docComment) === null || _b === void 0 ? void 0 : _b.description) {
44
- description = ` - ${(_c = mirrorModel.docComment) === null || _c === void 0 ? void 0 : _c.description}`;
45
- }
46
- let listItemText = `\`${mirrorModel.access_modifier} ${mirrorModel.name}\` → \`${mirrorModel.typeReference.rawDeclaration}\``;
47
- if (mirrorModel.inherited) {
48
- listItemText += '(*Inherited*)';
49
- }
50
- listItemText += `${annotations} ${description}`;
51
- markdownFile.addListItem(listItemText);
52
- markdownFile.addBlankLine();
53
- }
54
- }
55
- //# sourceMappingURL=field-declaration-util.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"field-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/field-declaration-util.ts"],"names":[],"mappings":";;;AAGA,SAAgB,YAAY,CAC1B,YAA0B,EAC1B,MAAsE,EACtE,oBAA4B,EAC5B,OAAO,GAAG,KAAK;IAEf,YAAY,CAAC,YAAY,EAAE,CAAC;IAC5B,MAAM,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;QAC/B,eAAe,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AAZD,oCAYC;AAED,SAAS,eAAe,CACtB,YAA0B,EAC1B,WAA4B,EAC5B,oBAA4B,EAC5B,OAAgB;;IAEhB,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,YAAY,CAAC,QAAQ,CACnB,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EAC1G,oBAAoB,GAAG,CAAC,CACzB,CAAC;QACF,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;YAC1B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACtC,CAAC;QAED,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;YACxC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC3D,CAAC;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;SAAM,CAAC;QACN,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,MAAM,cAAc,GAAG,CAAC,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC;QACxD,IAAI,cAAc,EAAE,CAAC;YACnB,WAAW,IAAI,IAAI,CAAC;QACtB,CAAC;QACD,WAAW,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC7C,WAAW,IAAI,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,KAAK,CAAC;QACzD,CAAC,CAAC,CAAC;QACH,IAAI,cAAc,EAAE,CAAC;YACnB,WAAW,IAAI,GAAG,CAAC;QACrB,CAAC;QAED,gDAAgD;QAChD,IAAI,WAAW,GAAG,EAAE,CAAC;QACrB,IAAI,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;YACxC,WAAW,GAAG,MAAM,MAAA,WAAW,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;QAC5D,CAAC;QAED,IAAI,YAAY,GAAG,KAAK,WAAW,CAAC,eAAe,IAAI,WAAW,CAAC,IAAI,UAAU,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,CAAC;QAC9H,IAAI,WAAW,CAAC,SAAS,EAAE,CAAC;YAC1B,YAAY,IAAI,eAAe,CAAC;QAClC,CAAC;QACD,YAAY,IAAI,GAAG,WAAW,IAAI,WAAW,EAAE,CAAC;QAEhD,YAAY,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QACvC,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;AACH,CAAC"}
@@ -1,3 +0,0 @@
1
- export * from './type-declaration-util';
2
- export * from './method-declaration-util';
3
- export * from './field-declaration-util';
@@ -1,20 +0,0 @@
1
- "use strict";
2
- var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
- if (k2 === undefined) k2 = k;
4
- var desc = Object.getOwnPropertyDescriptor(m, k);
5
- if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
- desc = { enumerable: true, get: function() { return m[k]; } };
7
- }
8
- Object.defineProperty(o, k2, desc);
9
- }) : (function(o, m, k, k2) {
10
- if (k2 === undefined) k2 = k;
11
- o[k2] = m[k];
12
- }));
13
- var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
- for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
- };
16
- Object.defineProperty(exports, "__esModule", { value: true });
17
- __exportStar(require("./type-declaration-util"), exports);
18
- __exportStar(require("./method-declaration-util"), exports);
19
- __exportStar(require("./field-declaration-util"), exports);
20
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0DAAwC;AACxC,4DAA0C;AAC1C,2DAAyC"}
@@ -1,4 +0,0 @@
1
- import { ConstructorMirror } from '@cparra/apex-reflection';
2
- import { MarkdownFile } from '../markdown-file';
3
- import { MethodMirrorWithInheritance } from '../../core/adapters/types';
4
- export declare function declareMethod(markdownFile: MarkdownFile, methods: ConstructorMirror[] | MethodMirrorWithInheritance[], startingHeadingLevel: number, className?: string): void;
@@ -1,115 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.declareMethod = void 0;
4
- const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
5
- function declareMethod(markdownFile, methods, startingHeadingLevel, className = '') {
6
- methods.forEach((currentMethod) => {
7
- var _a, _b;
8
- const signatureName = isMethod(currentMethod)
9
- ? `${currentMethod.typeReference.rawDeclaration} ${currentMethod.name}`
10
- : className;
11
- markdownFile.addTitle(`\`${buildSignature(currentMethod.access_modifier, signatureName, currentMethod)}\``, startingHeadingLevel + 2);
12
- // Inheritance tag
13
- if (isMethod(currentMethod)) {
14
- const asMethodMirror = currentMethod;
15
- if (asMethodMirror.inherited) {
16
- markdownFile.addBlankLine();
17
- markdownFile.addText('*Inherited*');
18
- markdownFile.addBlankLine();
19
- }
20
- }
21
- currentMethod.annotations.forEach((annotation) => {
22
- markdownFile.addBlankLine();
23
- markdownFile.addText(`\`${annotation.type.toUpperCase()}\``);
24
- });
25
- if ((_a = currentMethod.docComment) === null || _a === void 0 ? void 0 : _a.description) {
26
- markdownFile.addBlankLine();
27
- markdownFile.addText(currentMethod.docComment.description);
28
- markdownFile.addBlankLine();
29
- }
30
- if (currentMethod.parameters.length) {
31
- addParameters(markdownFile, currentMethod, startingHeadingLevel);
32
- }
33
- if (isMethod(currentMethod)) {
34
- addReturns(markdownFile, currentMethod, startingHeadingLevel);
35
- }
36
- addThrowsBlock(markdownFile, currentMethod, startingHeadingLevel);
37
- (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, currentMethod);
38
- (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, currentMethod);
39
- if ((_b = currentMethod.docComment) === null || _b === void 0 ? void 0 : _b.exampleAnnotation) {
40
- addExample(markdownFile, currentMethod, startingHeadingLevel);
41
- }
42
- });
43
- markdownFile.addHorizontalRule();
44
- }
45
- exports.declareMethod = declareMethod;
46
- function buildSignature(accessModifier, name, parameterAware) {
47
- let signature = `${name}(`;
48
- if (isMethod(parameterAware) && parameterAware.memberModifiers.length) {
49
- signature =
50
- accessModifier +
51
- ' ' +
52
- parameterAware.memberModifiers.join(' ') +
53
- ' ' +
54
- signature;
55
- }
56
- else {
57
- signature = accessModifier + ' ' + signature;
58
- }
59
- const signatureParameters = parameterAware.parameters.map((param) => `${param.typeReference.rawDeclaration} ${param.name}`);
60
- signature += signatureParameters.join(', ');
61
- return `${signature})`;
62
- }
63
- function addParameters(markdownFile, methodModel, startingHeadingLevel) {
64
- var _a, _b;
65
- if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.paramAnnotations.length)) {
66
- // If there are no parameters defined in the docs then we don't want to display this section
67
- return;
68
- }
69
- markdownFile.addTitle('Parameters', startingHeadingLevel + 3);
70
- markdownFile.initializeTable('Param', 'Description');
71
- (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.paramAnnotations.forEach((paramAnnotation) => {
72
- const paramName = paramAnnotation.paramName;
73
- const paramDescription = paramAnnotation.bodyLines.join(' ');
74
- markdownFile.addTableRow(`\`${paramName}\``, paramDescription);
75
- });
76
- markdownFile.addBlankLine();
77
- }
78
- function addReturns(markdownFile, methodModel, startingHeadingLevel) {
79
- var _a, _b;
80
- if (!((_a = methodModel.docComment) === null || _a === void 0 ? void 0 : _a.returnAnnotation)) {
81
- return;
82
- }
83
- markdownFile.addTitle('Returns', startingHeadingLevel + 3);
84
- markdownFile.initializeTable('Type', 'Description');
85
- markdownFile.addTableRow(`\`${methodModel.typeReference.rawDeclaration}\``, (_b = methodModel.docComment) === null || _b === void 0 ? void 0 : _b.returnAnnotation.bodyLines.join(' '));
86
- markdownFile.addBlankLine();
87
- }
88
- function addThrowsBlock(markdownFile, docCommentAware, startingHeadingLevel) {
89
- var _a, _b;
90
- if (!((_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.throwsAnnotations.length)) {
91
- return;
92
- }
93
- markdownFile.addTitle('Throws', startingHeadingLevel + 3);
94
- markdownFile.initializeTable('Exception', 'Description');
95
- (_b = docCommentAware.docComment) === null || _b === void 0 ? void 0 : _b.throwsAnnotations.forEach((annotation) => {
96
- const exceptionName = annotation.exceptionName;
97
- const exceptionDescription = annotation.bodyLines.join(' ');
98
- markdownFile.addTableRow(`\`${exceptionName}\``, exceptionDescription);
99
- });
100
- markdownFile.addBlankLine();
101
- }
102
- function addExample(markdownFile, docCommentAware, startingHeadingLevel) {
103
- var _a;
104
- markdownFile.addTitle('Example', startingHeadingLevel + 3);
105
- markdownFile.startCodeBlock();
106
- (_a = docCommentAware.docComment) === null || _a === void 0 ? void 0 : _a.exampleAnnotation.bodyLines.forEach((line) => {
107
- markdownFile.addText(line);
108
- });
109
- markdownFile.endCodeBlock();
110
- markdownFile.addBlankLine();
111
- }
112
- function isMethod(method) {
113
- return method.typeReference !== undefined;
114
- }
115
- //# sourceMappingURL=method-declaration-util.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"method-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/method-declaration-util.ts"],"names":[],"mappings":";;;AAGA,+EAA2F;AAG3F,SAAgB,aAAa,CAC3B,YAA0B,EAC1B,OAA4D,EAC5D,oBAA4B,EAC5B,SAAS,GAAG,EAAE;IAEd,OAAO,CAAC,OAAO,CAAC,CAAC,aAAa,EAAE,EAAE;;QAChC,MAAM,aAAa,GAAG,QAAQ,CAAC,aAAa,CAAC;YAC3C,CAAC,CAAC,GAAI,aAA6C,CAAC,aAAa,CAAC,cAAc,IAC3E,aAA6C,CAAC,IACjD,EAAE;YACJ,CAAC,CAAC,SAAS,CAAC;QAEd,YAAY,CAAC,QAAQ,CACnB,KAAK,cAAc,CAAC,aAAa,CAAC,eAAe,EAAE,aAAa,EAAE,aAAa,CAAC,IAAI,EACpF,oBAAoB,GAAG,CAAC,CACzB,CAAC;QAEF,kBAAkB;QAClB,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5B,MAAM,cAAc,GAAG,aAA4C,CAAC;YACpE,IAAI,cAAc,CAAC,SAAS,EAAE,CAAC;gBAC7B,YAAY,CAAC,YAAY,EAAE,CAAC;gBAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;gBACpC,YAAY,CAAC,YAAY,EAAE,CAAC;YAC9B,CAAC;QACH,CAAC;QAED,aAAa,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;YAC/C,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,WAAW,EAAE,CAAC;YAC1C,YAAY,CAAC,YAAY,EAAE,CAAC;YAC5B,YAAY,CAAC,OAAO,CAAC,aAAa,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;YAC3D,YAAY,CAAC,YAAY,EAAE,CAAC;QAC9B,CAAC;QAED,IAAI,aAAa,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;YACpC,aAAa,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5B,UAAU,CAAC,YAAY,EAAE,aAA4C,EAAE,oBAAoB,CAAC,CAAC;QAC/F,CAAC;QAED,cAAc,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QAElE,IAAA,4DAA8B,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAE5D,IAAA,wCAAU,EAAC,YAAY,EAAE,aAAa,CAAC,CAAC;QAExC,IAAI,MAAA,aAAa,CAAC,UAAU,0CAAE,iBAAiB,EAAE,CAAC;YAChD,UAAU,CAAC,YAAY,EAAE,aAAa,EAAE,oBAAoB,CAAC,CAAC;QAChE,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,iBAAiB,EAAE,CAAC;AACnC,CAAC;AA3DD,sCA2DC;AAUD,SAAS,cAAc,CAAC,cAAsB,EAAE,IAAY,EAAE,cAA8B;IAC1F,IAAI,SAAS,GAAG,GAAG,IAAI,GAAG,CAAC;IAC3B,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAK,cAA8C,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACvG,SAAS;YACP,cAAc;gBACd,GAAG;gBACF,cAA8C,CAAC,eAAe,CAAC,IAAI,CAAC,GAAG,CAAC;gBACzE,GAAG;gBACH,SAAS,CAAC;IACd,CAAC;SAAM,CAAC;QACN,SAAS,GAAG,cAAc,GAAG,GAAG,GAAG,SAAS,CAAC;IAC/C,CAAC;IACD,MAAM,mBAAmB,GAAG,cAAc,CAAC,UAAU,CAAC,GAAG,CACvD,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,cAAc,IAAI,KAAK,CAAC,IAAI,EAAE,CACjE,CAAC;IACF,SAAS,IAAI,mBAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,OAAO,GAAG,SAAS,GAAG,CAAC;AACzB,CAAC;AAED,SAAS,aAAa,CACpB,YAA0B,EAC1B,WAA4D,EAC5D,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,MAAM,CAAA,EAAE,CAAC;QACrD,4FAA4F;QAC5F,OAAO;IACT,CAAC;IAED,YAAY,CAAC,QAAQ,CAAC,YAAY,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC9D,YAAY,CAAC,eAAe,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;IAErD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,EAAE;QACnE,MAAM,SAAS,GAAG,eAAe,CAAC,SAAS,CAAC;QAC5C,MAAM,gBAAgB,GAAG,eAAe,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC7D,YAAY,CAAC,WAAW,CAAC,KAAK,SAAS,IAAI,EAAE,gBAAgB,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CACjB,YAA0B,EAC1B,WAAwC,EACxC,oBAA4B;;IAE5B,IAAI,CAAC,CAAA,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAA,EAAE,CAAC;QAC9C,OAAO;IACT,CAAC;IAED,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,eAAe,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;IACpD,YAAY,CAAC,WAAW,CACtB,KAAK,WAAW,CAAC,aAAa,CAAC,cAAc,IAAI,EACjD,MAAA,WAAW,CAAC,UAAU,0CAAE,gBAAgB,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAC7D,CAAC;IACF,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,cAAc,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAChH,IAAI,CAAC,CAAA,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,MAAM,CAAA,EAAE,CAAC;QAC1D,OAAO;IACT,CAAC;IACD,YAAY,CAAC,QAAQ,CAAC,QAAQ,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC1D,YAAY,CAAC,eAAe,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;IAEzD,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;QACnE,MAAM,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;QAC/C,MAAM,oBAAoB,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAE5D,YAAY,CAAC,WAAW,CAAC,KAAK,aAAa,IAAI,EAAE,oBAAoB,CAAC,CAAC;IACzE,CAAC,CAAC,CAAC;IAEH,YAAY,CAAC,YAAY,EAAE,CAAC;AAC9B,CAAC;AAED,SAAS,UAAU,CAAC,YAA0B,EAAE,eAAgC,EAAE,oBAA4B;;IAC5G,YAAY,CAAC,QAAQ,CAAC,SAAS,EAAE,oBAAoB,GAAG,CAAC,CAAC,CAAC;IAC3D,YAAY,CAAC,cAAc,EAAE,CAAC;IAC9B,MAAA,eAAe,CAAC,UAAU,0CAAE,iBAAiB,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACvE,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,SAAS,QAAQ,CACf,MAAwE;IAExE,OAAQ,MAAsC,CAAC,aAAa,KAAK,SAAS,CAAC;AAC7E,CAAC"}
@@ -1,3 +0,0 @@
1
- import { MarkdownFile } from '../markdown-file';
2
- import { Type } from '@cparra/apex-reflection';
3
- export declare function declareType(markdownFile: MarkdownFile, typeMirror: Type): void;
@@ -1,82 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.declareType = void 0;
4
- const doc_comment_annotation_util_1 = require("./doc-comment-annotation-util");
5
- const types_repository_1 = require("../types-repository");
6
- function declareType(markdownFile, typeMirror) {
7
- var _a;
8
- typeMirror.annotations.forEach((currentAnnotation) => {
9
- markdownFile.addBlankLine();
10
- markdownFile.addText(`\`${currentAnnotation.type.toUpperCase()}\``);
11
- });
12
- if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
13
- markdownFile.addBlankLine();
14
- for (const currentLine of typeMirror.docComment.descriptionLines) {
15
- markdownFile.addText(currentLine);
16
- }
17
- markdownFile.addBlankLine();
18
- }
19
- if (typeMirror.type_name === 'class') {
20
- addInheritanceSectionForClass(typeMirror, markdownFile);
21
- }
22
- if (typeMirror.type_name === 'interface') {
23
- addInheritanceSectionForInterface(typeMirror, markdownFile);
24
- }
25
- (0, doc_comment_annotation_util_1.addCustomDocCommentAnnotations)(markdownFile, typeMirror);
26
- (0, doc_comment_annotation_util_1.addMermaid)(markdownFile, typeMirror);
27
- }
28
- exports.declareType = declareType;
29
- function addInheritanceSectionForClass(typeMirror, markdownFile) {
30
- const typeAsClass = typeMirror;
31
- if (typeAsClass.extended_class) {
32
- markdownFile.addBlankLine();
33
- markdownFile.addText('**Inheritance**');
34
- markdownFile.addBlankLine();
35
- addParent(markdownFile, typeAsClass);
36
- markdownFile.addText(typeMirror.name);
37
- markdownFile.addBlankLine();
38
- }
39
- if (typeAsClass.implemented_interfaces.length) {
40
- markdownFile.addBlankLine();
41
- markdownFile.addText('**Implemented types**');
42
- markdownFile.addBlankLine();
43
- for (let i = 0; i < typeAsClass.implemented_interfaces.length; i++) {
44
- const currentName = typeAsClass.implemented_interfaces[i];
45
- markdownFile.addLink(currentName);
46
- if (i < typeAsClass.implemented_interfaces.length - 1) {
47
- markdownFile.addText(', ');
48
- }
49
- }
50
- markdownFile.addBlankLine();
51
- }
52
- }
53
- function addInheritanceSectionForInterface(typeMirror, markdownFile) {
54
- const typeAsInterface = typeMirror;
55
- if (typeAsInterface.extended_interfaces.length) {
56
- markdownFile.addBlankLine();
57
- markdownFile.addText('**Extended types**');
58
- markdownFile.addBlankLine();
59
- for (let i = 0; i < typeAsInterface.extended_interfaces.length; i++) {
60
- const currentName = typeAsInterface.extended_interfaces[i];
61
- markdownFile.addLink(currentName);
62
- if (i < typeAsInterface.extended_interfaces.length - 1) {
63
- markdownFile.addText(', ');
64
- }
65
- }
66
- }
67
- }
68
- function addParent(markdownFile, classMirror) {
69
- if (!classMirror.extended_class) {
70
- return;
71
- }
72
- const parentType = types_repository_1.TypesRepository.getInstance().getFromScopedByName(classMirror.extended_class);
73
- if (!parentType) {
74
- return;
75
- }
76
- if (parentType.type_name === 'class') {
77
- addParent(markdownFile, parentType);
78
- }
79
- markdownFile.addLink(parentType.name);
80
- markdownFile.addText(' > ');
81
- }
82
- //# sourceMappingURL=type-declaration-util.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"type-declaration-util.js","sourceRoot":"","sources":["../../../src/model/markdown-generation-util/type-declaration-util.ts"],"names":[],"mappings":";;;AACA,+EAA2F;AAE3F,0DAAsD;AAEtD,SAAgB,WAAW,CAAC,YAA0B,EAAE,UAAgB;;IACtE,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,iBAA6B,EAAE,EAAE;QAC/D,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,KAAK,iBAAiB,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;IACtE,CAAC,CAAC,CAAC;IAEH,IAAI,MAAA,UAAU,CAAC,UAAU,0CAAE,gBAAgB,EAAE,CAAC;QAC5C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,KAAK,MAAM,WAAW,IAAI,UAAU,CAAC,UAAU,CAAC,gBAAgB,EAAE,CAAC;YACjE,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACpC,CAAC;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;IAED,IAAI,UAAU,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;QACrC,6BAA6B,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAC1D,CAAC;IAED,IAAI,UAAU,CAAC,SAAS,KAAK,WAAW,EAAE,CAAC;QACzC,iCAAiC,CAAC,UAAU,EAAE,YAAY,CAAC,CAAC;IAC9D,CAAC;IAED,IAAA,4DAA8B,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IAEzD,IAAA,wCAAU,EAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AACvC,CAAC;AAzBD,kCAyBC;AAED,SAAS,6BAA6B,CAAC,UAAgB,EAAE,YAA0B;IACjF,MAAM,WAAW,GAAG,UAAyB,CAAC;IAC9C,IAAI,WAAW,CAAC,cAAc,EAAE,CAAC;QAC/B,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC;QACxC,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,SAAS,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;QACrC,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;IAED,IAAI,WAAW,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC;QAC9C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,uBAAuB,CAAC,CAAC;QAC9C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,sBAAsB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACnE,MAAM,WAAW,GAAG,WAAW,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;YAC1D,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,WAAW,CAAC,sBAAsB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACtD,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QACD,YAAY,CAAC,YAAY,EAAE,CAAC;IAC9B,CAAC;AACH,CAAC;AAED,SAAS,iCAAiC,CAAC,UAAgB,EAAE,YAA0B;IACrF,MAAM,eAAe,GAAG,UAA6B,CAAC;IACtD,IAAI,eAAe,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC;QAC/C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,YAAY,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC3C,YAAY,CAAC,YAAY,EAAE,CAAC;QAC5B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,eAAe,CAAC,mBAAmB,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YACpE,MAAM,WAAW,GAAG,eAAe,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC;YAC3D,YAAY,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAClC,IAAI,CAAC,GAAG,eAAe,CAAC,mBAAmB,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvD,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,SAAS,CAAC,YAA0B,EAAE,WAAwB;IACrE,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC;QAChC,OAAO;IACT,CAAC;IAED,MAAM,UAAU,GAAG,kCAAe,CAAC,WAAW,EAAE,CAAC,mBAAmB,CAAC,WAAW,CAAC,cAAc,CAAC,CAAC;IACjG,IAAI,CAAC,UAAU,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,IAAI,UAAU,CAAC,SAAS,KAAK,OAAO,EAAE,CAAC;QACrC,SAAS,CAAC,YAAY,EAAE,UAAyB,CAAC,CAAC;IACrD,CAAC;IAED,YAAY,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC"}
@@ -1,11 +0,0 @@
1
- import { Type } from '@cparra/apex-reflection';
2
- import { MarkdownFile } from './markdown-file';
3
- export declare class MarkdownHomeFile extends MarkdownFile {
4
- fileName: string;
5
- types: Type[];
6
- constructor(fileName: string, types: Type[], headerContent?: string);
7
- private addTypeEntries;
8
- private addTypeEntry;
9
- private group;
10
- private getClassGroup;
11
- }
@@ -1,57 +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.MarkdownHomeFile = void 0;
7
- const class_file_generatorHelper_1 = __importDefault(require("../transpiler/markdown/class-file-generatorHelper"));
8
- const markdown_file_1 = require("./markdown-file");
9
- const string_utils_1 = require("../util/string-utils");
10
- const settings_1 = require("../settings");
11
- class MarkdownHomeFile extends markdown_file_1.MarkdownFile {
12
- constructor(fileName, types, headerContent) {
13
- super(fileName, '');
14
- this.fileName = fileName;
15
- this.types = types;
16
- if (headerContent) {
17
- this.addText(headerContent);
18
- }
19
- this.addTitle(settings_1.Settings.getInstance().getTitle());
20
- this.addTypeEntries(types);
21
- }
22
- addTypeEntries(types) {
23
- const groupedClasses = this.group(types);
24
- groupedClasses.forEach((value, key) => {
25
- this.addTitle(key, 2);
26
- value.forEach((typeMirror) => {
27
- this.addTypeEntry(typeMirror);
28
- });
29
- });
30
- }
31
- addTypeEntry(typeMirror) {
32
- var _a;
33
- this.addBlankLine();
34
- this.addTitle(class_file_generatorHelper_1.default.getFileLink(typeMirror), 3);
35
- this.addBlankLine();
36
- if ((_a = typeMirror.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines) {
37
- const description = typeMirror.docComment.descriptionLines.reduce((previous, current) => previous + current + '\n', '');
38
- this.addText((0, string_utils_1.truncate)(description, 300));
39
- this.addBlankLine();
40
- }
41
- }
42
- group(classes) {
43
- return classes.reduce((groups, currentClass) => {
44
- const key = this.getClassGroup(currentClass);
45
- const group = groups.get(key) || [];
46
- group.push(currentClass);
47
- groups.set(key, group);
48
- return groups;
49
- }, new Map());
50
- }
51
- getClassGroup(classModel) {
52
- var _a, _b, _c;
53
- return ((_c = (_b = (_a = classModel.docComment) === null || _a === void 0 ? void 0 : _a.annotations.find((annotation) => annotation.name === 'group')) === null || _b === void 0 ? void 0 : _b.body) !== null && _c !== void 0 ? _c : settings_1.Settings.getInstance().getDefaultGroupName());
54
- }
55
- }
56
- exports.MarkdownHomeFile = MarkdownHomeFile;
57
- //# sourceMappingURL=markdown-home-file.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"markdown-home-file.js","sourceRoot":"","sources":["../../src/model/markdown-home-file.ts"],"names":[],"mappings":";;;;;;AACA,mHAAyF;AACzF,mDAA+C;AAC/C,uDAAgD;AAChD,0CAAuC;AAEvC,MAAa,gBAAiB,SAAQ,4BAAY;IAChD,YAAmB,QAAgB,EAAS,KAAa,EAAE,aAAsB;QAC/E,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;QADH,aAAQ,GAAR,QAAQ,CAAQ;QAAS,UAAK,GAAL,KAAK,CAAQ;QAEvD,IAAI,aAAa,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9B,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IAC7B,CAAC;IAEO,cAAc,CAAC,KAAa;QAClC,MAAM,cAAc,GAAwB,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC9D,cAAc,CAAC,OAAO,CAAC,CAAC,KAAa,EAAE,GAAW,EAAE,EAAE;YACpD,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;YACtB,KAAK,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBAC3B,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC;YAChC,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;IAEO,YAAY,CAAC,UAAgB;;QACnC,IAAI,CAAC,YAAY,EAAE,CAAC;QACpB,IAAI,CAAC,QAAQ,CAAC,oCAAwB,CAAC,WAAW,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC,CAAC;QACnE,IAAI,CAAC,YAAY,EAAE,CAAC;QAEpB,IAAI,MAAA,UAAU,CAAC,UAAU,0CAAE,gBAAgB,EAAE,CAAC;YAC5C,MAAM,WAAW,GAAG,UAAU,CAAC,UAAU,CAAC,gBAAgB,CAAC,MAAM,CAC/D,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,QAAQ,GAAG,OAAO,GAAG,IAAI,EAChD,EAAE,CACH,CAAC;YACF,IAAI,CAAC,OAAO,CAAC,IAAA,uBAAQ,EAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;YACzC,IAAI,CAAC,YAAY,EAAE,CAAC;QACtB,CAAC;IACH,CAAC;IAEO,KAAK,CAAC,OAAe;QAC3B,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,YAAY,EAAE,EAAE;YAC7C,MAAM,GAAG,GAAG,IAAI,CAAC,aAAa,CAAC,YAAY,CAAC,CAAC;YAC7C,MAAM,KAAK,GAAW,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YACzB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC,EAAE,IAAI,GAAG,EAAE,CAAC,CAAC;IAChB,CAAC;IAEO,aAAa,CAAC,UAAgB;;QACpC,OAAO,CACL,MAAA,MAAA,MAAA,UAAU,CAAC,UAAU,0CAAE,WAAW,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,0CAAE,IAAI,mCAC1F,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE,CAC7C,CAAC;IACJ,CAAC;CACF;AAnDD,4CAmDC"}