@cparra/apexdocs 2.25.0-alpha.0 → 2.25.0-alpha.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (191) hide show
  1. package/__mocks__/chalk.js +12 -0
  2. package/__mocks__/log-update.js +6 -0
  3. package/eslint.config.mjs +10 -0
  4. package/examples/plain-markdown/docs/Miscellaneous/ns.BaseClass.md +16 -0
  5. package/examples/plain-markdown/docs/Miscellaneous/ns.ParentInterface.md +15 -0
  6. package/examples/plain-markdown/docs/Miscellaneous/ns.ReferencedEnum.md +8 -0
  7. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +7 -0
  8. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +115 -0
  9. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +36 -0
  10. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +173 -0
  11. package/examples/plain-markdown/docs/index.md +36 -0
  12. package/examples/plain-markdown/force-app/classes/SampleClass.cls +37 -0
  13. package/examples/plain-markdown/package.json +2 -6
  14. package/jest.config.js +4 -0
  15. package/jest.d.ts +7 -0
  16. package/lib/__spec__/core/expect-extensions.d.ts +3 -0
  17. package/lib/__spec__/core/expect-extensions.js +54 -0
  18. package/lib/__spec__/core/expect-extensions.js.map +1 -0
  19. package/lib/__spec__/core/generating-class-docs.spec.d.ts +1 -0
  20. package/lib/__spec__/core/generating-class-docs.spec.js +427 -0
  21. package/lib/__spec__/core/generating-class-docs.spec.js.map +1 -0
  22. package/lib/__spec__/core/generating-enum-docs.spec.d.ts +1 -0
  23. package/lib/__spec__/core/generating-enum-docs.spec.js +303 -0
  24. package/lib/__spec__/core/generating-enum-docs.spec.js.map +1 -0
  25. package/lib/__spec__/core/generating-interface-docs.spec.d.ts +1 -0
  26. package/lib/__spec__/core/generating-interface-docs.spec.js +361 -0
  27. package/lib/__spec__/core/generating-interface-docs.spec.js.map +1 -0
  28. package/lib/__spec__/core/generating-reference-guide.spec.d.ts +1 -0
  29. package/lib/__spec__/core/generating-reference-guide.spec.js +161 -0
  30. package/lib/__spec__/core/generating-reference-guide.spec.js.map +1 -0
  31. package/lib/adapters/apex-types.d.ts +7 -5
  32. package/lib/adapters/apex-types.js +99 -21
  33. package/lib/adapters/apex-types.js.map +1 -1
  34. package/lib/adapters/documentables.d.ts +4 -3
  35. package/lib/adapters/documentables.js +23 -8
  36. package/lib/adapters/documentables.js.map +1 -1
  37. package/lib/adapters/fields-and-properties.d.ts +4 -3
  38. package/lib/adapters/fields-and-properties.js +26 -4
  39. package/lib/adapters/fields-and-properties.js.map +1 -1
  40. package/lib/adapters/methods-and-constructors.d.ts +4 -3
  41. package/lib/adapters/methods-and-constructors.js +52 -9
  42. package/lib/adapters/methods-and-constructors.js.map +1 -1
  43. package/lib/adapters/references.d.ts +1 -1
  44. package/lib/adapters/references.js +3 -3
  45. package/lib/adapters/references.js.map +1 -1
  46. package/lib/adapters/type-utils.d.ts +1 -1
  47. package/lib/adapters/type-utils.js +1 -2
  48. package/lib/adapters/type-utils.js.map +1 -1
  49. package/lib/application/Apexdocs.js.map +1 -1
  50. package/lib/cli/generate.js +7 -7
  51. package/lib/cli/generate.js.map +1 -1
  52. package/lib/core/generate-docs.d.ts +23 -0
  53. package/lib/core/generate-docs.js +241 -0
  54. package/lib/core/generate-docs.js.map +1 -0
  55. package/lib/core/template.d.ts +10 -0
  56. package/lib/core/template.js +92 -0
  57. package/lib/core/template.js.map +1 -0
  58. package/lib/core/templates/reference-guide.d.ts +1 -0
  59. package/lib/core/templates/reference-guide.js +18 -0
  60. package/lib/core/templates/reference-guide.js.map +1 -0
  61. package/lib/index.d.ts +2 -1
  62. package/lib/index.js +14 -3
  63. package/lib/index.js.map +1 -1
  64. package/lib/model/manifest.js +8 -2
  65. package/lib/model/manifest.js.map +1 -1
  66. package/lib/model/markdown-file.d.ts +2 -2
  67. package/lib/model/markdown-file.js +5 -4
  68. package/lib/model/markdown-file.js.map +1 -1
  69. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js +3 -4
  70. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -1
  71. package/lib/model/markdown-generation-util/field-declaration-util.js +1 -2
  72. package/lib/model/markdown-generation-util/field-declaration-util.js.map +1 -1
  73. package/lib/model/markdown-generation-util/method-declaration-util.js +2 -3
  74. package/lib/model/markdown-generation-util/method-declaration-util.js.map +1 -1
  75. package/lib/model/markdown-generation-util/type-declaration-util.js +1 -2
  76. package/lib/model/markdown-generation-util/type-declaration-util.js.map +1 -1
  77. package/lib/model/markdown-home-file.js.map +1 -1
  78. package/lib/model/markdown-type-file.js.map +1 -1
  79. package/lib/model/openapi/open-api.js.map +1 -1
  80. package/lib/model/outputFile.d.ts +1 -1
  81. package/lib/model/outputFile.js +2 -9
  82. package/lib/model/outputFile.js.map +1 -1
  83. package/lib/model/types-repository.js.map +1 -1
  84. package/lib/service/apex-file-reader.js.map +1 -1
  85. package/lib/service/file-writer.js.map +1 -1
  86. package/lib/service/manifest-factory.js +1 -2
  87. package/lib/service/manifest-factory.js.map +1 -1
  88. package/lib/service/metadata-processor.js.map +1 -1
  89. package/lib/service/parser.js +1 -1
  90. package/lib/service/parser.js.map +1 -1
  91. package/lib/service/state.js.map +1 -1
  92. package/lib/service/walkers/class-walker.js.map +1 -1
  93. package/lib/service/walkers/interface-walker.js.map +1 -1
  94. package/lib/service/walkers/walker-factory.js.map +1 -1
  95. package/lib/service/walkers/walker.js.map +1 -1
  96. package/lib/settings.d.ts +0 -6
  97. package/lib/settings.js +0 -11
  98. package/lib/settings.js.map +1 -1
  99. package/lib/transpiler/factory.js.map +1 -1
  100. package/lib/transpiler/markdown/class-file-generatorHelper.d.ts +1 -1
  101. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +1 -1
  102. package/lib/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +1 -1
  103. package/lib/transpiler/markdown/plain-markdown/class-template.js +51 -10
  104. package/lib/transpiler/markdown/plain-markdown/class-template.js.map +1 -1
  105. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js +13 -16
  106. package/lib/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +1 -1
  107. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js +11 -8
  108. package/lib/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -1
  109. package/lib/transpiler/markdown/plain-markdown/enum-template.js +7 -6
  110. package/lib/transpiler/markdown/plain-markdown/enum-template.js.map +1 -1
  111. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +9 -6
  112. package/lib/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +1 -1
  113. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +1 -0
  114. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +10 -0
  115. package/lib/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +1 -0
  116. package/lib/transpiler/markdown/plain-markdown/interface-template.js +4 -4
  117. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js +18 -20
  118. package/lib/transpiler/markdown/plain-markdown/methods-partial-template.js.map +1 -1
  119. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -4
  120. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +6 -86
  121. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +1 -1
  122. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +1 -0
  123. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js +31 -0
  124. package/lib/transpiler/markdown/plain-markdown/type-doc-partial.js.map +1 -0
  125. package/lib/transpiler/openapi/open-api-docs-processor.js.map +1 -1
  126. package/lib/transpiler/openapi/parsers/Builder.js.map +1 -1
  127. package/lib/transpiler/openapi/parsers/MethodParser.js.map +1 -1
  128. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js +3 -2
  129. package/lib/transpiler/openapi/parsers/ReferenceBuilder.js.map +1 -1
  130. package/lib/transpiler/openapi/parsers/ResponsesBuilder.js.map +1 -1
  131. package/lib/transpiler/transpiler.js.map +1 -1
  132. package/lib/util/error-logger.js.map +1 -1
  133. package/lib/util/logger.js.map +1 -1
  134. package/lib/util/string-utils.js +2 -2
  135. package/lib/util/string-utils.js.map +1 -1
  136. package/package.json +19 -19
  137. package/src/__spec__/core/expect-extensions.ts +32 -0
  138. package/src/__spec__/core/generating-class-docs.spec.ts +511 -0
  139. package/src/__spec__/core/generating-enum-docs.spec.ts +355 -0
  140. package/src/__spec__/core/generating-interface-docs.spec.ts +431 -0
  141. package/src/__spec__/core/generating-reference-guide.spec.ts +163 -0
  142. package/src/adapters/__tests__/interface-adapter.spec.ts +15 -11
  143. package/src/adapters/__tests__/references.spec.ts +1 -1
  144. package/src/adapters/apex-types.ts +196 -39
  145. package/src/adapters/documentables.ts +44 -9
  146. package/src/adapters/fields-and-properties.ts +31 -7
  147. package/src/adapters/methods-and-constructors.ts +57 -18
  148. package/src/adapters/references.ts +1 -1
  149. package/src/adapters/type-utils.ts +1 -1
  150. package/src/cli/generate.ts +96 -96
  151. package/src/core/generate-docs.ts +357 -0
  152. package/src/core/renderable/types.d.ts +131 -0
  153. package/src/core/template.ts +108 -0
  154. package/src/core/templates/reference-guide.ts +14 -0
  155. package/src/index.ts +3 -1
  156. package/src/model/manifest.ts +12 -2
  157. package/src/model/markdown-file.ts +5 -4
  158. package/src/model/markdown-generation-util/doc-comment-annotation-util.ts +1 -1
  159. package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
  160. package/src/model/outputFile.ts +2 -11
  161. package/src/service/parser.ts +1 -1
  162. package/src/settings.ts +0 -15
  163. package/src/transpiler/markdown/class-file-generatorHelper.ts +1 -1
  164. package/src/transpiler/markdown/plain-markdown/class-template.ts +51 -10
  165. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +13 -16
  166. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +11 -8
  167. package/src/transpiler/markdown/plain-markdown/enum-template.ts +7 -6
  168. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +9 -6
  169. package/src/transpiler/markdown/plain-markdown/grouped-members-partial-template.ts +6 -0
  170. package/src/transpiler/markdown/plain-markdown/interface-template.ts +4 -4
  171. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +18 -20
  172. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +8 -100
  173. package/src/transpiler/markdown/plain-markdown/type-doc-partial.ts +27 -0
  174. package/src/transpiler/openapi/parsers/ReferenceBuilder.ts +3 -2
  175. package/tsconfig.json +1 -1
  176. package/.eslintrc.js +0 -12
  177. package/examples/plain-markdown/README.md +0 -301
  178. package/lib/templating/compile.d.ts +0 -7
  179. package/lib/templating/compile.js +0 -98
  180. package/lib/templating/compile.js.map +0 -1
  181. package/lib/templating/helpers.d.ts +0 -2
  182. package/lib/templating/helpers.js +0 -18
  183. package/lib/templating/helpers.js.map +0 -1
  184. package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts +0 -1
  185. package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js +0 -31
  186. package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map +0 -1
  187. package/src/templating/__tests__/compile.spec.ts +0 -741
  188. package/src/templating/compile.ts +0 -187
  189. package/src/templating/helpers.ts +0 -14
  190. package/src/templating/types.d.ts +0 -104
  191. package/src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts +0 -27
