@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,113 +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.Apexdocs = void 0;
7
- const apex_file_reader_1 = require("../service/apex-file-reader");
8
- const file_system_1 = require("../service/file-system");
9
- const apex_reflection_1 = require("@cparra/apex-reflection");
10
- const logger_1 = require("../util/logger");
11
- const manifest_factory_1 = require("../service/manifest-factory");
12
- const parser_1 = require("../service/parser");
13
- const settings_1 = require("../settings");
14
- const transpiler_1 = __importDefault(require("../transpiler/transpiler"));
15
- const file_writer_1 = require("../service/file-writer");
16
- const error_logger_1 = __importDefault(require("../util/error-logger"));
17
- const types_repository_1 = require("../model/types-repository");
18
- const factory_1 = require("../transpiler/factory");
19
- const generate_markdown_files_1 = require("./generators/generate-markdown-files");
20
- /**
21
- * Application entry-point to generate documentation out of Apex source files.
22
- */
23
- class Apexdocs {
24
- /**
25
- * Generates documentation out of Apex source files.
26
- */
27
- static generate(config) {
28
- logger_1.Logger.logSingle('Initializing...', false);
29
- this.initializeSettings(config);
30
- const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
31
- if (settings_1.Settings.getInstance().targetGenerator === 'plain-markdown') {
32
- (0, generate_markdown_files_1.generateMarkdownFiles)(fileBodies);
33
- }
34
- else {
35
- const manifest = (0, manifest_factory_1.createManifest)(new parser_1.RawBodyParser(fileBodies), this._reflectionWithLogger);
36
- types_repository_1.TypesRepository.getInstance().populateAll(manifest.types);
37
- const filteredTypes = this.filterByScopes(manifest);
38
- types_repository_1.TypesRepository.getInstance().populateScoped(filteredTypes);
39
- const processor = factory_1.TypeTranspilerFactory.get(settings_1.Settings.getInstance().targetGenerator);
40
- transpiler_1.default.generate(filteredTypes, processor);
41
- const generatedFiles = processor.fileBuilder().files();
42
- const files = [];
43
- file_writer_1.FileWriter.write(generatedFiles, (file) => {
44
- logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
45
- files.push(file);
46
- });
47
- settings_1.Settings.getInstance().onAfterProcess(files);
48
- // Error logging
49
- error_logger_1.default.logErrors(filteredTypes);
50
- }
51
- }
52
- static initializeSettings(argv) {
53
- const targetGenerator = argv.targetGenerator;
54
- settings_1.Settings.build({
55
- sourceDirectory: argv.sourceDir,
56
- recursive: argv.recursive,
57
- scope: argv.scope,
58
- outputDir: argv.targetDir,
59
- targetGenerator: targetGenerator,
60
- indexOnly: argv.indexOnly,
61
- defaultGroupName: argv.defaultGroupName,
62
- sanitizeHtml: argv.sanitizeHtml,
63
- openApiTitle: argv.openApiTitle,
64
- title: argv.title,
65
- namespace: argv.namespace,
66
- openApiFileName: argv.openApiFileName,
67
- sortMembersAlphabetically: argv.sortMembersAlphabetically,
68
- includeMetadata: argv.includeMetadata,
69
- rootDir: argv.documentationRootDir,
70
- onAfterProcess: argv.onAfterProcess,
71
- onBeforeFileWrite: argv.onBeforeFileWrite,
72
- frontMatterHeader: argv.frontMatterHeader,
73
- linkingStrategy: targetGenerator === 'plain-markdown'
74
- ? 'path-relative'
75
- : factory_1.TypeTranspilerFactory.get(targetGenerator).getLinkingStrategy(),
76
- });
77
- }
78
- static filterByScopes(manifest) {
79
- let filteredTypes;
80
- let filteredLogMessage;
81
- if (settings_1.Settings.getInstance().config.targetGenerator !== 'openapi') {
82
- filteredTypes = manifest.filteredByAccessModifierAndAnnotations(settings_1.Settings.getInstance().scope);
83
- filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s) based on scope: ${settings_1.Settings.getInstance().scope}`;
84
- }
85
- else {
86
- // If we are dealing with an OpenApi generator, we ignore the passed in access modifiers, and instead
87
- // we only keep classes annotated as @RestResource
88
- filteredTypes = manifest.filteredByAccessModifierAndAnnotations([
89
- 'restresource',
90
- 'httpdelete',
91
- 'httpget',
92
- 'httppatch',
93
- 'httppost',
94
- 'httpput',
95
- ]);
96
- filteredLogMessage = `Filtered ${manifest.types.length - filteredTypes.length} file(s), only keeping classes annotated as @RestResource.`;
97
- }
98
- logger_1.Logger.clear();
99
- logger_1.Logger.logSingle(filteredLogMessage, false, 'green', false);
100
- logger_1.Logger.logSingle(`Creating documentation for ${filteredTypes.length} file(s)`, false, 'green', false);
101
- return filteredTypes;
102
- }
103
- }
104
- exports.Apexdocs = Apexdocs;
105
- Apexdocs._reflectionWithLogger = (apexBundle) => {
106
- var _a;
107
- const result = (0, apex_reflection_1.reflect)(apexBundle.rawTypeContent);
108
- if (result.error) {
109
- logger_1.Logger.error(`${apexBundle.filePath} - Parsing error ${(_a = result.error) === null || _a === void 0 ? void 0 : _a.message}`);
110
- }
111
- return result;
112
- };
113
- //# sourceMappingURL=Apexdocs.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"Apexdocs.js","sourceRoot":"","sources":["../../src/application/Apexdocs.ts"],"names":[],"mappings":";;;;;;AAAA,kEAA6D;AAC7D,wDAA2D;AAC3D,6DAA0E;AAC1E,2CAAwC;AACxC,kEAA6D;AAC7D,8CAAkD;AAClD,0CAAmD;AACnD,0EAAkD;AAClD,wDAAoD;AACpD,wEAA+C;AAG/C,gEAA4D;AAC5D,mDAA8D;AAC9D,kFAA6E;AAI7E;;GAEG;AACH,MAAa,QAAQ;IACnB;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,MAA8B;QAC5C,eAAM,CAAC,SAAS,CAAC,iBAAiB,EAAE,KAAK,CAAC,CAAC;QAC3C,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC;QAChC,MAAM,UAAU,GAAG,iCAAc,CAAC,YAAY,CAAC,IAAI,+BAAiB,EAAE,CAAC,CAAC;QAExE,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,KAAK,gBAAgB,EAAE,CAAC;YAChE,IAAA,+CAAqB,EAAC,UAAU,CAAC,CAAC;QACpC,CAAC;aAAM,CAAC;YACN,MAAM,QAAQ,GAAG,IAAA,iCAAc,EAAC,IAAI,sBAAa,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC,qBAAqB,CAAC,CAAC;YAC3F,kCAAe,CAAC,WAAW,EAAE,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAC1D,MAAM,aAAa,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;YACpD,kCAAe,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,aAAa,CAAC,CAAC;YAC5D,MAAM,SAAS,GAAG,+BAAqB,CAAC,GAAG,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,eAAe,CAAC,CAAC;YACpF,oBAAU,CAAC,QAAQ,CAAC,aAAa,EAAE,SAAS,CAAC,CAAC;YAC9C,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,EAAE,CAAC,KAAK,EAAE,CAAC;YAEvD,MAAM,KAAK,GAAiB,EAAE,CAAC;YAC/B,wBAAU,CAAC,KAAK,CAAC,cAAc,EAAE,CAAC,IAAgB,EAAE,EAAE;gBACpD,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;gBACnE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;YAEH,mBAAQ,CAAC,WAAW,EAAE,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;YAE7C,gBAAgB;YAChB,sBAAW,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;QACvC,CAAC;IACH,CAAC;IAEO,MAAM,CAAC,kBAAkB,CAAC,IAA4B;QAC5D,MAAM,eAAe,GAAG,IAAI,CAAC,eAAmC,CAAC;QACjE,mBAAQ,CAAC,KAAK,CAAC;YACb,eAAe,EAAE,IAAI,CAAC,SAAS;YAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,eAAe;YAChC,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,SAAS,EAAE,IAAI,CAAC,SAAS;YACzB,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,yBAAyB,EAAE,IAAI,CAAC,yBAAyB;YACzD,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,OAAO,EAAE,IAAI,CAAC,oBAAoB;YAClC,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,eAAe,EACb,eAAe,KAAK,gBAAgB;gBAClC,CAAC,CAAC,eAAe;gBACjB,CAAC,CAAC,+BAAqB,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC,kBAAkB,EAAE;SACtE,CAAC,CAAC;IACL,CAAC;IAEO,MAAM,CAAC,cAAc,CAAC,QAAkB;QAC9C,IAAI,aAAqB,CAAC;QAC1B,IAAI,kBAAkB,CAAC;QACvB,IAAI,mBAAQ,CAAC,WAAW,EAAE,CAAC,MAAM,CAAC,eAAe,KAAK,SAAS,EAAE,CAAC;YAChE,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,CAAC;YAC9F,kBAAkB,GAAG,YAAY,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MAAM,4BAC3E,mBAAQ,CAAC,WAAW,EAAE,CAAC,KACzB,EAAE,CAAC;QACL,CAAC;aAAM,CAAC;YACN,qGAAqG;YACrG,kDAAkD;YAClD,aAAa,GAAG,QAAQ,CAAC,sCAAsC,CAAC;gBAC9D,cAAc;gBACd,YAAY;gBACZ,SAAS;gBACT,WAAW;gBACX,UAAU;gBACV,SAAS;aACV,CAAC,CAAC;YACH,kBAAkB,GAAG,YACnB,QAAQ,CAAC,KAAK,CAAC,MAAM,GAAG,aAAa,CAAC,MACxC,4DAA4D,CAAC;QAC/D,CAAC;QACD,eAAM,CAAC,KAAK,EAAE,CAAC;QAEf,eAAM,CAAC,SAAS,CAAC,kBAAkB,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QAC5D,eAAM,CAAC,SAAS,CAAC,8BAA8B,aAAa,CAAC,MAAM,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;QACtG,OAAO,aAAa,CAAC;IACvB,CAAC;;AAzFH,4BAkGC;AAPQ,8BAAqB,GAAG,CAAC,UAAsB,EAAoB,EAAE;;IAC1E,MAAM,MAAM,GAAG,IAAA,yBAAO,EAAC,UAAU,CAAC,cAAc,CAAC,CAAC;IAClD,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,eAAM,CAAC,KAAK,CAAC,GAAG,UAAU,CAAC,QAAQ,oBAAoB,MAAA,MAAM,CAAC,KAAK,0CAAE,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC"}
@@ -1,3 +0,0 @@
1
- import ApexBundle from '../../core/apex-bundle';
2
- import * as E from 'fp-ts/Either';
3
- export declare const generateMarkdownFiles: (bundles: ApexBundle[]) => E.Either<void, void>;
@@ -1,64 +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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
- Object.defineProperty(exports, "__esModule", { value: true });
26
- exports.generateMarkdownFiles = void 0;
27
- const settings_1 = require("../../settings");
28
- const generate_docs_1 = require("../../core/generate-docs");
29
- const markdown_file_1 = require("../../model/markdown-file");
30
- const file_writer_1 = require("../../service/file-writer");
31
- const logger_1 = require("../../util/logger");
32
- const function_1 = require("fp-ts/function");
33
- const E = __importStar(require("fp-ts/Either"));
34
- exports.generateMarkdownFiles = (0, function_1.flow)(generateDocumentationBundle, E.map(convertToMarkdownFiles), E.map(writeFilesToSystem), E.mapLeft((errors) => {
35
- const errorMessages = [
36
- 'Error(s) occurred while parsing files. Please review the following issues:',
37
- ...errors.map(formatReflectionError),
38
- ].join('\n');
39
- logger_1.Logger.error(errorMessages);
40
- }));
41
- function generateDocumentationBundle(bundles) {
42
- return (0, generate_docs_1.generateDocs)(bundles, {
43
- scope: settings_1.Settings.getInstance().scope,
44
- outputDir: settings_1.Settings.getInstance().outputDir,
45
- namespace: settings_1.Settings.getInstance().getNamespace(),
46
- sortMembersAlphabetically: settings_1.Settings.getInstance().sortMembersAlphabetically(),
47
- defaultGroupName: settings_1.Settings.getInstance().getDefaultGroupName(),
48
- });
49
- }
50
- function convertToMarkdownFiles(docBundle) {
51
- return [
52
- new markdown_file_1.MarkdownFile('index', '').addText(docBundle.referenceGuide),
53
- ...docBundle.docs.map((doc) => new markdown_file_1.MarkdownFile(`${settings_1.Settings.getInstance().getNamespacePrefix()}${doc.typeName}`, doc.directory).addText(doc.docContents)),
54
- ];
55
- }
56
- function writeFilesToSystem(files) {
57
- file_writer_1.FileWriter.write(files, (file) => {
58
- logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
59
- });
60
- }
61
- function formatReflectionError(error) {
62
- return `Source file: ${error.file}\n${error.message}\n`;
63
- }
64
- //# sourceMappingURL=generate-markdown-files.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"generate-markdown-files.js","sourceRoot":"","sources":["../../../src/application/generators/generate-markdown-files.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAAsD;AACtD,4DAA8F;AAC9F,6DAAyD;AACzD,2DAAuD;AACvD,8CAA2C;AAC3C,6CAAsC;AACtC,gDAAkC;AAErB,QAAA,qBAAqB,GAAG,IAAA,eAAI,EACvC,2BAA2B,EAC3B,CAAC,CAAC,GAAG,CAAC,sBAAsB,CAAC,EAC7B,CAAC,CAAC,GAAG,CAAC,kBAAkB,CAAC,EACzB,CAAC,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,EAAE;IACnB,MAAM,aAAa,GAAG;QACpB,4EAA4E;QAC5E,GAAG,MAAM,CAAC,GAAG,CAAC,qBAAqB,CAAC;KACrC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,eAAM,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;AAC9B,CAAC,CAAC,CACH,CAAC;AAEF,SAAS,2BAA2B,CAAC,OAAqB;IACxD,OAAO,IAAA,4BAAY,EAAC,OAAO,EAAE;QAC3B,KAAK,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,KAAK;QACnC,SAAS,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,SAAS;QAC3C,SAAS,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE;QAChD,yBAAyB,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,yBAAyB,EAAE;QAC7E,gBAAgB,EAAE,mBAAQ,CAAC,WAAW,EAAE,CAAC,mBAAmB,EAAE;KAC/D,CAAC,CAAC;AACL,CAAC;AAED,SAAS,sBAAsB,CAAC,SAA8B;IAC5D,OAAO;QACL,IAAI,4BAAY,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC;QAC/D,GAAG,SAAS,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAC5B,IAAI,4BAAY,CAAC,GAAG,mBAAQ,CAAC,WAAW,EAAE,CAAC,kBAAkB,EAAE,GAAG,GAAG,CAAC,QAAQ,EAAE,EAAE,GAAG,CAAC,SAAS,CAAC,CAAC,OAAO,CACtG,GAAG,CAAC,WAAW,CAChB,CACF;KACF,CAAC;AACJ,CAAC;AAED,SAAS,kBAAkB,CAAC,KAAqB;IAC/C,wBAAU,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,IAAgB,EAAE,EAAE;QAC3C,eAAM,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,IAAI,aAAa,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,CAAC;IACrE,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,OAAO,gBAAgB,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,IAAI,CAAC;AAC1D,CAAC"}
@@ -1,39 +0,0 @@
1
- import { Settings } from '../settings';
2
- import { CosmiconfigResult } from 'cosmiconfig';
3
- type OnlyConfigurableThroughFile = {
4
- onAfterProcess: Settings['onAfterProcess'];
5
- onBeforeFileWrite: Settings['onBeforeFileWrite'];
6
- frontMatterHeader: Settings['frontMatterHeader'];
7
- };
8
- type YargsArgs = ReturnType<typeof _extractYargs>;
9
- type ConfigurableThroughFile = YargsArgs & OnlyConfigurableThroughFile;
10
- export type AllConfigurableOptions = Partial<ConfigurableThroughFile> & YargsArgs;
11
- /**
12
- * Extracts arguments from the command line.
13
- * @param config The configuration object from the configuration file, if any.
14
- */
15
- declare function _extractYargs(config?: CosmiconfigResult): {
16
- [x: string]: unknown;
17
- sourceDir: string;
18
- targetDir: string;
19
- recursive: boolean;
20
- scope: string[];
21
- targetGenerator: string;
22
- indexOnly: boolean;
23
- defaultGroupName: string;
24
- sanitizeHtml: boolean;
25
- openApiTitle: string;
26
- title: string;
27
- namespace: string | undefined;
28
- openApiFileName: string;
29
- sortMembersAlphabetically: boolean;
30
- includeMetadata: boolean;
31
- documentationRootDir: string | undefined;
32
- _: (string | number)[];
33
- $0: string;
34
- };
35
- /**
36
- * Combines the extracted configuration and arguments.
37
- */
38
- export declare function extractArgs(): Promise<AllConfigurableOptions>;
39
- export {};
package/dist/cli/args.js DELETED
@@ -1,154 +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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
14
- Object.defineProperty(o, "default", { enumerable: true, value: v });
15
- }) : function(o, v) {
16
- o["default"] = v;
17
- });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
25
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
26
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
27
- return new (P || (P = Promise))(function (resolve, reject) {
28
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
29
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
30
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
31
- step((generator = generator.apply(thisArg, _arguments || [])).next());
32
- });
33
- };
34
- Object.defineProperty(exports, "__esModule", { value: true });
35
- exports.extractArgs = void 0;
36
- const cosmiconfig_1 = require("cosmiconfig");
37
- const yargs = __importStar(require("yargs"));
38
- /**
39
- * Extracts configuration from a configuration file or the package.json
40
- * through cosmiconfig.
41
- */
42
- function _extractConfig() {
43
- return (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
44
- }
45
- /**
46
- * Extracts arguments from the command line.
47
- * @param config The configuration object from the configuration file, if any.
48
- */
49
- function _extractYargs(config) {
50
- return yargs
51
- .config(config === null || config === void 0 ? void 0 : config.config)
52
- .options({
53
- sourceDir: {
54
- type: 'string',
55
- alias: 's',
56
- demandOption: true,
57
- describe: 'The directory location which contains your apex .cls classes.',
58
- },
59
- targetDir: {
60
- type: 'string',
61
- alias: 't',
62
- default: './docs/',
63
- describe: 'The directory location where documentation will be generated to.',
64
- },
65
- recursive: {
66
- type: 'boolean',
67
- alias: 'r',
68
- default: true,
69
- describe: 'Whether .cls classes will be searched for recursively in the directory provided.',
70
- },
71
- scope: {
72
- type: 'string',
73
- array: true,
74
- alias: 'p',
75
- default: ['global'],
76
- describe: 'A list of scopes to document. Values should be separated by a space, e.g --scope global public namespaceaccessible. ' +
77
- 'Annotations are supported and should be passed lowercased and without the @ symbol, e.g. namespaceaccessible auraenabled. ' +
78
- 'Note that this setting is ignored if generating an OpenApi REST specification since that looks for classes annotated with @RestResource.',
79
- },
80
- targetGenerator: {
81
- type: 'string',
82
- alias: 'g',
83
- default: 'jekyll',
84
- choices: ['jekyll', 'docsify', 'plain-markdown', 'openapi'],
85
- describe: 'Define the static file generator for which the documents will be created. ' +
86
- 'Currently supports jekyll, docsify, plain markdown, and OpenAPI v3.1.0.',
87
- },
88
- indexOnly: {
89
- type: 'boolean',
90
- default: false,
91
- describe: 'Defines whether only the index file should be generated.',
92
- },
93
- defaultGroupName: {
94
- type: 'string',
95
- default: 'Miscellaneous',
96
- describe: 'Defines the @group name to be used when a file does not specify it.',
97
- },
98
- sanitizeHtml: {
99
- type: 'boolean',
100
- default: true,
101
- describe: 'When on, any special character within your ApexDocs is converted into its HTML code representation. ' +
102
- 'This is specially useful when generic objects are described within the docs, e.g. "List< Foo>", "Map<Foo, Bar>" ' +
103
- 'because otherwise the content within < and > would be treated as HTML tags and not shown in the output. ' +
104
- 'Content in @example blocks are never sanitized.',
105
- },
106
- openApiTitle: {
107
- type: 'string',
108
- default: 'Apex REST Api',
109
- describe: 'If using "openapi" as the target generator, this allows you to specify the OpenApi title value.',
110
- },
111
- title: {
112
- type: 'string',
113
- describe: "If this allows you to specify the title of the generated documentation's home file.",
114
- default: 'Classes',
115
- },
116
- namespace: {
117
- type: 'string',
118
- describe: 'The package namespace, if any. If this value is provided the namespace will be added as a prefix to all of the parsed files. ' +
119
- "If generating an OpenApi definition, it will be added to the file's Server Url.",
120
- },
121
- openApiFileName: {
122
- type: 'string',
123
- describe: 'If using "openapi" as the target generator, this allows you to specify the name of the output file.',
124
- default: 'openapi',
125
- },
126
- sortMembersAlphabetically: {
127
- type: 'boolean',
128
- describe: 'Whether to sort members alphabetically.',
129
- default: false,
130
- },
131
- includeMetadata: {
132
- type: 'boolean',
133
- describe: "Whether to include the file's meta.xml information: Whether it is active and and the API version",
134
- default: false,
135
- },
136
- documentationRootDir: {
137
- type: 'string',
138
- describe: 'Allows you to specify the root documentation directory where the files are being generated. This can be helpful when embedding the generated docs into an existing site so that the links are generated correctly.',
139
- },
140
- })
141
- .parseSync();
142
- }
143
- /**
144
- * Combines the extracted configuration and arguments.
145
- */
146
- function extractArgs() {
147
- return __awaiter(this, void 0, void 0, function* () {
148
- const config = yield _extractConfig();
149
- const cliArgs = _extractYargs(config);
150
- return Object.assign(Object.assign({}, config === null || config === void 0 ? void 0 : config.config), cliArgs);
151
- });
152
- }
153
- exports.extractArgs = extractArgs;
154
- //# sourceMappingURL=args.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"args.js","sourceRoot":"","sources":["../../src/cli/args.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AACA,6CAA6D;AAC7D,6CAA+B;AAc/B;;;GAGG;AACH,SAAS,cAAc;IACrB,OAAO,IAAA,yBAAW,EAAC,UAAU,CAAC,CAAC,MAAM,EAAE,CAAC;AAC1C,CAAC;AAED;;;GAGG;AACH,SAAS,aAAa,CAAC,MAA0B;IAC/C,OAAO,KAAK;SACT,MAAM,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC;SACtB,OAAO,CAAC;QACP,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,+DAA+D;SAC1E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,kEAAkE;SAC7E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,IAAI;YACb,QAAQ,EAAE,kFAAkF;SAC7F;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,CAAC,QAAQ,CAAC;YACnB,QAAQ,EACN,sHAAsH;gBACtH,4HAA4H;gBAC5H,0IAA0I;SAC7I;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,GAAG;YACV,OAAO,EAAE,QAAQ;YACjB,OAAO,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,gBAAgB,EAAE,SAAS,CAAC;YAC3D,QAAQ,EACN,4EAA4E;gBAC5E,yEAAyE;SAC5E;QACD,SAAS,EAAE;YACT,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,0DAA0D;SACrE;QACD,gBAAgB,EAAE;YAChB,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,qEAAqE;SAChF;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,IAAI;YACb,QAAQ,EACN,sGAAsG;gBACtG,kHAAkH;gBAClH,0GAA0G;gBAC1G,iDAAiD;SACpD;QACD,YAAY,EAAE;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,eAAe;YACxB,QAAQ,EAAE,iGAAiG;SAC5G;QACD,KAAK,EAAE;YACL,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qFAAqF;YAC/F,OAAO,EAAE,SAAS;SACnB;QACD,SAAS,EAAE;YACT,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,+HAA+H;gBAC/H,iFAAiF;SACpF;QACD,eAAe,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,QAAQ,EAAE,qGAAqG;YAC/G,OAAO,EAAE,SAAS;SACnB;QACD,yBAAyB,EAAE;YACzB,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,yCAAyC;YACnD,OAAO,EAAE,KAAK;SACf;QACD,eAAe,EAAE;YACf,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,kGAAkG;YAC5G,OAAO,EAAE,KAAK;SACf;QACD,oBAAoB,EAAE;YACpB,IAAI,EAAE,QAAQ;YACd,QAAQ,EACN,oNAAoN;SACvN;KACF,CAAC;SACD,SAAS,EAAE,CAAC;AACjB,CAAC;AAED;;GAEG;AACH,SAAsB,WAAW;;QAC/B,MAAM,MAAM,GAAG,MAAM,cAAc,EAAE,CAAC;QACtC,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,CAAC;QACtC,uCAAY,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,GAAK,OAAO,EAAG;IAC3C,CAAC;CAAA;AAJD,kCAIC"}
@@ -1,2 +0,0 @@
1
- #!/usr/bin/env node
2
- export {};
@@ -1 +0,0 @@
1
- {"version":3,"file":"generate.js","sourceRoot":"","sources":["../../src/cli/generate.ts"],"names":[],"mappings":";;;AACA,sDAAmD;AACnD,iCAAqC;AAErC,SAAS,IAAI;IACX,IAAA,kBAAW,GAAE;SACV,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE;QACf,mBAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC5B,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,KAAK,EAAE,EAAE;QACf,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACrB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAClB,CAAC,CAAC,CAAC;AACP,CAAC;AAED,IAAI,EAAE,CAAC"}
@@ -1 +0,0 @@
1
- export {};
@@ -1,42 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- const ClassMirrorBuilder_1 = require("../../test-helpers/ClassMirrorBuilder");
4
- const inheritance_chain_1 = require("../inheritance-chain");
5
- describe('inheritance chain for classes', () => {
6
- test('returns an empty list of the class does not extend any other class', () => {
7
- const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().build();
8
- const repository = [classMirror];
9
- const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
10
- expect(inheritanceChain).toEqual([]);
11
- });
12
- test('returns the name of the extended class if it is not found in the repository', () => {
13
- const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('ExtendedClass').build();
14
- const repository = [classMirror];
15
- const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
16
- expect(inheritanceChain).toEqual(['ExtendedClass']);
17
- });
18
- test('returns the extended class when it is present in the repository', () => {
19
- const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('ExtendedClass').build();
20
- const extendedClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('ExtendedClass').build();
21
- const repository = [classMirror, extendedClass];
22
- const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
23
- expect(inheritanceChain).toEqual(['ExtendedClass']);
24
- });
25
- test('returns the full inheritance chain when the extended class is also extended', () => {
26
- const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('ExtendedClass').build();
27
- const extendedClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('ExtendedClass').withExtendedClass('SuperClass').build();
28
- const superClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('SuperClass').build();
29
- const repository = [classMirror, extendedClass, superClass];
30
- const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
31
- expect(inheritanceChain).toEqual(['ExtendedClass', 'SuperClass']);
32
- });
33
- test('returns the inheritance for a class that extends an inner class', () => {
34
- const classMirror = new ClassMirrorBuilder_1.ClassMirrorBuilder().withExtendedClass('OuterClass.InnerClass').build();
35
- const innerClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('InnerClass').build();
36
- const outerClass = new ClassMirrorBuilder_1.ClassMirrorBuilder().withName('OuterClass').addInnerClass(innerClass).build();
37
- const repository = [classMirror, outerClass];
38
- const inheritanceChain = (0, inheritance_chain_1.createInheritanceChain)(repository, classMirror);
39
- expect(inheritanceChain).toEqual(['OuterClass.InnerClass']);
40
- });
41
- });
42
- //# sourceMappingURL=inheritance-chain.test.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"inheritance-chain.test.js","sourceRoot":"","sources":["../../../src/core/__test__/inheritance-chain.test.ts"],"names":[],"mappings":";;AAAA,8EAA2E;AAC3E,4DAA8D;AAE9D,QAAQ,CAAC,+BAA+B,EAAE,GAAG,EAAE;IAC7C,IAAI,CAAC,oEAAoE,EAAE,GAAG,EAAE;QAC9E,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,KAAK,EAAE,CAAC;QACrD,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACvF,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACxF,MAAM,UAAU,GAAG,CAAC,WAAW,CAAC,CAAC;QAEjC,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACjF,MAAM,UAAU,GAAG,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QAEhD,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,6EAA6E,EAAE,GAAG,EAAE;QACvF,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,eAAe,CAAC,CAAC,KAAK,EAAE,CAAC;QACxF,MAAM,aAAa,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,iBAAiB,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QACjH,MAAM,UAAU,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QAC3E,MAAM,UAAU,GAAG,CAAC,WAAW,EAAE,aAAa,EAAE,UAAU,CAAC,CAAC;QAE5D,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,eAAe,EAAE,YAAY,CAAC,CAAC,CAAC;IACpE,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,GAAG,EAAE;QAC3E,MAAM,WAAW,GAAG,IAAI,uCAAkB,EAAE,CAAC,iBAAiB,CAAC,uBAAuB,CAAC,CAAC,KAAK,EAAE,CAAC;QAChG,MAAM,UAAU,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,KAAK,EAAE,CAAC;QAC3E,MAAM,UAAU,GAAG,IAAI,uCAAkB,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;QACrG,MAAM,UAAU,GAAG,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC;QAE7C,MAAM,gBAAgB,GAAG,IAAA,0CAAsB,EAAC,UAAU,EAAE,WAAW,CAAC,CAAC;QAEzE,MAAM,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAC9D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}
@@ -1,6 +0,0 @@
1
- import { ClassMirror, InterfaceMirror, Type } from '@cparra/apex-reflection';
2
- import { RenderableClass, RenderableEnum, RenderableInterface } from './types';
3
- import { GetRenderableContentByTypeName } from './references';
4
- type GetReturnRenderable<T extends Type> = T extends InterfaceMirror ? RenderableInterface : T extends ClassMirror ? RenderableClass : RenderableEnum;
5
- export declare function typeToRenderable<T extends Type>(type: T, linkGenerator: GetRenderableContentByTypeName, namespace?: string): GetReturnRenderable<T>;
6
- export {};
@@ -1,109 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.typeToRenderable = void 0;
4
- const documentables_1 = require("./documentables");
5
- const methods_and_constructors_1 = require("./methods-and-constructors");
6
- const fields_and_properties_1 = require("./fields-and-properties");
7
- function typeToRenderable(type, linkGenerator, namespace) {
8
- function getRenderable() {
9
- switch (type.type_name) {
10
- case 'enum':
11
- return enumTypeToEnumSource(type, linkGenerator);
12
- case 'interface':
13
- return interfaceTypeToInterfaceSource(type, linkGenerator);
14
- case 'class':
15
- return classTypeToClassSource(type, linkGenerator);
16
- }
17
- }
18
- return Object.assign(Object.assign({}, getRenderable()), { namespace });
19
- }
20
- exports.typeToRenderable = typeToRenderable;
21
- function baseTypeAdapter(type, linkGenerator, baseHeadingLevel) {
22
- function getHeading(type) {
23
- const suffixMap = {
24
- class: 'Class',
25
- interface: 'Interface',
26
- enum: 'Enum',
27
- };
28
- return `${type.name} ${suffixMap[type.type_name]}`;
29
- }
30
- return {
31
- headingLevel: baseHeadingLevel,
32
- heading: getHeading(type),
33
- doc: (0, documentables_1.adaptDocumentable)(type, linkGenerator, baseHeadingLevel + 1),
34
- name: type.name,
35
- meta: {
36
- accessModifier: type.access_modifier,
37
- },
38
- };
39
- }
40
- function enumTypeToEnumSource(enumType, linkGenerator, baseHeadingLevel = 1) {
41
- return Object.assign(Object.assign({ type: 'enum' }, baseTypeAdapter(enumType, linkGenerator, baseHeadingLevel)), { values: {
42
- headingLevel: baseHeadingLevel + 1,
43
- heading: 'Values',
44
- value: enumType.values.map((value) => {
45
- var _a;
46
- return (Object.assign(Object.assign({}, (0, documentables_1.adaptDescribable)((_a = value.docComment) === null || _a === void 0 ? void 0 : _a.descriptionLines, linkGenerator)), { value: value.name }));
47
- }),
48
- } });
49
- }
50
- function interfaceTypeToInterfaceSource(interfaceType, linkGenerator, baseHeadingLevel = 1) {
51
- return Object.assign(Object.assign({ type: 'interface' }, baseTypeAdapter(interfaceType, linkGenerator, baseHeadingLevel)), { extends: interfaceType.extended_interfaces.map(linkGenerator), methods: {
52
- headingLevel: baseHeadingLevel + 1,
53
- heading: 'Methods',
54
- value: interfaceType.methods.map((method) => (0, methods_and_constructors_1.adaptMethod)(method, linkGenerator, baseHeadingLevel + 2)),
55
- } });
56
- }
57
- function classTypeToClassSource(classType, linkGenerator, baseHeadingLevel = 1) {
58
- return Object.assign(Object.assign({ type: 'class' }, baseTypeAdapter(classType, linkGenerator, baseHeadingLevel)), { classModifier: classType.classModifier, sharingModifier: classType.sharingModifier, implements: classType.implemented_interfaces.map(linkGenerator), extends: classType.inheritanceChain.map(linkGenerator), methods: adaptMembers('Methods', classType.methods, methods_and_constructors_1.adaptMethod, linkGenerator, baseHeadingLevel + 1), constructors: adaptMembers('Constructors', classType.constructors, (constructor, linkGenerator, baseHeadingLevel) => (0, methods_and_constructors_1.adaptConstructor)(classType.name, constructor, linkGenerator, baseHeadingLevel), linkGenerator, baseHeadingLevel + 1), fields: adaptMembers('Fields', classType.fields, fields_and_properties_1.adaptFieldOrProperty, linkGenerator, baseHeadingLevel + 1), properties: adaptMembers('Properties', classType.properties, fields_and_properties_1.adaptFieldOrProperty, linkGenerator, baseHeadingLevel + 1), innerClasses: {
59
- headingLevel: baseHeadingLevel + 1,
60
- heading: 'Classes',
61
- value: classType.classes.map((innerClass) => classTypeToClassSource(Object.assign(Object.assign({}, innerClass), { inheritanceChain: [] }), linkGenerator, baseHeadingLevel + 2)),
62
- }, innerEnums: {
63
- headingLevel: baseHeadingLevel + 1,
64
- heading: 'Enums',
65
- value: classType.enums.map((innerEnum) => enumTypeToEnumSource(innerEnum, linkGenerator, baseHeadingLevel + 2)),
66
- }, innerInterfaces: {
67
- headingLevel: baseHeadingLevel + 1,
68
- heading: 'Interfaces',
69
- value: classType.interfaces.map((innerInterface) => interfaceTypeToInterfaceSource(innerInterface, linkGenerator, baseHeadingLevel + 2)),
70
- } });
71
- }
72
- function adaptMembers(heading, members, adapter, linkFromTypeNameGenerator, headingLevel) {
73
- return {
74
- headingLevel,
75
- heading,
76
- isGrouped: hasGroup(members),
77
- value: hasGroup(members)
78
- ? toGroupedMembers(members, adapter, linkFromTypeNameGenerator, headingLevel + 1)
79
- : toFlat(members, adapter, linkFromTypeNameGenerator, headingLevel + 1),
80
- };
81
- }
82
- function hasGroup(members) {
83
- return members.some((member) => member.group);
84
- }
85
- function toFlat(members, adapter, linkGenerator, baseHeadingLevel) {
86
- return members.map((member) => adapter(member, linkGenerator, baseHeadingLevel));
87
- }
88
- function toGroupedMembers(members, adapter, linkGenerator, baseHeadingLevel) {
89
- const groupedMembers = groupByGroupName(members);
90
- return Object.entries(groupedMembers).map(([groupName, members]) => singleGroup(baseHeadingLevel, groupName, adapter, members, linkGenerator));
91
- }
92
- function groupByGroupName(members) {
93
- return members.reduce((acc, member) => {
94
- var _a, _b;
95
- const groupName = (_a = member.group) !== null && _a !== void 0 ? _a : 'Other';
96
- acc[groupName] = (_b = acc[groupName]) !== null && _b !== void 0 ? _b : [];
97
- acc[groupName].push(member);
98
- return acc;
99
- }, {});
100
- }
101
- function singleGroup(headingLevel, groupName, adapter, members, linkGenerator) {
102
- return {
103
- headingLevel: headingLevel,
104
- heading: groupName,
105
- groupDescription: members[0].groupDescription, // All fields in the group have the same description
106
- value: toFlat(members, adapter, linkGenerator, headingLevel + 1),
107
- };
108
- }
109
- //# sourceMappingURL=apex-types.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"apex-types.js","sourceRoot":"","sources":["../../../src/core/adapters/apex-types.ts"],"names":[],"mappings":";;;AAYA,mDAAsE;AAEtE,yEAA2E;AAC3E,mEAA+D;AAQ/D,SAAgB,gBAAgB,CAC9B,IAAO,EACP,aAA6C,EAC7C,SAAkB;IAElB,SAAS,aAAa;QACpB,QAAQ,IAAI,CAAC,SAAS,EAAE,CAAC;YACvB,KAAK,MAAM;gBACT,OAAO,oBAAoB,CAAC,IAAkB,EAAE,aAAa,CAAmB,CAAC;YACnF,KAAK,WAAW;gBACd,OAAO,8BAA8B,CAAC,IAAuB,EAAE,aAAa,CAAwB,CAAC;YACvG,KAAK,OAAO;gBACV,OAAO,sBAAsB,CAAC,IAAuC,EAAE,aAAa,CAAoB,CAAC;QAC7G,CAAC;IACH,CAAC;IAED,uCACM,aAAa,EAA6B,KAC9C,SAAS,IACT;AACJ,CAAC;AApBD,4CAoBC;AAED,SAAS,eAAe,CACtB,IAAgD,EAChD,aAA6C,EAC7C,gBAAwB;IAExB,SAAS,UAAU,CAAC,IAAU;QAC5B,MAAM,SAAS,GAAG;YAChB,KAAK,EAAE,OAAO;YACd,SAAS,EAAE,WAAW;YACtB,IAAI,EAAE,MAAM;SACb,CAAC;QAEF,OAAO,GAAG,IAAI,CAAC,IAAI,IAAI,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC;IACrD,CAAC;IAED,OAAO;QACL,YAAY,EAAE,gBAAgB;QAC9B,OAAO,EAAE,UAAU,CAAC,IAAI,CAAC;QACzB,GAAG,EAAE,IAAA,iCAAiB,EAAC,IAAI,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC;QACjE,IAAI,EAAE,IAAI,CAAC,IAAI;QACf,IAAI,EAAE;YACJ,cAAc,EAAE,IAAI,CAAC,eAAe;SACrC;KACF,CAAC;AACJ,CAAC;AAED,SAAS,oBAAoB,CAC3B,QAAoB,EACpB,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,MAAM,IACT,eAAe,CAAC,QAAQ,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC7D,MAAM,EAAE;YACN,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,QAAQ;YACjB,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;gBAAC,OAAA,iCACjC,IAAA,gCAAgB,EAAC,MAAA,KAAK,CAAC,UAAU,0CAAE,gBAAgB,EAAE,aAAa,CAAC,KACtE,KAAK,EAAE,KAAK,CAAC,IAAI,IACjB,CAAA;aAAA,CAAC;SACJ,IACD;AACJ,CAAC;AAED,SAAS,8BAA8B,CACrC,aAA8B,EAC9B,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,WAAW,IACd,eAAe,CAAC,aAAa,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAClE,OAAO,EAAE,aAAa,CAAC,mBAAmB,CAAC,GAAG,CAAC,aAAa,CAAC,EAC7D,OAAO,EAAE;YACP,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,aAAa,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,IAAA,sCAAW,EAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SACvG,IACD;AACJ,CAAC;AAED,SAAS,sBAAsB,CAC7B,SAA0C,EAC1C,aAA6C,EAC7C,mBAA2B,CAAC;IAE5B,qCACE,IAAI,EAAE,OAAO,IACV,eAAe,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,CAAC,KAC9D,aAAa,EAAE,SAAS,CAAC,aAAa,EACtC,eAAe,EAAE,SAAS,CAAC,eAAe,EAC1C,UAAU,EAAE,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,aAAa,CAAC,EAC/D,OAAO,EAAE,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,aAAa,CAAC,EACtD,OAAO,EAAE,YAAY,CAAC,SAAS,EAAE,SAAS,CAAC,OAAO,EAAE,sCAAW,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,EACrG,YAAY,EAAE,YAAY,CACxB,cAAc,EACd,SAAS,CAAC,YAAY,EACtB,CAAC,WAAW,EAAE,aAAa,EAAE,gBAAgB,EAAE,EAAE,CAC/C,IAAA,2CAAgB,EAAC,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,aAAa,EAAE,gBAAgB,CAAC,EAChF,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,MAAM,EAAE,YAAY,CAClB,QAAQ,EACR,SAAS,CAAC,MAAsC,EAChD,4CAAoB,EACpB,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,UAAU,EAAE,YAAY,CACtB,YAAY,EACZ,SAAS,CAAC,UAA6C,EACvD,4CAAoB,EACpB,aAAa,EACb,gBAAgB,GAAG,CAAC,CACrB,EACD,YAAY,EAAE;YACZ,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,SAAS;YAClB,KAAK,EAAE,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,EAAE,EAAE,CAC1C,sBAAsB,iCAAM,UAAU,KAAE,gBAAgB,EAAE,EAAE,KAAI,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACrG;SACF,EACD,UAAU,EAAE;YACV,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,OAAO;YAChB,KAAK,EAAE,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,oBAAoB,CAAC,SAAS,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CAAC;SAChH,EACD,eAAe,EAAE;YACf,YAAY,EAAE,gBAAgB,GAAG,CAAC;YAClC,OAAO,EAAE,YAAY;YACrB,KAAK,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,cAAc,EAAE,EAAE,CACjD,8BAA8B,CAAC,cAAc,EAAE,aAAa,EAAE,gBAAgB,GAAG,CAAC,CAAC,CACpF;SACF,IACD;AACJ,CAAC;AAID,SAAS,YAAY,CACnB,OAAe,EACf,OAAY,EACZ,OAAkG,EAClG,yBAAyD,EACzD,YAAoB;IAEpB,OAAO;QACL,YAAY;QACZ,OAAO;QACP,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC;QAC5B,KAAK,EAAE,QAAQ,CAAC,OAAO,CAAC;YACtB,CAAC,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;YACjF,CAAC,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,yBAAyB,EAAE,YAAY,GAAG,CAAC,CAAC;KAC1E,CAAC;AACJ,CAAC;AAED,SAAS,QAAQ,CAAC,OAAoB;IACpC,OAAO,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,MAAM,CACb,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,gBAAgB,CAAC,CAAC,CAAC;AACnF,CAAC;AAED,SAAS,gBAAgB,CACvB,OAAY,EACZ,OAAkG,EAClG,aAA6C,EAC7C,gBAAwB;IAExB,MAAM,cAAc,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IACjD,OAAO,MAAM,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,EAAE,EAAE,CACjE,WAAW,CAAC,gBAAgB,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,aAAa,CAAC,CAC1E,CAAC;AACJ,CAAC;AAED,SAAS,gBAAgB,CAAsB,OAAY;IACzD,OAAO,OAAO,CAAC,MAAM,CACnB,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE;;QACd,MAAM,SAAS,GAAG,MAAA,MAAM,CAAC,KAAK,mCAAI,OAAO,CAAC;QAC1C,GAAG,CAAC,SAAS,CAAC,GAAG,MAAA,GAAG,CAAC,SAAS,CAAC,mCAAI,EAAE,CAAC;QACtC,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5B,OAAO,GAAG,CAAC;IACb,CAAC,EACD,EAAyB,CAC1B,CAAC;AACJ,CAAC;AAED,SAAS,WAAW,CAClB,YAAoB,EACpB,SAAiB,EACjB,OAAkG,EAClG,OAAY,EACZ,aAA6C;IAE7C,OAAO;QACL,YAAY,EAAE,YAAY;QAC1B,OAAO,EAAE,SAAS;QAClB,gBAAgB,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,gBAAgB,EAAE,oDAAoD;QACnG,KAAK,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,YAAY,GAAG,CAAC,CAAC;KACjE,CAAC;AACJ,CAAC"}
@@ -1,7 +0,0 @@
1
- import { RenderableDocumentation, RenderableContent } from './types';
2
- import { Describable, Documentable } from './types';
3
- import { GetRenderableContentByTypeName } from './references';
4
- export declare function adaptDescribable(describable: Describable, linkGenerator: GetRenderableContentByTypeName): {
5
- description?: RenderableContent[];
6
- };
7
- export declare function adaptDocumentable(documentable: Documentable, linkGenerator: GetRenderableContentByTypeName, subHeadingLevel: number): RenderableDocumentation;