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

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 (386) hide show
  1. package/README.md +37 -0
  2. package/{lib → dist}/__spec__/core/expect-extensions.js +3 -2
  3. package/dist/__spec__/core/expect-extensions.js.map +1 -0
  4. package/{lib → dist}/__spec__/core/generating-class-docs.spec.js +54 -37
  5. package/dist/__spec__/core/generating-class-docs.spec.js.map +1 -0
  6. package/{lib → dist}/__spec__/core/generating-enum-docs.spec.js +25 -22
  7. package/dist/__spec__/core/generating-enum-docs.spec.js.map +1 -0
  8. package/{lib → dist}/__spec__/core/generating-interface-docs.spec.js +33 -30
  9. package/dist/__spec__/core/generating-interface-docs.spec.js.map +1 -0
  10. package/{lib → dist}/__spec__/core/generating-reference-guide.spec.js +8 -7
  11. package/dist/__spec__/core/generating-reference-guide.spec.js.map +1 -0
  12. package/dist/__spec__/core/test-helpers.d.ts +2 -0
  13. package/dist/__spec__/core/test-helpers.js +12 -0
  14. package/dist/__spec__/core/test-helpers.js.map +1 -0
  15. package/{lib → dist}/application/Apexdocs.d.ts +4 -2
  16. package/{lib → dist}/application/Apexdocs.js +30 -3
  17. package/dist/application/Apexdocs.js.map +1 -0
  18. package/{lib/application/flows → dist/application/generators}/generate-markdown-files.d.ts +1 -1
  19. package/{lib/application/flows → dist/application/generators}/generate-markdown-files.js +9 -2
  20. package/dist/application/generators/generate-markdown-files.js.map +1 -0
  21. package/dist/cli/args.d.ts +39 -0
  22. package/{lib/cli/generate.js → dist/cli/args.js} +37 -40
  23. package/dist/cli/args.js.map +1 -0
  24. package/dist/cli/generate.js +291 -0
  25. package/dist/cli/generate.js.map +1 -0
  26. package/dist/core/adapters/apex-types.d.ts +6 -0
  27. package/{lib → dist/core}/adapters/apex-types.js +3 -3
  28. package/dist/core/adapters/apex-types.js.map +1 -0
  29. package/{lib → dist/core}/adapters/documentables.d.ts +1 -1
  30. package/dist/core/adapters/documentables.js +154 -0
  31. package/dist/core/adapters/documentables.js.map +1 -0
  32. package/{lib → dist/core}/adapters/fields-and-properties.d.ts +1 -2
  33. package/{lib → dist/core}/adapters/fields-and-properties.js +10 -4
  34. package/dist/core/adapters/fields-and-properties.js.map +1 -0
  35. package/{lib → dist/core}/adapters/methods-and-constructors.d.ts +1 -1
  36. package/{lib → dist/core}/adapters/methods-and-constructors.js +15 -6
  37. package/dist/core/adapters/methods-and-constructors.js.map +1 -0
  38. package/{lib → dist/core}/adapters/references.d.ts +2 -3
  39. package/{lib → dist/core}/adapters/references.js +5 -9
  40. package/dist/core/adapters/references.js.map +1 -0
  41. package/dist/core/adapters/type-utils.d.ts +3 -0
  42. package/dist/core/adapters/type-utils.js +12 -0
  43. package/dist/core/adapters/type-utils.js.map +1 -0
  44. package/dist/core/apex-bundle.js.map +1 -0
  45. package/{lib → dist}/core/generate-docs.d.ts +7 -3
  46. package/{lib → dist}/core/generate-docs.js +43 -14
  47. package/dist/core/generate-docs.js.map +1 -0
  48. package/{lib → dist}/core/inheritance-chain.js +2 -1
  49. package/dist/core/inheritance-chain.js.map +1 -0
  50. package/dist/core/manifest.js.map +1 -0
  51. package/{lib → dist}/core/template.js +12 -7
  52. package/{lib → dist}/core/template.js.map +1 -1
  53. package/{lib → dist}/core/templates/reference-guide.js +1 -1
  54. package/dist/index.d.ts +2 -0
  55. package/dist/index.js +1 -0
  56. package/{lib → dist}/model/markdown-generation-util/doc-comment-annotation-util.js +3 -2
  57. package/dist/model/markdown-generation-util/doc-comment-annotation-util.js.map +1 -0
  58. package/{lib → dist}/model/markdown-generation-util/field-declaration-util.d.ts +1 -1
  59. package/{lib → dist}/model/markdown-generation-util/field-declaration-util.js +2 -1
  60. package/dist/model/markdown-generation-util/field-declaration-util.js.map +1 -0
  61. package/{lib → dist}/model/markdown-generation-util/method-declaration-util.d.ts +1 -1
  62. package/{lib → dist}/model/markdown-generation-util/method-declaration-util.js +2 -1
  63. package/dist/model/markdown-generation-util/method-declaration-util.js.map +1 -0
  64. package/{lib → dist}/model/markdown-generation-util/type-declaration-util.js +2 -1
  65. package/dist/model/markdown-generation-util/type-declaration-util.js.map +1 -0
  66. package/{lib → dist}/model/markdown-type-file.d.ts +1 -1
  67. package/dist/model/markdown-type-file.js.map +1 -0
  68. package/{lib → dist}/service/apex-file-reader.d.ts +1 -1
  69. package/{lib → dist}/service/apex-file-reader.js +1 -1
  70. package/{lib → dist}/service/apex-file-reader.js.map +1 -1
  71. package/{lib → dist}/service/manifest-factory.d.ts +2 -2
  72. package/{lib → dist}/service/manifest-factory.js +3 -2
  73. package/dist/service/manifest-factory.js.map +1 -0
  74. package/{lib → dist}/service/parser.d.ts +1 -1
  75. package/{lib → dist}/settings.d.ts +3 -0
  76. package/{lib → dist}/settings.js +3 -0
  77. package/{lib → dist}/settings.js.map +1 -1
  78. package/{lib → dist}/test-helpers/SettingsBuilder.js +1 -0
  79. package/{lib → dist}/test-helpers/SettingsBuilder.js.map +1 -1
  80. package/{lib → dist}/transpiler/factory.js +2 -4
  81. package/dist/transpiler/factory.js.map +1 -0
  82. package/{lib → dist}/transpiler/markdown/class-file-generatorHelper.d.ts +0 -2
  83. package/{lib → dist}/transpiler/markdown/class-file-generatorHelper.js +1 -15
  84. package/dist/transpiler/markdown/class-file-generatorHelper.js.map +1 -0
  85. package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.js +1 -1
  86. package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.js +6 -4
  87. package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.js.map +1 -1
  88. package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js +1 -1
  89. package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.js +2 -2
  90. package/{lib → dist}/util/string-utils.js +2 -2
  91. package/{lib → dist}/util/string-utils.js.map +1 -1
  92. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleException.md +18 -0
  93. package/examples/plain-markdown/docs/Miscellaneous/ns.SampleInterface.md +6 -2
  94. package/examples/plain-markdown/docs/Sample-Enums/ns.SampleEnum.md +3 -1
  95. package/examples/plain-markdown/docs/SampleGroup/ns.SampleClass.md +1 -1
  96. package/examples/plain-markdown/docs/index.md +2 -0
  97. package/examples/plain-markdown/force-app/classes/SampleException.cls +16 -0
  98. package/jest.config.js +1 -1
  99. package/package.json +11 -13
  100. package/src/__spec__/core/generating-class-docs.spec.ts +57 -37
  101. package/src/__spec__/core/generating-enum-docs.spec.ts +25 -22
  102. package/src/__spec__/core/generating-interface-docs.spec.ts +33 -30
  103. package/src/__spec__/core/generating-reference-guide.spec.ts +8 -7
  104. package/src/__spec__/core/test-helpers.ts +9 -0
  105. package/src/application/Apexdocs.ts +36 -5
  106. package/src/application/{flows → generators}/generate-markdown-files.ts +19 -13
  107. package/src/cli/args.ts +136 -0
  108. package/src/cli/generate.ts +11 -135
  109. package/src/{adapters → core/adapters}/__tests__/interface-adapter.spec.ts +13 -11
  110. package/src/{adapters → core/adapters}/__tests__/references.spec.ts +11 -1
  111. package/src/{adapters → core/adapters}/apex-types.ts +18 -15
  112. package/src/core/adapters/documentables.ts +195 -0
  113. package/src/{adapters → core/adapters}/fields-and-properties.ts +11 -9
  114. package/src/{adapters → core/adapters}/methods-and-constructors.ts +15 -8
  115. package/src/{adapters → core/adapters}/references.ts +3 -6
  116. package/src/core/adapters/type-utils.ts +9 -0
  117. package/src/core/{renderable → adapters}/types.d.ts +35 -4
  118. package/src/core/generate-docs.ts +55 -19
  119. package/src/core/template.ts +12 -9
  120. package/src/core/templates/reference-guide.ts +1 -1
  121. package/src/model/__tests__/manifest.spec.ts +1 -1
  122. package/src/model/markdown-generation-util/field-declaration-util.ts +1 -1
  123. package/src/model/markdown-generation-util/method-declaration-util.ts +1 -1
  124. package/src/model/markdown-type-file.ts +5 -1
  125. package/src/service/__tests__/apex-file-reader.spec.ts +1 -0
  126. package/src/service/apex-file-reader.ts +1 -1
  127. package/src/service/manifest-factory.ts +2 -2
  128. package/src/service/parser.ts +1 -1
  129. package/src/settings.ts +6 -0
  130. package/src/test-helpers/SettingsBuilder.ts +1 -0
  131. package/src/transpiler/factory.ts +2 -4
  132. package/src/transpiler/markdown/class-file-generatorHelper.ts +1 -18
  133. package/src/transpiler/markdown/plain-markdown/constructors-partial-template.ts +1 -1
  134. package/src/transpiler/markdown/plain-markdown/documentable-partial-template.ts +6 -4
  135. package/src/transpiler/markdown/plain-markdown/fieldsPartialTemplate.ts +1 -1
  136. package/src/transpiler/markdown/plain-markdown/methods-partial-template.ts +2 -2
  137. package/tsconfig.json +1 -1
  138. package/docs/.nojekyll +0 -0
  139. package/docs/__old/README.md +0 -1
  140. package/docs/__old/index.html +0 -22
  141. package/docs/__old/restapi.json +0 -589
  142. package/docs/__old/types/Classes/nspc.AnotherInterface.md +0 -22
  143. package/docs/__old/types/Classes/nspc.ChildClass.md +0 -97
  144. package/docs/__old/types/Main/nspc.GroupedClass.md +0 -10
  145. package/docs/__old/types/Main/nspc.SampleClass.md +0 -189
  146. package/docs/__old/types/Misc-Group/nspc.EscapedAnnotations.md +0 -4
  147. package/docs/__old/types/Misc-Group/nspc.GrandparentClass.md +0 -13
  148. package/docs/__old/types/Misc-Group/nspc.InterfaceWithInheritance.md +0 -29
  149. package/docs/__old/types/Misc-Group/nspc.MemberGrouping.md +0 -13
  150. package/docs/__old/types/Misc-Group/nspc.ParentClass.md +0 -37
  151. package/docs/__old/types/Misc-Group/nspc.Reference1.md +0 -18
  152. package/docs/__old/types/Misc-Group/nspc.Reference2.md +0 -12
  153. package/docs/__old/types/Misc-Group/nspc.Reference3.md +0 -7
  154. package/docs/__old/types/Misc-Group/nspc.Reference4.md +0 -7
  155. package/docs/__old/types/Misc-Group/nspc.Reference5.md +0 -7
  156. package/docs/__old/types/Misc-Group/nspc.Reference6.md +0 -9
  157. package/docs/__old/types/Misc-Group/nspc.Reference7.md +0 -7
  158. package/docs/__old/types/Misc-Group/nspc.SampleClassWithoutModifier.md +0 -11
  159. package/docs/__old/types/Misc-Group/nspc.SampleRestResource.md +0 -104
  160. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithInnerClass.md +0 -33
  161. package/docs/__old/types/Misc-Group/nspc.SampleRestResourceWithoutApexDocs.md +0 -14
  162. package/docs/__old/types/README.md +0 -97
  163. package/docs/__old/types/Sample-Interfaces/nspc.SampleInterface.md +0 -23
  164. package/examples/includes/header.md +0 -3
  165. package/lib/__spec__/core/expect-extensions.js.map +0 -1
  166. package/lib/__spec__/core/generating-class-docs.spec.js.map +0 -1
  167. package/lib/__spec__/core/generating-enum-docs.spec.js.map +0 -1
  168. package/lib/__spec__/core/generating-interface-docs.spec.js.map +0 -1
  169. package/lib/__spec__/core/generating-reference-guide.spec.js.map +0 -1
  170. package/lib/adapters/apex-types.d.ts +0 -5
  171. package/lib/adapters/apex-types.js.map +0 -1
  172. package/lib/adapters/documentables.js +0 -56
  173. package/lib/adapters/documentables.js.map +0 -1
  174. package/lib/adapters/fields-and-properties.js.map +0 -1
  175. package/lib/adapters/methods-and-constructors.js.map +0 -1
  176. package/lib/adapters/references.js.map +0 -1
  177. package/lib/adapters/type-utils.d.ts +0 -2
  178. package/lib/adapters/type-utils.js +0 -7
  179. package/lib/adapters/type-utils.js.map +0 -1
  180. package/lib/application/Apexdocs.js.map +0 -1
  181. package/lib/application/flows/generate-markdown-files.js.map +0 -1
  182. package/lib/cli/generate.js.map +0 -1
  183. package/lib/core/generate-docs.js.map +0 -1
  184. package/lib/core/inheritance-chain.js.map +0 -1
  185. package/lib/index.d.ts +0 -2
  186. package/lib/index.js +0 -29
  187. package/lib/model/apex-bundle.js.map +0 -1
  188. package/lib/model/inheritance.d.ts +0 -11
  189. package/lib/model/inheritance.js +0 -3
  190. package/lib/model/inheritance.js.map +0 -1
  191. package/lib/model/manifest.js.map +0 -1
  192. package/lib/model/markdown-generation-util/doc-comment-annotation-util.js.map +0 -1
  193. package/lib/model/markdown-generation-util/field-declaration-util.js.map +0 -1
  194. package/lib/model/markdown-generation-util/method-declaration-util.js.map +0 -1
  195. package/lib/model/markdown-generation-util/type-declaration-util.js.map +0 -1
  196. package/lib/model/markdown-type-file.js.map +0 -1
  197. package/lib/service/manifest-factory.js.map +0 -1
  198. package/lib/transpiler/factory.js.map +0 -1
  199. package/lib/transpiler/markdown/class-file-generatorHelper.js.map +0 -1
  200. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.d.ts +0 -9
  201. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js +0 -42
  202. package/lib/transpiler/markdown/plain-markdown/plain-docsProcessor.js.map +0 -1
  203. package/src/adapters/documentables.ts +0 -93
  204. package/src/adapters/type-utils.ts +0 -5
  205. package/src/adapters/types.d.ts +0 -8
  206. package/src/model/inheritance.ts +0 -8
  207. package/src/transpiler/markdown/plain-markdown/plain-docsProcessor.ts +0 -42
  208. /package/{lib → dist}/__spec__/core/expect-extensions.d.ts +0 -0
  209. /package/{lib → dist}/__spec__/core/generating-class-docs.spec.d.ts +0 -0
  210. /package/{lib → dist}/__spec__/core/generating-enum-docs.spec.d.ts +0 -0
  211. /package/{lib → dist}/__spec__/core/generating-interface-docs.spec.d.ts +0 -0
  212. /package/{lib → dist}/__spec__/core/generating-reference-guide.spec.d.ts +0 -0
  213. /package/{lib → dist}/cli/generate.d.ts +0 -0
  214. /package/{lib → dist}/core/__test__/inheritance-chain.test.d.ts +0 -0
  215. /package/{lib → dist}/core/__test__/inheritance-chain.test.js +0 -0
  216. /package/{lib → dist}/core/__test__/inheritance-chain.test.js.map +0 -0
  217. /package/{lib/model → dist/core}/apex-bundle.d.ts +0 -0
  218. /package/{lib/model → dist/core}/apex-bundle.js +0 -0
  219. /package/{lib → dist}/core/inheritance-chain.d.ts +0 -0
  220. /package/{lib/model → dist/core}/manifest.d.ts +0 -0
  221. /package/{lib/model → dist/core}/manifest.js +0 -0
  222. /package/{lib → dist}/core/template.d.ts +0 -0
  223. /package/{lib → dist}/core/templates/reference-guide.d.ts +0 -0
  224. /package/{lib → dist}/core/templates/reference-guide.js.map +0 -0
  225. /package/{lib → dist}/index.js.map +0 -0
  226. /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.d.ts +0 -0
  227. /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.js +0 -0
  228. /package/{lib → dist}/model/apex-type-wrappers/ClassMirrorWrapper.js.map +0 -0
  229. /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.d.ts +0 -0
  230. /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.js +0 -0
  231. /package/{lib → dist}/model/apex-type-wrappers/MethodMirrorWrapper.js.map +0 -0
  232. /package/{lib → dist}/model/markdown-file.d.ts +0 -0
  233. /package/{lib → dist}/model/markdown-file.js +0 -0
  234. /package/{lib → dist}/model/markdown-file.js.map +0 -0
  235. /package/{lib → dist}/model/markdown-generation-util/doc-comment-annotation-util.d.ts +0 -0
  236. /package/{lib → dist}/model/markdown-generation-util/index.d.ts +0 -0
  237. /package/{lib → dist}/model/markdown-generation-util/index.js +0 -0
  238. /package/{lib → dist}/model/markdown-generation-util/index.js.map +0 -0
  239. /package/{lib → dist}/model/markdown-generation-util/type-declaration-util.d.ts +0 -0
  240. /package/{lib → dist}/model/markdown-home-file.d.ts +0 -0
  241. /package/{lib → dist}/model/markdown-home-file.js +0 -0
  242. /package/{lib → dist}/model/markdown-home-file.js.map +0 -0
  243. /package/{lib → dist}/model/markdown-type-file.js +0 -0
  244. /package/{lib → dist}/model/openapi/apex-doc-types.d.ts +0 -0
  245. /package/{lib → dist}/model/openapi/apex-doc-types.js +0 -0
  246. /package/{lib → dist}/model/openapi/apex-doc-types.js.map +0 -0
  247. /package/{lib → dist}/model/openapi/open-api-types.d.ts +0 -0
  248. /package/{lib → dist}/model/openapi/open-api-types.js +0 -0
  249. /package/{lib → dist}/model/openapi/open-api-types.js.map +0 -0
  250. /package/{lib → dist}/model/openapi/open-api.d.ts +0 -0
  251. /package/{lib → dist}/model/openapi/open-api.js +0 -0
  252. /package/{lib → dist}/model/openapi/open-api.js.map +0 -0
  253. /package/{lib → dist}/model/openapi/openapi-type-file.d.ts +0 -0
  254. /package/{lib → dist}/model/openapi/openapi-type-file.js +0 -0
  255. /package/{lib → dist}/model/openapi/openapi-type-file.js.map +0 -0
  256. /package/{lib → dist}/model/outputFile.d.ts +0 -0
  257. /package/{lib → dist}/model/outputFile.js +0 -0
  258. /package/{lib → dist}/model/outputFile.js.map +0 -0
  259. /package/{lib → dist}/model/types-repository.d.ts +0 -0
  260. /package/{lib → dist}/model/types-repository.js +0 -0
  261. /package/{lib → dist}/model/types-repository.js.map +0 -0
  262. /package/{lib → dist}/service/file-system.d.ts +0 -0
  263. /package/{lib → dist}/service/file-system.js +0 -0
  264. /package/{lib → dist}/service/file-system.js.map +0 -0
  265. /package/{lib → dist}/service/file-writer.d.ts +0 -0
  266. /package/{lib → dist}/service/file-writer.js +0 -0
  267. /package/{lib → dist}/service/file-writer.js.map +0 -0
  268. /package/{lib → dist}/service/metadata-processor.d.ts +0 -0
  269. /package/{lib → dist}/service/metadata-processor.js +0 -0
  270. /package/{lib → dist}/service/metadata-processor.js.map +0 -0
  271. /package/{lib → dist}/service/parser.js +0 -0
  272. /package/{lib → dist}/service/parser.js.map +0 -0
  273. /package/{lib → dist}/service/state.d.ts +0 -0
  274. /package/{lib → dist}/service/state.js +0 -0
  275. /package/{lib → dist}/service/state.js.map +0 -0
  276. /package/{lib → dist}/service/walkers/class-walker.d.ts +0 -0
  277. /package/{lib → dist}/service/walkers/class-walker.js +0 -0
  278. /package/{lib → dist}/service/walkers/class-walker.js.map +0 -0
  279. /package/{lib → dist}/service/walkers/enum-walker.d.ts +0 -0
  280. /package/{lib → dist}/service/walkers/enum-walker.js +0 -0
  281. /package/{lib → dist}/service/walkers/enum-walker.js.map +0 -0
  282. /package/{lib → dist}/service/walkers/interface-walker.d.ts +0 -0
  283. /package/{lib → dist}/service/walkers/interface-walker.js +0 -0
  284. /package/{lib → dist}/service/walkers/interface-walker.js.map +0 -0
  285. /package/{lib → dist}/service/walkers/walker-factory.d.ts +0 -0
  286. /package/{lib → dist}/service/walkers/walker-factory.js +0 -0
  287. /package/{lib → dist}/service/walkers/walker-factory.js.map +0 -0
  288. /package/{lib → dist}/service/walkers/walker.d.ts +0 -0
  289. /package/{lib → dist}/service/walkers/walker.js +0 -0
  290. /package/{lib → dist}/service/walkers/walker.js.map +0 -0
  291. /package/{lib → dist}/test-helpers/AnnotationBuilder.d.ts +0 -0
  292. /package/{lib → dist}/test-helpers/AnnotationBuilder.js +0 -0
  293. /package/{lib → dist}/test-helpers/AnnotationBuilder.js.map +0 -0
  294. /package/{lib → dist}/test-helpers/ClassMirrorBuilder.d.ts +0 -0
  295. /package/{lib → dist}/test-helpers/ClassMirrorBuilder.js +0 -0
  296. /package/{lib → dist}/test-helpers/ClassMirrorBuilder.js.map +0 -0
  297. /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.d.ts +0 -0
  298. /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.js +0 -0
  299. /package/{lib → dist}/test-helpers/DocCommentAnnotationBuilder.js.map +0 -0
  300. /package/{lib → dist}/test-helpers/DocCommentBuilder.d.ts +0 -0
  301. /package/{lib → dist}/test-helpers/DocCommentBuilder.js +0 -0
  302. /package/{lib → dist}/test-helpers/DocCommentBuilder.js.map +0 -0
  303. /package/{lib → dist}/test-helpers/FieldMirrorBuilder.d.ts +0 -0
  304. /package/{lib → dist}/test-helpers/FieldMirrorBuilder.js +0 -0
  305. /package/{lib → dist}/test-helpers/FieldMirrorBuilder.js.map +0 -0
  306. /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.d.ts +0 -0
  307. /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.js +0 -0
  308. /package/{lib → dist}/test-helpers/InterfaceMirrorBuilder.js.map +0 -0
  309. /package/{lib → dist}/test-helpers/MethodMirrorBuilder.d.ts +0 -0
  310. /package/{lib → dist}/test-helpers/MethodMirrorBuilder.js +0 -0
  311. /package/{lib → dist}/test-helpers/MethodMirrorBuilder.js.map +0 -0
  312. /package/{lib → dist}/test-helpers/SettingsBuilder.d.ts +0 -0
  313. /package/{lib → dist}/transpiler/factory.d.ts +0 -0
  314. /package/{lib → dist}/transpiler/file-container.d.ts +0 -0
  315. /package/{lib → dist}/transpiler/file-container.js +0 -0
  316. /package/{lib → dist}/transpiler/file-container.js.map +0 -0
  317. /package/{lib → dist}/transpiler/generator-choices.d.ts +0 -0
  318. /package/{lib → dist}/transpiler/generator-choices.js +0 -0
  319. /package/{lib → dist}/transpiler/generator-choices.js.map +0 -0
  320. /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.d.ts +0 -0
  321. /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.js +0 -0
  322. /package/{lib → dist}/transpiler/markdown/docsify/docsify-docs-processor.js.map +0 -0
  323. /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.d.ts +0 -0
  324. /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.js +0 -0
  325. /package/{lib → dist}/transpiler/markdown/jekyll/jekyll-docsProcessor.js.map +0 -0
  326. /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.d.ts +0 -0
  327. /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.js +0 -0
  328. /package/{lib → dist}/transpiler/markdown/markdown-transpiler-base.js.map +0 -0
  329. /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.d.ts +0 -0
  330. /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.js +0 -0
  331. /package/{lib → dist}/transpiler/markdown/plain-markdown/class-template.js.map +0 -0
  332. /package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.d.ts +0 -0
  333. /package/{lib → dist}/transpiler/markdown/plain-markdown/constructors-partial-template.js.map +0 -0
  334. /package/{lib → dist}/transpiler/markdown/plain-markdown/documentable-partial-template.d.ts +0 -0
  335. /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.d.ts +0 -0
  336. /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.js +0 -0
  337. /package/{lib → dist}/transpiler/markdown/plain-markdown/enum-template.js.map +0 -0
  338. /package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.d.ts +0 -0
  339. /package/{lib → dist}/transpiler/markdown/plain-markdown/fieldsPartialTemplate.js.map +0 -0
  340. /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.d.ts +0 -0
  341. /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.js +0 -0
  342. /package/{lib → dist}/transpiler/markdown/plain-markdown/grouped-members-partial-template.js.map +0 -0
  343. /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.d.ts +0 -0
  344. /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.js +0 -0
  345. /package/{lib → dist}/transpiler/markdown/plain-markdown/interface-template.js.map +0 -0
  346. /package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.d.ts +0 -0
  347. /package/{lib → dist}/transpiler/markdown/plain-markdown/methods-partial-template.js.map +0 -0
  348. /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.d.ts +0 -0
  349. /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.js +0 -0
  350. /package/{lib → dist}/transpiler/markdown/plain-markdown/type-doc-partial.js.map +0 -0
  351. /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.d.ts +0 -0
  352. /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.js +0 -0
  353. /package/{lib → dist}/transpiler/openapi/open-api-docs-processor.js.map +0 -0
  354. /package/{lib → dist}/transpiler/openapi/parsers/Builder.d.ts +0 -0
  355. /package/{lib → dist}/transpiler/openapi/parsers/Builder.js +0 -0
  356. /package/{lib → dist}/transpiler/openapi/parsers/Builder.js.map +0 -0
  357. /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.d.ts +0 -0
  358. /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.js +0 -0
  359. /package/{lib → dist}/transpiler/openapi/parsers/MethodParser.js.map +0 -0
  360. /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.d.ts +0 -0
  361. /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.js +0 -0
  362. /package/{lib → dist}/transpiler/openapi/parsers/ParameterObjectBuilder.js.map +0 -0
  363. /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.d.ts +0 -0
  364. /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.js +0 -0
  365. /package/{lib → dist}/transpiler/openapi/parsers/ReferenceBuilder.js.map +0 -0
  366. /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.d.ts +0 -0
  367. /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.js +0 -0
  368. /package/{lib → dist}/transpiler/openapi/parsers/RequestBodyBuilder.js.map +0 -0
  369. /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.d.ts +0 -0
  370. /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.js +0 -0
  371. /package/{lib → dist}/transpiler/openapi/parsers/ResponsesBuilder.js.map +0 -0
  372. /package/{lib → dist}/transpiler/processor-type-transpiler.d.ts +0 -0
  373. /package/{lib → dist}/transpiler/processor-type-transpiler.js +0 -0
  374. /package/{lib → dist}/transpiler/processor-type-transpiler.js.map +0 -0
  375. /package/{lib → dist}/transpiler/transpiler.d.ts +0 -0
  376. /package/{lib → dist}/transpiler/transpiler.js +0 -0
  377. /package/{lib → dist}/transpiler/transpiler.js.map +0 -0
  378. /package/{lib → dist}/util/error-logger.d.ts +0 -0
  379. /package/{lib → dist}/util/error-logger.js +0 -0
  380. /package/{lib → dist}/util/error-logger.js.map +0 -0
  381. /package/{lib → dist}/util/logger.d.ts +0 -0
  382. /package/{lib → dist}/util/logger.js +0 -0
  383. /package/{lib → dist}/util/logger.js.map +0 -0
  384. /package/{lib → dist}/util/string-utils.d.ts +0 -0
  385. /package/src/{model → core}/apex-bundle.ts +0 -0
  386. /package/src/{model → core}/manifest.ts +0 -0