package/lib/templating/helpers.d.ts DELETED
@@ -1,2 +0,0 @@
1
- export declare const splitAndCapitalize: (text: string) => string;
2
- export declare const namespace: () => string | undefined;
package/lib/templating/helpers.js DELETED
@@ -1,18 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.namespace = exports.splitAndCapitalize = void 0;
4
- const settings_1 = require("../settings");
5
- const splitAndCapitalize = (text) => {
6
- const words = text.split(/[-_]+/);
7
- const capitalizedWords = [];
8
- for (const word of words) {
9
- capitalizedWords.push(word.charAt(0).toUpperCase() + word.slice(1));
10
- }
11
- return capitalizedWords.join(' ');
12
- };
13
- exports.splitAndCapitalize = splitAndCapitalize;
14
- const namespace = () => {
15
- return settings_1.Settings.getInstance().getNamespace();
16
- };
17
- exports.namespace = namespace;
18
- //# sourceMappingURL=helpers.js.map
package/lib/templating/helpers.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"helpers.js","sourceRoot":"","sources":["../../src/templating/helpers.ts"],"names":[],"mappings":";;;AAAA,0CAAuC;AAEhC,MAAM,kBAAkB,GAAG,CAAC,IAAY,EAAE,EAAE;IACjD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,MAAM,gBAAgB,GAAG,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;KACrE;IACD,OAAO,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACpC,CAAC,CAAC;AAPW,QAAA,kBAAkB,sBAO7B;AAEK,MAAM,SAAS,GAAG,GAAG,EAAE;IAC5B,OAAO,mBAAQ,CAAC,WAAW,EAAE,CAAC,YAAY,EAAE,CAAC;AAC/C,CAAC,CAAC;AAFW,QAAA,SAAS,aAEpB"}
package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.d.ts DELETED
@@ -1 +0,0 @@
1
- export declare const typeLevelApexDocPartialTemplate: string;
package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js DELETED
@@ -1,31 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.typeLevelApexDocPartialTemplate = void 0;
4
- exports.typeLevelApexDocPartialTemplate = `
5
- {{#> documentablePartialTemplate}}
6
-
7
- {{#if group}}
8
- **Group** {{group}}
9
- {{/if}}
10
-
11
- {{#if author}}
12
- **Author** {{author}}
13
- {{/if}}
14
-
15
- {{#if date}}
16
- **Date** {{date}}
17
- {{/if}}
18
-
19
- {{#each sees}}
20
- **See** {{this}}
21
-
22
- {{/each}}
23
-
24
- {{#if namespace}}
25
- ## Namespace
26
- {{namespace}}
27
- {{/if}}
28
-
29
- {{/documentablePartialTemplate}}
30
- `.trim();
31
- //# sourceMappingURL=type-level-apex-doc-partial-template.js.map
package/lib/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"type-level-apex-doc-partial-template.js","sourceRoot":"","sources":["../../../../src/transpiler/markdown/plain-markdown/type-level-apex-doc-partial-template.ts"],"names":[],"mappings":";;;AAAa,QAAA,+BAA+B,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;CA0B9C,CAAC,IAAI,EAAE,CAAC"}