@@ -1,5 +1,6 @@
1
1
  import { ReflectionResult } from '@cparra/apex-reflection';
2
- import ApexBundle from '../model/apex-bundle';
2
+ import ApexBundle from '../core/apex-bundle';
3
+ import { AllConfigurableOptions } from '../cli/args';
3
4
  /**
4
5
  * Application entry-point to generate documentation out of Apex source files.
5
6
  */
@@ -7,7 +8,8 @@ export declare class Apexdocs {
7
8
  /**
8
9
  * Generates documentation out of Apex source files.
9
10
  */
10
- static generate(): void;
11
+ static generate(config: AllConfigurableOptions): void;
12
+ private static initializeSettings;
11
13
  private static filterByScopes;
12
14
  static _reflectionWithLogger: (apexBundle: ApexBundle) => ReflectionResult;
13
15
  }
@@ -16,7 +16,7 @@ const file_writer_1 = require("../service/file-writer");
16
16
  const error_logger_1 = __importDefault(require("../util/error-logger"));
17
17
  const types_repository_1 = require("../model/types-repository");
18
18
  const factory_1 = require("../transpiler/factory");
19
- const generate_markdown_files_1 = require("./flows/generate-markdown-files");
19
+ const generate_markdown_files_1 = require("./generators/generate-markdown-files");
20
20
  /**
21
21
  * Application entry-point to generate documentation out of Apex source files.
22
22
  */
@@ -24,8 +24,9 @@ class Apexdocs {
24
24
  /**
25
25
  * Generates documentation out of Apex source files.
26
26
  */
27
- static generate() {
28
- logger_1.Logger.log('Initializing...');
27
+ static generate(config) {
28
+ logger_1.Logger.logSingle('Initializing...', false);
29
+ this.initializeSettings(config);
29
30
  const fileBodies = apex_file_reader_1.ApexFileReader.processFiles(new file_system_1.DefaultFileSystem());
30
31
  if (settings_1.Settings.getInstance().targetGenerator === 'plain-markdown') {
31
32
  (0, generate_markdown_files_1.generateMarkdownFiles)(fileBodies);
@@ -48,6 +49,32 @@ class Apexdocs {
48
49
  error_logger_1.default.logErrors(filteredTypes);
49
50
  }
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
+ }
51
78
  static filterByScopes(manifest) {
52
79
  let filteredTypes;
53
80
  let filteredLogMessage;
@@ -0,0 +1 @@
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 +1,3 @@
1
- import ApexBundle from '../../model/apex-bundle';
1
+ import ApexBundle from '../../core/apex-bundle';
2
2
  import * as E from 'fp-ts/Either';
3
3
  export declare const generateMarkdownFiles: (bundles: ApexBundle[]) => E.Either<void, void>;
@@ -32,10 +32,14 @@ const logger_1 = require("../../util/logger");
32
32
  const function_1 = require("fp-ts/function");
33
33
  const E = __importStar(require("fp-ts/Either"));
34
34
  exports.generateMarkdownFiles = (0, function_1.flow)(generateDocumentationBundle, E.map(convertToMarkdownFiles), E.map(writeFilesToSystem), E.mapLeft((errors) => {
35
- logger_1.Logger.error(errors.join('\n'));
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);
36
40
  }));
37
41
  function generateDocumentationBundle(bundles) {
38
- return (0, generate_docs_1.generateDocs)(bundles.map((file) => file.rawTypeContent), {
42
+ return (0, generate_docs_1.generateDocs)(bundles, {
39
43
  scope: settings_1.Settings.getInstance().scope,
40
44
  outputDir: settings_1.Settings.getInstance().outputDir,
41
45
  namespace: settings_1.Settings.getInstance().getNamespace(),
@@ -54,4 +58,7 @@ function writeFilesToSystem(files) {
54
58
  logger_1.Logger.logSingle(`${file.name} processed.`, false, 'green', false);
55
59
  });
56
60
  }
61
+ function formatReflectionError(error) {
62
+ return `Source file: ${error.file}\n${error.message}\n`;
63
+ }
57
64
  //# sourceMappingURL=generate-markdown-files.js.map
@@ -0,0 +1 @@
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"}
@@ -0,0 +1,39 @@
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 {};
@@ -1,4 +1,3 @@
1
- #!/usr/bin/env node
2
1
  "use strict";
3
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
4
3
  if (k2 === undefined) k2 = k;
@@ -23,16 +22,33 @@ var __importStar = (this && this.__importStar) || function (mod) {
23
22
  __setModuleDefault(result, mod);
24
23
  return result;
25
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
+ };
26
34
  Object.defineProperty(exports, "__esModule", { value: true });
27
- const yargs = __importStar(require("yargs"));
28
- const settings_1 = require("../settings");
29
- const Apexdocs_1 = require("../application/Apexdocs");
35
+ exports.extractArgs = void 0;
30
36
  const cosmiconfig_1 = require("cosmiconfig");
31
- const result = (0, cosmiconfig_1.cosmiconfig)('apexdocs').search();
32
- result.then((config) => {
33
- var _a, _b, _c;
34
- yargs.config(config === null || config === void 0 ? void 0 : config.config);
35
- let argv = yargs
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)
36
52
  .options({
37
53
  sourceDir: {
38
54
  type: 'string',
@@ -123,35 +139,16 @@ result.then((config) => {
123
139
  },
124
140
  })
125
141
  .parseSync();
126
- if (config) {
127
- argv = Object.assign(Object.assign({}, config.config), argv);
128
- }
129
- settings_1.Settings.build({
130
- sourceDirectory: argv.sourceDir,
131
- recursive: argv.recursive,
132
- scope: argv.scope,
133
- outputDir: argv.targetDir,
134
- targetGenerator: argv.targetGenerator,
135
- indexOnly: argv.indexOnly,
136
- defaultGroupName: argv.defaultGroupName,
137
- sanitizeHtml: argv.sanitizeHtml,
138
- openApiTitle: argv.openApiTitle,
139
- title: argv.title,
140
- namespace: argv.namespace,
141
- openApiFileName: argv.openApiFileName,
142
- sortMembersAlphabetically: argv.sortMembersAlphabetically,
143
- includeMetadata: argv.includeMetadata,
144
- rootDir: argv.documentationRootDir,
145
- onAfterProcess: (_a = config === null || config === void 0 ? void 0 : config.config) === null || _a === void 0 ? void 0 : _a.onAfterProcess,
146
- onBeforeFileWrite: (_b = config === null || config === void 0 ? void 0 : config.config) === null || _b === void 0 ? void 0 : _b.onBeforeFileWrite,
147
- frontMatterHeader: (_c = config === null || config === void 0 ? void 0 : config.config) === null || _c === void 0 ? void 0 : _c.frontMatterHeader,
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);
148
151
  });
149
- try {
150
- Apexdocs_1.Apexdocs.generate();
151
- }
152
- catch (error) {
153
- console.error(error);
154
- process.exit(1);
155
- }
156
- });
157
- //# sourceMappingURL=generate.js.map
152
+ }
153
+ exports.extractArgs = extractArgs;
154
+ //# sourceMappingURL=args.js.map
@@ -0,0 +1 @@
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"}