typedoc 0.28.19 → 0.28.20

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 (396) hide show
  1. package/bin/typedoc +1 -1
  2. package/dist/browser-utils.js +29 -2
  3. package/dist/cli.js +111 -0
  4. package/dist/index.js +17888 -44
  5. package/dist/models.js +3736 -0
  6. package/dist/node-utils.js +7018 -0
  7. package/dist/serialization.js +430 -0
  8. package/dist/{lib → types}/application-events.d.ts +2 -0
  9. package/dist/{lib → types}/application.d.ts +51 -8
  10. package/dist/{lib → types}/converter/comments/declarationReferenceResolver.d.ts +1 -1
  11. package/dist/{lib → types}/converter/comments/discovery.d.ts +3 -3
  12. package/dist/{lib → types}/converter/comments/index.d.ts +4 -4
  13. package/dist/{lib → types}/converter/comments/lexer.d.ts +1 -1
  14. package/dist/{lib → types}/converter/comments/linkResolver.d.ts +1 -1
  15. package/dist/{lib → types}/converter/comments/parser.d.ts +3 -4
  16. package/dist/{lib → types}/converter/comments/textParser.d.ts +8 -2
  17. package/dist/{lib → types}/converter/components.d.ts +1 -1
  18. package/dist/{lib → types}/converter/context.d.ts +2 -2
  19. package/dist/{lib → types}/converter/converter.d.ts +6 -8
  20. package/dist/{lib → types}/converter/factories/signature.d.ts +1 -1
  21. package/dist/{lib → types}/converter/index.d.ts +1 -0
  22. package/dist/{lib → types}/converter/plugins/CategoryPlugin.d.ts +2 -2
  23. package/dist/{lib → types}/converter/plugins/GroupPlugin.d.ts +2 -3
  24. package/dist/{lib → types}/converter/plugins/IncludePlugin.d.ts +1 -1
  25. package/dist/{lib → types}/converter/plugins/InheritDocPlugin.d.ts +1 -1
  26. package/dist/{lib → types}/converter/plugins/LinkResolverPlugin.d.ts +3 -3
  27. package/dist/{lib → types}/converter/plugins/SourcePlugin.d.ts +1 -2
  28. package/dist/{lib → types}/converter/plugins/TypePlugin.d.ts +1 -1
  29. package/dist/{lib → types}/converter/types.d.ts +1 -1
  30. package/dist/{lib/converter/utils → types/converter/utilities}/reflections.d.ts +1 -1
  31. package/dist/{lib/converter/utils → types/converter/utilities}/repository.d.ts +14 -13
  32. package/dist/{index.d.ts → types/index.d.ts} +15 -16
  33. package/dist/{lib → types}/internationalization/internationalization.d.ts +0 -8
  34. package/dist/types/internationalization/locale-utils.d.ts +3 -0
  35. package/dist/types/internationalization/locales/de.d.ts +368 -0
  36. package/dist/{lib/internationalization/locales/en.d.cts → types/internationalization/locales/en.d.ts} +2 -1
  37. package/dist/types/internationalization/locales/fr.d.ts +346 -0
  38. package/dist/types/internationalization/locales/ja.d.ts +307 -0
  39. package/dist/types/internationalization/locales/ko.d.ts +221 -0
  40. package/dist/types/internationalization/locales/zh.d.ts +452 -0
  41. package/dist/{lib → types}/internationalization/translatable.d.ts +1 -1
  42. package/dist/{lib → types}/models/FileRegistry.d.ts +5 -0
  43. package/dist/{lib → types}/models/ReflectionSymbolId.d.ts +9 -3
  44. package/dist/{lib → types}/models/SourceReference.d.ts +5 -3
  45. package/dist/types/models.d.ts +1 -0
  46. package/dist/types/node-utils.d.ts +1 -0
  47. package/dist/{lib → types}/output/components.d.ts +3 -3
  48. package/dist/{lib → types}/output/events.d.ts +1 -2
  49. package/dist/{lib → types}/output/formatter.d.ts +1 -2
  50. package/dist/{lib → types}/output/output.d.ts +2 -2
  51. package/dist/{lib → types}/output/renderer.d.ts +4 -5
  52. package/dist/{lib → types}/output/router.d.ts +2 -2
  53. package/dist/{lib → types}/output/themes/MarkedPlugin.d.ts +3 -3
  54. package/dist/{lib → types}/output/themes/default/DefaultTheme.d.ts +1 -1
  55. package/dist/{lib → types}/output/themes/default/DefaultThemeRenderContext.d.ts +25 -25
  56. package/dist/{lib → types}/output/themes/default/layouts/default.d.ts +1 -1
  57. package/dist/{lib → types}/output/themes/default/partials/anchor-icon.d.ts +1 -1
  58. package/dist/{lib → types}/output/themes/default/partials/breadcrumb.d.ts +1 -1
  59. package/dist/{lib → types}/output/themes/default/partials/comment.d.ts +1 -1
  60. package/dist/{lib → types}/output/themes/default/partials/header.d.ts +1 -1
  61. package/dist/{lib → types}/output/themes/default/partials/hierarchy.d.ts +1 -1
  62. package/dist/{lib → types}/output/themes/default/partials/icon.d.ts +1 -1
  63. package/dist/{lib → types}/output/themes/default/partials/index.d.ts +1 -1
  64. package/dist/{lib → types}/output/themes/default/partials/member.d.ts +1 -1
  65. package/dist/{lib → types}/output/themes/default/partials/member.getterSetter.d.ts +1 -1
  66. package/dist/{lib → types}/output/themes/default/partials/member.signature.body.d.ts +1 -1
  67. package/dist/{lib → types}/output/themes/default/partials/member.signature.title.d.ts +2 -2
  68. package/dist/{lib → types}/output/themes/default/partials/member.signatures.d.ts +1 -1
  69. package/dist/{lib → types}/output/themes/default/partials/member.sources.d.ts +1 -1
  70. package/dist/{lib → types}/output/themes/default/partials/members.d.ts +1 -1
  71. package/dist/{lib → types}/output/themes/default/partials/moduleReflection.d.ts +1 -1
  72. package/dist/{lib → types}/output/themes/default/partials/navigation.d.ts +1 -1
  73. package/dist/{lib → types}/output/themes/default/partials/reflectionPreview.d.ts +1 -1
  74. package/dist/{lib → types}/output/themes/default/partials/toolbar.d.ts +1 -1
  75. package/dist/{lib → types}/output/themes/default/partials/type.d.ts +2 -2
  76. package/dist/{lib → types}/output/themes/default/partials/typeDetails.d.ts +2 -2
  77. package/dist/{lib → types}/output/themes/default/partials/typeParameters.d.ts +1 -1
  78. package/dist/{lib → types}/output/themes/default/templates/document.d.ts +1 -1
  79. package/dist/{lib → types}/output/themes/default/templates/hierarchy.d.ts +1 -1
  80. package/dist/{lib → types}/output/themes/default/templates/index.d.ts +1 -1
  81. package/dist/{lib → types}/output/themes/default/templates/reflection.d.ts +1 -1
  82. package/dist/{lib → types}/output/themes/lib.d.ts +1 -1
  83. package/dist/types/serialization.d.ts +1 -0
  84. package/dist/types/tsconfig.tsbuildinfo +1 -0
  85. package/dist/{lib → types}/utils/ValidatingFileRegistry.d.ts +1 -1
  86. package/dist/{lib → types}/utils/entry-point.d.ts +2 -2
  87. package/dist/{lib → types}/utils/general.d.ts +3 -0
  88. package/dist/types/utils/index.d.ts +22 -0
  89. package/dist/{lib → types}/utils/options/declaration.d.ts +1 -1
  90. package/dist/{lib → types}/utils/options/defaults.d.ts +1 -1
  91. package/dist/{lib → types}/utils/options/index.d.ts +2 -1
  92. package/dist/{lib → types}/utils/options/options.d.ts +1 -1
  93. package/dist/{lib → types}/utils/options/tsdoc-defaults.d.ts +1 -1
  94. package/dist/{lib → types}/utils/reflections.d.ts +1 -1
  95. package/dist/{lib → types}/utils/sort.d.ts +1 -2
  96. package/dist/{lib → types}/utils-common/general.d.ts +4 -4
  97. package/dist/types/utils-common.d.ts +1 -0
  98. package/dist/{lib → types}/validation/documentation.d.ts +1 -1
  99. package/dist/{lib → types}/validation/exports.d.ts +1 -1
  100. package/dist/types/validation/filePaths.d.ts +3 -0
  101. package/dist/{lib → types}/validation/links.d.ts +1 -1
  102. package/dist/{lib → types}/validation/unusedMergeModuleWith.d.ts +1 -1
  103. package/dist/utils-common.js +1311 -0
  104. package/package.json +45 -36
  105. package/static/main.js +1 -1
  106. package/static/style.css +18 -3
  107. package/tsdoc.json +4 -0
  108. package/typedoc-config.schema.json +1 -0
  109. package/dist/lib/application-events.js +0 -5
  110. package/dist/lib/application.js +0 -716
  111. package/dist/lib/cli.js +0 -111
  112. package/dist/lib/converter/comments/blockLexer.js +0 -391
  113. package/dist/lib/converter/comments/declarationReferenceResolver.js +0 -218
  114. package/dist/lib/converter/comments/discovery.js +0 -567
  115. package/dist/lib/converter/comments/index.js +0 -241
  116. package/dist/lib/converter/comments/lexer.js +0 -10
  117. package/dist/lib/converter/comments/lineLexer.js +0 -279
  118. package/dist/lib/converter/comments/linkResolver.js +0 -186
  119. package/dist/lib/converter/comments/parser.js +0 -538
  120. package/dist/lib/converter/comments/rawLexer.js +0 -218
  121. package/dist/lib/converter/comments/tagName.js +0 -58
  122. package/dist/lib/converter/comments/textParser.js +0 -372
  123. package/dist/lib/converter/components.js +0 -3
  124. package/dist/lib/converter/context.js +0 -311
  125. package/dist/lib/converter/convert-expression.js +0 -58
  126. package/dist/lib/converter/converter-events.js +0 -13
  127. package/dist/lib/converter/converter.js +0 -705
  128. package/dist/lib/converter/factories/index-signature.js +0 -50
  129. package/dist/lib/converter/factories/signature.js +0 -353
  130. package/dist/lib/converter/factories/symbol-id.js +0 -50
  131. package/dist/lib/converter/index.js +0 -3
  132. package/dist/lib/converter/jsdoc.js +0 -135
  133. package/dist/lib/converter/plugins/CategoryPlugin.js +0 -278
  134. package/dist/lib/converter/plugins/CommentPlugin.js +0 -770
  135. package/dist/lib/converter/plugins/GroupPlugin.js +0 -281
  136. package/dist/lib/converter/plugins/ImplementsPlugin.js +0 -438
  137. package/dist/lib/converter/plugins/IncludePlugin.js +0 -254
  138. package/dist/lib/converter/plugins/InheritDocPlugin.js +0 -220
  139. package/dist/lib/converter/plugins/LinkResolverPlugin.js +0 -88
  140. package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +0 -50
  141. package/dist/lib/converter/plugins/PackagePlugin.js +0 -188
  142. package/dist/lib/converter/plugins/SourcePlugin.js +0 -215
  143. package/dist/lib/converter/plugins/TypePlugin.js +0 -108
  144. package/dist/lib/converter/plugins/index.js +0 -10
  145. package/dist/lib/converter/symbols.js +0 -861
  146. package/dist/lib/converter/types.js +0 -833
  147. package/dist/lib/converter/utils/nodes.js +0 -26
  148. package/dist/lib/converter/utils/reflections.js +0 -17
  149. package/dist/lib/converter/utils/repository.js +0 -295
  150. package/dist/lib/converter/utils/symbols.js +0 -12
  151. package/dist/lib/debug/index.js +0 -2
  152. package/dist/lib/debug/reflectionLifetimes.js +0 -27
  153. package/dist/lib/debug/rendererUrls.js +0 -68
  154. package/dist/lib/internationalization/index.js +0 -7
  155. package/dist/lib/internationalization/internationalization.js +0 -64
  156. package/dist/lib/internationalization/locale-utils.cjs +0 -8
  157. package/dist/lib/internationalization/locale-utils.d.cts +0 -8
  158. package/dist/lib/internationalization/locales/de.cjs +0 -401
  159. package/dist/lib/internationalization/locales/de.d.cts +0 -368
  160. package/dist/lib/internationalization/locales/en.cjs +0 -411
  161. package/dist/lib/internationalization/locales/fr.cjs +0 -347
  162. package/dist/lib/internationalization/locales/fr.d.cts +0 -346
  163. package/dist/lib/internationalization/locales/ja.cjs +0 -320
  164. package/dist/lib/internationalization/locales/ja.d.cts +0 -307
  165. package/dist/lib/internationalization/locales/ko.cjs +0 -233
  166. package/dist/lib/internationalization/locales/ko.d.cts +0 -221
  167. package/dist/lib/internationalization/locales/zh.cjs +0 -488
  168. package/dist/lib/internationalization/locales/zh.d.cts +0 -452
  169. package/dist/lib/internationalization/translatable.js +0 -8
  170. package/dist/lib/models/Comment.js +0 -534
  171. package/dist/lib/models/ContainerReflection.js +0 -159
  172. package/dist/lib/models/DeclarationReflection.js +0 -287
  173. package/dist/lib/models/DocumentReflection.js +0 -66
  174. package/dist/lib/models/FileRegistry.js +0 -133
  175. package/dist/lib/models/ParameterReflection.js +0 -39
  176. package/dist/lib/models/ProjectReflection.js +0 -417
  177. package/dist/lib/models/ReferenceReflection.js +0 -85
  178. package/dist/lib/models/Reflection.js +0 -495
  179. package/dist/lib/models/ReflectionCategory.js +0 -56
  180. package/dist/lib/models/ReflectionGroup.js +0 -72
  181. package/dist/lib/models/ReflectionSymbolId.js +0 -85
  182. package/dist/lib/models/SignatureReflection.js +0 -96
  183. package/dist/lib/models/SourceReference.js +0 -50
  184. package/dist/lib/models/TypeParameterReflection.js +0 -45
  185. package/dist/lib/models/index.js +0 -19
  186. package/dist/lib/models/kind.js +0 -231
  187. package/dist/lib/models/types.js +0 -1296
  188. package/dist/lib/models/utils.js +0 -26
  189. package/dist/lib/models/variant.js +0 -1
  190. package/dist/lib/output/components.js +0 -133
  191. package/dist/lib/output/events.js +0 -195
  192. package/dist/lib/output/formatter.js +0 -660
  193. package/dist/lib/output/index.js +0 -7
  194. package/dist/lib/output/output.js +0 -92
  195. package/dist/lib/output/plugins/AssetsPlugin.js +0 -160
  196. package/dist/lib/output/plugins/HierarchyPlugin.js +0 -65
  197. package/dist/lib/output/plugins/IconsPlugin.js +0 -58
  198. package/dist/lib/output/plugins/JavascriptIndexPlugin.js +0 -222
  199. package/dist/lib/output/plugins/NavigationPlugin.js +0 -23
  200. package/dist/lib/output/plugins/SitemapPlugin.js +0 -82
  201. package/dist/lib/output/plugins/index.js +0 -7
  202. package/dist/lib/output/renderer.js +0 -387
  203. package/dist/lib/output/router.js +0 -522
  204. package/dist/lib/output/theme.js +0 -17
  205. package/dist/lib/output/themes/MarkedPlugin.js +0 -461
  206. package/dist/lib/output/themes/default/DefaultTheme.js +0 -367
  207. package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +0 -151
  208. package/dist/lib/output/themes/default/Slugger.js +0 -60
  209. package/dist/lib/output/themes/default/layouts/default.js +0 -89
  210. package/dist/lib/output/themes/default/partials/anchor-icon.js +0 -9
  211. package/dist/lib/output/themes/default/partials/breadcrumb.js +0 -11
  212. package/dist/lib/output/themes/default/partials/comment.js +0 -80
  213. package/dist/lib/output/themes/default/partials/footer.js +0 -37
  214. package/dist/lib/output/themes/default/partials/header.js +0 -39
  215. package/dist/lib/output/themes/default/partials/hierarchy.js +0 -32
  216. package/dist/lib/output/themes/default/partials/icon.js +0 -101
  217. package/dist/lib/output/themes/default/partials/index.js +0 -24
  218. package/dist/lib/output/themes/default/partials/member.declaration.js +0 -35
  219. package/dist/lib/output/themes/default/partials/member.getterSetter.js +0 -12
  220. package/dist/lib/output/themes/default/partials/member.js +0 -36
  221. package/dist/lib/output/themes/default/partials/member.signature.body.js +0 -33
  222. package/dist/lib/output/themes/default/partials/member.signature.title.js +0 -9
  223. package/dist/lib/output/themes/default/partials/member.signatures.js +0 -9
  224. package/dist/lib/output/themes/default/partials/member.sources.js +0 -55
  225. package/dist/lib/output/themes/default/partials/members.js +0 -17
  226. package/dist/lib/output/themes/default/partials/moduleReflection.js +0 -68
  227. package/dist/lib/output/themes/default/partials/navigation.js +0 -144
  228. package/dist/lib/output/themes/default/partials/reflectionPreview.js +0 -26
  229. package/dist/lib/output/themes/default/partials/toolbar.js +0 -13
  230. package/dist/lib/output/themes/default/partials/type.js +0 -9
  231. package/dist/lib/output/themes/default/partials/typeAndParent.js +0 -28
  232. package/dist/lib/output/themes/default/partials/typeDetails.js +0 -284
  233. package/dist/lib/output/themes/default/partials/typeParameters.js +0 -26
  234. package/dist/lib/output/themes/default/templates/document.js +0 -3
  235. package/dist/lib/output/themes/default/templates/hierarchy.js +0 -31
  236. package/dist/lib/output/themes/default/templates/index.js +0 -3
  237. package/dist/lib/output/themes/default/templates/reflection.js +0 -53
  238. package/dist/lib/output/themes/lib.js +0 -218
  239. package/dist/lib/serialization/components.js +0 -1
  240. package/dist/lib/serialization/deserializer.js +0 -235
  241. package/dist/lib/serialization/events.js +0 -18
  242. package/dist/lib/serialization/index.js +0 -4
  243. package/dist/lib/serialization/schema.js +0 -32
  244. package/dist/lib/serialization/serializer.js +0 -65
  245. package/dist/lib/utils/ValidatingFileRegistry.js +0 -52
  246. package/dist/lib/utils/component.js +0 -41
  247. package/dist/lib/utils/compress.js +0 -13
  248. package/dist/lib/utils/declaration-maps.js +0 -51
  249. package/dist/lib/utils/entry-point.js +0 -330
  250. package/dist/lib/utils/fs.js +0 -372
  251. package/dist/lib/utils/general.js +0 -25
  252. package/dist/lib/utils/highlighter.js +0 -150
  253. package/dist/lib/utils/html-entities.js +0 -2329
  254. package/dist/lib/utils/html.js +0 -635
  255. package/dist/lib/utils/index.d.ts +0 -17
  256. package/dist/lib/utils/index.js +0 -15
  257. package/dist/lib/utils/loggers.js +0 -71
  258. package/dist/lib/utils/options/declaration.js +0 -444
  259. package/dist/lib/utils/options/defaults.js +0 -104
  260. package/dist/lib/utils/options/help.js +0 -63
  261. package/dist/lib/utils/options/index.js +0 -4
  262. package/dist/lib/utils/options/options.js +0 -273
  263. package/dist/lib/utils/options/readers/arguments.js +0 -109
  264. package/dist/lib/utils/options/readers/index.js +0 -4
  265. package/dist/lib/utils/options/readers/package-json.js +0 -40
  266. package/dist/lib/utils/options/readers/tsconfig.js +0 -172
  267. package/dist/lib/utils/options/readers/typedoc.js +0 -136
  268. package/dist/lib/utils/options/sources/index.js +0 -1
  269. package/dist/lib/utils/options/sources/typedoc.js +0 -876
  270. package/dist/lib/utils/options/tsdoc-defaults.js +0 -94
  271. package/dist/lib/utils/package-manifest.js +0 -84
  272. package/dist/lib/utils/paths.js +0 -127
  273. package/dist/lib/utils/perf.js +0 -86
  274. package/dist/lib/utils/plugins.js +0 -61
  275. package/dist/lib/utils/reflections.js +0 -64
  276. package/dist/lib/utils/sort.js +0 -153
  277. package/dist/lib/utils/tsconfig.js +0 -60
  278. package/dist/lib/utils/tsutils.js +0 -23
  279. package/dist/lib/utils-common/array.js +0 -152
  280. package/dist/lib/utils-common/declarationReference.js +0 -341
  281. package/dist/lib/utils-common/enum.js +0 -27
  282. package/dist/lib/utils-common/events.js +0 -49
  283. package/dist/lib/utils-common/general.js +0 -22
  284. package/dist/lib/utils-common/hooks.js +0 -90
  285. package/dist/lib/utils-common/i18n.js +0 -39
  286. package/dist/lib/utils-common/index.js +0 -17
  287. package/dist/lib/utils-common/jsx.elements.js +0 -3
  288. package/dist/lib/utils-common/jsx.js +0 -187
  289. package/dist/lib/utils-common/logger.js +0 -129
  290. package/dist/lib/utils-common/map.js +0 -63
  291. package/dist/lib/utils-common/minimalSourceFile.js +0 -43
  292. package/dist/lib/utils-common/path.js +0 -130
  293. package/dist/lib/utils-common/set.js +0 -23
  294. package/dist/lib/utils-common/string.js +0 -84
  295. package/dist/lib/utils-common/validation.js +0 -50
  296. package/dist/lib/validation/documentation.js +0 -91
  297. package/dist/lib/validation/exports.js +0 -65
  298. package/dist/lib/validation/links.js +0 -78
  299. package/dist/lib/validation/unusedMergeModuleWith.js +0 -12
  300. /package/dist/{browser-utils.d.ts → types/browser-utils.d.ts} +0 -0
  301. /package/dist/{lib → types}/cli.d.ts +0 -0
  302. /package/dist/{lib → types}/converter/comments/blockLexer.d.ts +0 -0
  303. /package/dist/{lib → types}/converter/comments/lineLexer.d.ts +0 -0
  304. /package/dist/{lib → types}/converter/comments/rawLexer.d.ts +0 -0
  305. /package/dist/{lib → types}/converter/comments/tagName.d.ts +0 -0
  306. /package/dist/{lib → types}/converter/convert-expression.d.ts +0 -0
  307. /package/dist/{lib → types}/converter/converter-events.d.ts +0 -0
  308. /package/dist/{lib → types}/converter/factories/index-signature.d.ts +0 -0
  309. /package/dist/{lib → types}/converter/factories/symbol-id.d.ts +0 -0
  310. /package/dist/{lib → types}/converter/jsdoc.d.ts +0 -0
  311. /package/dist/{lib → types}/converter/plugins/CommentPlugin.d.ts +0 -0
  312. /package/dist/{lib → types}/converter/plugins/ImplementsPlugin.d.ts +0 -0
  313. /package/dist/{lib → types}/converter/plugins/MergeModuleWithPlugin.d.ts +0 -0
  314. /package/dist/{lib → types}/converter/plugins/PackagePlugin.d.ts +0 -0
  315. /package/dist/{lib → types}/converter/plugins/index.d.ts +0 -0
  316. /package/dist/{lib → types}/converter/symbols.d.ts +0 -0
  317. /package/dist/{lib/converter/utils → types/converter/utilities}/nodes.d.ts +0 -0
  318. /package/dist/{lib/converter/utils → types/converter/utilities}/symbols.d.ts +0 -0
  319. /package/dist/{lib → types}/debug/index.d.ts +0 -0
  320. /package/dist/{lib → types}/debug/reflectionLifetimes.d.ts +0 -0
  321. /package/dist/{lib → types}/debug/rendererUrls.d.ts +0 -0
  322. /package/dist/{lib → types}/internationalization/index.d.ts +0 -0
  323. /package/dist/{lib → types}/models/Comment.d.ts +0 -0
  324. /package/dist/{lib → types}/models/ContainerReflection.d.ts +0 -0
  325. /package/dist/{lib → types}/models/DeclarationReflection.d.ts +0 -0
  326. /package/dist/{lib → types}/models/DocumentReflection.d.ts +0 -0
  327. /package/dist/{lib → types}/models/ParameterReflection.d.ts +0 -0
  328. /package/dist/{lib → types}/models/ProjectReflection.d.ts +0 -0
  329. /package/dist/{lib → types}/models/ReferenceReflection.d.ts +0 -0
  330. /package/dist/{lib → types}/models/Reflection.d.ts +0 -0
  331. /package/dist/{lib → types}/models/ReflectionCategory.d.ts +0 -0
  332. /package/dist/{lib → types}/models/ReflectionGroup.d.ts +0 -0
  333. /package/dist/{lib → types}/models/SignatureReflection.d.ts +0 -0
  334. /package/dist/{lib → types}/models/TypeParameterReflection.d.ts +0 -0
  335. /package/dist/{lib → types}/models/index.d.ts +0 -0
  336. /package/dist/{lib → types}/models/kind.d.ts +0 -0
  337. /package/dist/{lib → types}/models/types.d.ts +0 -0
  338. /package/dist/{lib → types}/models/utils.d.ts +0 -0
  339. /package/dist/{lib → types}/models/variant.d.ts +0 -0
  340. /package/dist/{lib → types}/output/index.d.ts +0 -0
  341. /package/dist/{lib → types}/output/plugins/AssetsPlugin.d.ts +0 -0
  342. /package/dist/{lib → types}/output/plugins/HierarchyPlugin.d.ts +0 -0
  343. /package/dist/{lib → types}/output/plugins/IconsPlugin.d.ts +0 -0
  344. /package/dist/{lib → types}/output/plugins/JavascriptIndexPlugin.d.ts +0 -0
  345. /package/dist/{lib → types}/output/plugins/NavigationPlugin.d.ts +0 -0
  346. /package/dist/{lib → types}/output/plugins/SitemapPlugin.d.ts +0 -0
  347. /package/dist/{lib → types}/output/plugins/index.d.ts +0 -0
  348. /package/dist/{lib → types}/output/theme.d.ts +0 -0
  349. /package/dist/{lib → types}/output/themes/default/Slugger.d.ts +0 -0
  350. /package/dist/{lib → types}/output/themes/default/partials/footer.d.ts +0 -0
  351. /package/dist/{lib → types}/output/themes/default/partials/member.declaration.d.ts +0 -0
  352. /package/dist/{lib → types}/output/themes/default/partials/typeAndParent.d.ts +0 -0
  353. /package/dist/{lib → types}/serialization/components.d.ts +0 -0
  354. /package/dist/{lib → types}/serialization/deserializer.d.ts +0 -0
  355. /package/dist/{lib → types}/serialization/events.d.ts +0 -0
  356. /package/dist/{lib → types}/serialization/index.d.ts +0 -0
  357. /package/dist/{lib → types}/serialization/schema.d.ts +0 -0
  358. /package/dist/{lib → types}/serialization/serializer.d.ts +0 -0
  359. /package/dist/{lib → types}/utils/component.d.ts +0 -0
  360. /package/dist/{lib → types}/utils/compress.d.ts +0 -0
  361. /package/dist/{lib → types}/utils/declaration-maps.d.ts +0 -0
  362. /package/dist/{lib → types}/utils/fs.d.ts +0 -0
  363. /package/dist/{lib → types}/utils/highlighter.d.ts +0 -0
  364. /package/dist/{lib → types}/utils/html-entities.d.ts +0 -0
  365. /package/dist/{lib → types}/utils/html.d.ts +0 -0
  366. /package/dist/{lib → types}/utils/loggers.d.ts +0 -0
  367. /package/dist/{lib → types}/utils/options/help.d.ts +0 -0
  368. /package/dist/{lib → types}/utils/options/readers/arguments.d.ts +0 -0
  369. /package/dist/{lib → types}/utils/options/readers/index.d.ts +0 -0
  370. /package/dist/{lib → types}/utils/options/readers/package-json.d.ts +0 -0
  371. /package/dist/{lib → types}/utils/options/readers/tsconfig.d.ts +0 -0
  372. /package/dist/{lib → types}/utils/options/readers/typedoc.d.ts +0 -0
  373. /package/dist/{lib → types}/utils/options/sources/index.d.ts +0 -0
  374. /package/dist/{lib → types}/utils/options/sources/typedoc.d.ts +0 -0
  375. /package/dist/{lib → types}/utils/package-manifest.d.ts +0 -0
  376. /package/dist/{lib → types}/utils/paths.d.ts +0 -0
  377. /package/dist/{lib → types}/utils/perf.d.ts +0 -0
  378. /package/dist/{lib → types}/utils/plugins.d.ts +0 -0
  379. /package/dist/{lib → types}/utils/tsconfig.d.ts +0 -0
  380. /package/dist/{lib → types}/utils/tsutils.d.ts +0 -0
  381. /package/dist/{lib → types}/utils-common/array.d.ts +0 -0
  382. /package/dist/{lib → types}/utils-common/declarationReference.d.ts +0 -0
  383. /package/dist/{lib → types}/utils-common/enum.d.ts +0 -0
  384. /package/dist/{lib → types}/utils-common/events.d.ts +0 -0
  385. /package/dist/{lib → types}/utils-common/hooks.d.ts +0 -0
  386. /package/dist/{lib → types}/utils-common/i18n.d.ts +0 -0
  387. /package/dist/{lib → types}/utils-common/index.d.ts +0 -0
  388. /package/dist/{lib → types}/utils-common/jsx.d.ts +0 -0
  389. /package/dist/{lib → types}/utils-common/jsx.elements.d.ts +0 -0
  390. /package/dist/{lib → types}/utils-common/logger.d.ts +0 -0
  391. /package/dist/{lib → types}/utils-common/map.d.ts +0 -0
  392. /package/dist/{lib → types}/utils-common/minimalSourceFile.d.ts +0 -0
  393. /package/dist/{lib → types}/utils-common/path.d.ts +0 -0
  394. /package/dist/{lib → types}/utils-common/set.d.ts +0 -0
  395. /package/dist/{lib → types}/utils-common/string.d.ts +0 -0
  396. /package/dist/{lib → types}/utils-common/validation.d.ts +0 -0
@@ -1,188 +0,0 @@
1
- var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
2
- function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
3
- var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
4
- var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
5
- var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
6
- var _, done = false;
7
- for (var i = decorators.length - 1; i >= 0; i--) {
8
- var context = {};
9
- for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
10
- for (var p in contextIn.access) context.access[p] = contextIn.access[p];
11
- context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
12
- var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
13
- if (kind === "accessor") {
14
- if (result === void 0) continue;
15
- if (result === null || typeof result !== "object") throw new TypeError("Object expected");
16
- if (_ = accept(result.get)) descriptor.get = _;
17
- if (_ = accept(result.set)) descriptor.set = _;
18
- if (_ = accept(result.init)) initializers.unshift(_);
19
- }
20
- else if (_ = accept(result)) {
21
- if (kind === "field") initializers.unshift(_);
22
- else descriptor[key] = _;
23
- }
24
- }
25
- if (target) Object.defineProperty(target, contextIn.name, descriptor);
26
- done = true;
27
- };
28
- var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
29
- var useValue = arguments.length > 2;
30
- for (var i = 0; i < initializers.length; i++) {
31
- value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
32
- }
33
- return useValue ? value : void 0;
34
- };
35
- import * as Path from "path";
36
- import { ConverterComponent } from "../components.js";
37
- import { ApplicationEvents } from "../../application-events.js";
38
- import { ConverterEvents } from "../converter-events.js";
39
- import { i18n, MinimalSourceFile, NormalizedPathUtils } from "#utils";
40
- import { deriveRootDir, discoverPackageJson, nicePath, normalizePath, Option, readFile, } from "#node-utils";
41
- import { existsSync } from "fs";
42
- /**
43
- * A handler that tries to find the package.json and readme.md files of the
44
- * current project.
45
- */
46
- let PackagePlugin = (() => {
47
- let _classSuper = ConverterComponent;
48
- let _readme_decorators;
49
- let _readme_initializers = [];
50
- let _readme_extraInitializers = [];
51
- let _entryPointStrategy_decorators;
52
- let _entryPointStrategy_initializers = [];
53
- let _entryPointStrategy_extraInitializers = [];
54
- let _entryPoints_decorators;
55
- let _entryPoints_initializers = [];
56
- let _entryPoints_extraInitializers = [];
57
- let _includeVersion_decorators;
58
- let _includeVersion_initializers = [];
59
- let _includeVersion_extraInitializers = [];
60
- return class PackagePlugin extends _classSuper {
61
- static {
62
- const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
63
- _readme_decorators = [Option("readme")];
64
- _entryPointStrategy_decorators = [Option("entryPointStrategy")];
65
- _entryPoints_decorators = [Option("entryPoints")];
66
- _includeVersion_decorators = [Option("includeVersion")];
67
- __esDecorate(this, null, _readme_decorators, { kind: "accessor", name: "readme", static: false, private: false, access: { has: obj => "readme" in obj, get: obj => obj.readme, set: (obj, value) => { obj.readme = value; } }, metadata: _metadata }, _readme_initializers, _readme_extraInitializers);
68
- __esDecorate(this, null, _entryPointStrategy_decorators, { kind: "accessor", name: "entryPointStrategy", static: false, private: false, access: { has: obj => "entryPointStrategy" in obj, get: obj => obj.entryPointStrategy, set: (obj, value) => { obj.entryPointStrategy = value; } }, metadata: _metadata }, _entryPointStrategy_initializers, _entryPointStrategy_extraInitializers);
69
- __esDecorate(this, null, _entryPoints_decorators, { kind: "accessor", name: "entryPoints", static: false, private: false, access: { has: obj => "entryPoints" in obj, get: obj => obj.entryPoints, set: (obj, value) => { obj.entryPoints = value; } }, metadata: _metadata }, _entryPoints_initializers, _entryPoints_extraInitializers);
70
- __esDecorate(this, null, _includeVersion_decorators, { kind: "accessor", name: "includeVersion", static: false, private: false, access: { has: obj => "includeVersion" in obj, get: obj => obj.includeVersion, set: (obj, value) => { obj.includeVersion = value; } }, metadata: _metadata }, _includeVersion_initializers, _includeVersion_extraInitializers);
71
- if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
72
- }
73
- #readme_accessor_storage = __runInitializers(this, _readme_initializers, void 0);
74
- get readme() { return this.#readme_accessor_storage; }
75
- set readme(value) { this.#readme_accessor_storage = value; }
76
- #entryPointStrategy_accessor_storage = (__runInitializers(this, _readme_extraInitializers), __runInitializers(this, _entryPointStrategy_initializers, void 0));
77
- get entryPointStrategy() { return this.#entryPointStrategy_accessor_storage; }
78
- set entryPointStrategy(value) { this.#entryPointStrategy_accessor_storage = value; }
79
- #entryPoints_accessor_storage = (__runInitializers(this, _entryPointStrategy_extraInitializers), __runInitializers(this, _entryPoints_initializers, void 0));
80
- get entryPoints() { return this.#entryPoints_accessor_storage; }
81
- set entryPoints(value) { this.#entryPoints_accessor_storage = value; }
82
- #includeVersion_accessor_storage = (__runInitializers(this, _entryPoints_extraInitializers), __runInitializers(this, _includeVersion_initializers, void 0));
83
- get includeVersion() { return this.#includeVersion_accessor_storage; }
84
- set includeVersion(value) { this.#includeVersion_accessor_storage = value; }
85
- /**
86
- * The file name of the found readme.md file.
87
- */
88
- readmeFile = __runInitializers(this, _includeVersion_extraInitializers);
89
- /**
90
- * Contents of the readme.md file discovered, if any
91
- */
92
- readmeContents;
93
- /**
94
- * Contents of package.json for the active project
95
- */
96
- packageJson;
97
- constructor(owner) {
98
- super(owner);
99
- this.owner.on(ConverterEvents.BEGIN, this.onBegin.bind(this));
100
- this.owner.on(ConverterEvents.RESOLVE_BEGIN, this.onBeginResolve.bind(this));
101
- this.owner.on(ConverterEvents.END, () => {
102
- delete this.readmeFile;
103
- delete this.readmeContents;
104
- delete this.packageJson;
105
- });
106
- this.application.on(ApplicationEvents.REVIVE, this.onRevive.bind(this));
107
- }
108
- onRevive(project) {
109
- this.onBegin();
110
- this.addEntries(project);
111
- delete this.readmeFile;
112
- delete this.packageJson;
113
- delete this.readmeContents;
114
- }
115
- onBegin() {
116
- this.readmeFile = undefined;
117
- this.readmeContents = undefined;
118
- this.packageJson = undefined;
119
- const dirName = this.application.options.packageDir ??
120
- Path.resolve(deriveRootDir(this.entryPoints));
121
- this.application.logger.verbose(`Begin package.json search at ${nicePath(dirName)}`);
122
- const packageJson = discoverPackageJson(dirName);
123
- this.packageJson = packageJson?.content;
124
- // Path will be resolved already. This is kind of ugly, but...
125
- if (this.readme.endsWith("none")) {
126
- return; // No readme, we're done
127
- }
128
- if (this.readme) {
129
- // Readme path provided, read only that file.
130
- this.application.watchFile(this.readme);
131
- try {
132
- this.readmeContents = readFile(this.readme);
133
- this.readmeFile = normalizePath(this.readme);
134
- }
135
- catch {
136
- this.application.logger.error(i18n.provided_readme_at_0_could_not_be_read(nicePath(this.readme)));
137
- }
138
- }
139
- else if (packageJson) {
140
- // No readme provided, automatically find the readme
141
- const possibleReadmePaths = [
142
- "README.md",
143
- "readme.md",
144
- "Readme.md",
145
- ].map(name => Path.join(Path.dirname(packageJson.file), name));
146
- const readmePath = possibleReadmePaths.find(path => {
147
- this.application.watchFile(path);
148
- return existsSync(path);
149
- });
150
- if (readmePath) {
151
- this.readmeFile = normalizePath(readmePath);
152
- this.readmeContents = readFile(readmePath);
153
- this.application.watchFile(this.readmeFile);
154
- }
155
- }
156
- }
157
- onBeginResolve(context) {
158
- this.addEntries(context.project);
159
- }
160
- addEntries(project) {
161
- if (this.readmeFile && this.readmeContents) {
162
- const { content } = this.application.converter.parseRawComment(new MinimalSourceFile(this.readmeContents, this.readmeFile), project.files);
163
- project.readme = content;
164
- project.files.registerReflectionPath(this.readmeFile, project);
165
- // In packages mode, this probably won't do anything unless someone uses the readme
166
- // option to select a different file.
167
- project.files.registerReflectionPath(NormalizedPathUtils.dirname(this.readmeFile), project);
168
- // This isn't ideal, but seems better than figuring out the readme
169
- // path over in the include plugin...
170
- this.owner.includePlugin.checkIncludeTagsParts(project, Path.dirname(this.readmeFile), content);
171
- }
172
- if (this.packageJson) {
173
- project.packageName = this.packageJson.name;
174
- if (!project.name) {
175
- project.name = project.packageName || "Documentation";
176
- }
177
- if (this.includeVersion) {
178
- project.packageVersion = this.packageJson.version?.replace(/^v/, "");
179
- }
180
- }
181
- else if (!project.name) {
182
- this.application.logger.warn(i18n.defaulting_project_name());
183
- project.name = "Documentation";
184
- }
185
- }
186
- };
187
- })();
188
- export { PackagePlugin };
@@ -1,215 +0,0 @@
1
- var __esDecorate = (this && this.__esDecorate) || function (ctor, descriptorIn, decorators, contextIn, initializers, extraInitializers) {
2
- function accept(f) { if (f !== void 0 && typeof f !== "function") throw new TypeError("Function expected"); return f; }
3
- var kind = contextIn.kind, key = kind === "getter" ? "get" : kind === "setter" ? "set" : "value";
4
- var target = !descriptorIn && ctor ? contextIn["static"] ? ctor : ctor.prototype : null;
5
- var descriptor = descriptorIn || (target ? Object.getOwnPropertyDescriptor(target, contextIn.name) : {});
6
- var _, done = false;
7
- for (var i = decorators.length - 1; i >= 0; i--) {
8
- var context = {};
9
- for (var p in contextIn) context[p] = p === "access" ? {} : contextIn[p];
10
- for (var p in contextIn.access) context.access[p] = contextIn.access[p];
11
- context.addInitializer = function (f) { if (done) throw new TypeError("Cannot add initializers after decoration has completed"); extraInitializers.push(accept(f || null)); };
12
- var result = (0, decorators[i])(kind === "accessor" ? { get: descriptor.get, set: descriptor.set } : descriptor[key], context);
13
- if (kind === "accessor") {
14
- if (result === void 0) continue;
15
- if (result === null || typeof result !== "object") throw new TypeError("Object expected");
16
- if (_ = accept(result.get)) descriptor.get = _;
17
- if (_ = accept(result.set)) descriptor.set = _;
18
- if (_ = accept(result.init)) initializers.unshift(_);
19
- }
20
- else if (_ = accept(result)) {
21
- if (kind === "field") initializers.unshift(_);
22
- else descriptor[key] = _;
23
- }
24
- }
25
- if (target) Object.defineProperty(target, contextIn.name, descriptor);
26
- done = true;
27
- };
28
- var __runInitializers = (this && this.__runInitializers) || function (thisArg, initializers, value) {
29
- var useValue = arguments.length > 2;
30
- for (var i = 0; i < initializers.length; i++) {
31
- value = useValue ? initializers[i].call(thisArg, value) : initializers[i].call(thisArg);
32
- }
33
- return useValue ? value : void 0;
34
- };
35
- import ts from "typescript";
36
- import { DeclarationReflection, ReflectionKind, SignatureReflection } from "../../models/index.js";
37
- import { ConverterComponent } from "../components.js";
38
- import { getCommonDirectory, normalizePath, Option } from "../../utils/index.js";
39
- import { isNamedNode } from "../utils/nodes.js";
40
- import { relative } from "path";
41
- import { SourceReference } from "../../models/index.js";
42
- import { gitIsInstalled, RepositoryManager } from "../utils/repository.js";
43
- import { ConverterEvents } from "../converter-events.js";
44
- import { i18n } from "#utils";
45
- /**
46
- * A handler that attaches source file information to reflections.
47
- */
48
- let SourcePlugin = (() => {
49
- let _classSuper = ConverterComponent;
50
- let _disableSources_decorators;
51
- let _disableSources_initializers = [];
52
- let _disableSources_extraInitializers = [];
53
- let _gitRevision_decorators;
54
- let _gitRevision_initializers = [];
55
- let _gitRevision_extraInitializers = [];
56
- let _gitRemote_decorators;
57
- let _gitRemote_initializers = [];
58
- let _gitRemote_extraInitializers = [];
59
- let _disableGit_decorators;
60
- let _disableGit_initializers = [];
61
- let _disableGit_extraInitializers = [];
62
- let _sourceLinkTemplate_decorators;
63
- let _sourceLinkTemplate_initializers = [];
64
- let _sourceLinkTemplate_extraInitializers = [];
65
- return class SourcePlugin extends _classSuper {
66
- static {
67
- const _metadata = typeof Symbol === "function" && Symbol.metadata ? Object.create(_classSuper[Symbol.metadata] ?? null) : void 0;
68
- _disableSources_decorators = [Option("disableSources")];
69
- _gitRevision_decorators = [Option("gitRevision")];
70
- _gitRemote_decorators = [Option("gitRemote")];
71
- _disableGit_decorators = [Option("disableGit")];
72
- _sourceLinkTemplate_decorators = [Option("sourceLinkTemplate")];
73
- __esDecorate(this, null, _disableSources_decorators, { kind: "accessor", name: "disableSources", static: false, private: false, access: { has: obj => "disableSources" in obj, get: obj => obj.disableSources, set: (obj, value) => { obj.disableSources = value; } }, metadata: _metadata }, _disableSources_initializers, _disableSources_extraInitializers);
74
- __esDecorate(this, null, _gitRevision_decorators, { kind: "accessor", name: "gitRevision", static: false, private: false, access: { has: obj => "gitRevision" in obj, get: obj => obj.gitRevision, set: (obj, value) => { obj.gitRevision = value; } }, metadata: _metadata }, _gitRevision_initializers, _gitRevision_extraInitializers);
75
- __esDecorate(this, null, _gitRemote_decorators, { kind: "accessor", name: "gitRemote", static: false, private: false, access: { has: obj => "gitRemote" in obj, get: obj => obj.gitRemote, set: (obj, value) => { obj.gitRemote = value; } }, metadata: _metadata }, _gitRemote_initializers, _gitRemote_extraInitializers);
76
- __esDecorate(this, null, _disableGit_decorators, { kind: "accessor", name: "disableGit", static: false, private: false, access: { has: obj => "disableGit" in obj, get: obj => obj.disableGit, set: (obj, value) => { obj.disableGit = value; } }, metadata: _metadata }, _disableGit_initializers, _disableGit_extraInitializers);
77
- __esDecorate(this, null, _sourceLinkTemplate_decorators, { kind: "accessor", name: "sourceLinkTemplate", static: false, private: false, access: { has: obj => "sourceLinkTemplate" in obj, get: obj => obj.sourceLinkTemplate, set: (obj, value) => { obj.sourceLinkTemplate = value; } }, metadata: _metadata }, _sourceLinkTemplate_initializers, _sourceLinkTemplate_extraInitializers);
78
- if (_metadata) Object.defineProperty(this, Symbol.metadata, { enumerable: true, configurable: true, writable: true, value: _metadata });
79
- }
80
- #disableSources_accessor_storage = __runInitializers(this, _disableSources_initializers, void 0);
81
- get disableSources() { return this.#disableSources_accessor_storage; }
82
- set disableSources(value) { this.#disableSources_accessor_storage = value; }
83
- #gitRevision_accessor_storage = (__runInitializers(this, _disableSources_extraInitializers), __runInitializers(this, _gitRevision_initializers, void 0));
84
- get gitRevision() { return this.#gitRevision_accessor_storage; }
85
- set gitRevision(value) { this.#gitRevision_accessor_storage = value; }
86
- #gitRemote_accessor_storage = (__runInitializers(this, _gitRevision_extraInitializers), __runInitializers(this, _gitRemote_initializers, void 0));
87
- get gitRemote() { return this.#gitRemote_accessor_storage; }
88
- set gitRemote(value) { this.#gitRemote_accessor_storage = value; }
89
- #disableGit_accessor_storage = (__runInitializers(this, _gitRemote_extraInitializers), __runInitializers(this, _disableGit_initializers, void 0));
90
- get disableGit() { return this.#disableGit_accessor_storage; }
91
- set disableGit(value) { this.#disableGit_accessor_storage = value; }
92
- #sourceLinkTemplate_accessor_storage = (__runInitializers(this, _disableGit_extraInitializers), __runInitializers(this, _sourceLinkTemplate_initializers, void 0));
93
- get sourceLinkTemplate() { return this.#sourceLinkTemplate_accessor_storage; }
94
- set sourceLinkTemplate(value) { this.#sourceLinkTemplate_accessor_storage = value; }
95
- get displayBasePath() {
96
- return this.application.options.getValue("displayBasePath") || this.application.options.getValue("basePath");
97
- }
98
- /**
99
- * All file names to find the base path from.
100
- */
101
- fileNames = (__runInitializers(this, _sourceLinkTemplate_extraInitializers), new Set());
102
- repositories;
103
- constructor(owner) {
104
- super(owner);
105
- this.owner.on(ConverterEvents.END, this.onEnd.bind(this));
106
- this.owner.on(ConverterEvents.CREATE_DECLARATION, this.onDeclaration.bind(this));
107
- this.owner.on(ConverterEvents.CREATE_SIGNATURE, this.onSignature.bind(this));
108
- this.owner.on(ConverterEvents.RESOLVE_BEGIN, this.onBeginResolve.bind(this));
109
- }
110
- onEnd() {
111
- this.fileNames.clear();
112
- delete this.repositories;
113
- }
114
- /**
115
- * Triggered when the converter has created a declaration reflection.
116
- *
117
- * Attach the current source file to the {@link DeclarationReflection.sources} array.
118
- *
119
- * @param _context The context object describing the current state the converter is in.
120
- * @param reflection The reflection that is currently processed.
121
- */
122
- onDeclaration(context, reflection) {
123
- if (this.disableSources || reflection.kindOf(ReflectionKind.TypeLiteral))
124
- return;
125
- const symbol = context.getSymbolFromReflection(reflection);
126
- for (const node of symbol?.declarations || []) {
127
- const sourceFile = node.getSourceFile();
128
- const fileName = normalizePath(sourceFile.fileName);
129
- this.fileNames.add(fileName);
130
- let position;
131
- if (ts.isSourceFile(node)) {
132
- position = { character: 0, line: 0 };
133
- }
134
- else {
135
- position = ts.getLineAndCharacterOfPosition(sourceFile, getLocationNode(node).getStart());
136
- }
137
- reflection.sources ||= [];
138
- reflection.sources.push(new SourceReference(fileName, position.line + 1, position.character));
139
- }
140
- }
141
- onSignature(_context, reflection, sig) {
142
- if (this.disableSources || !sig || reflection.parent.kindOf(ReflectionKind.TypeLiteral))
143
- return;
144
- const sourceFile = sig.getSourceFile();
145
- const fileName = normalizePath(sourceFile.fileName);
146
- this.fileNames.add(fileName);
147
- const position = ts.getLineAndCharacterOfPosition(sourceFile, getLocationNode(sig).getStart());
148
- reflection.sources ||= [];
149
- reflection.sources.push(new SourceReference(fileName, position.line + 1, position.character));
150
- }
151
- /**
152
- * Triggered when the converter begins resolving a project.
153
- *
154
- * @param context The context object describing the current state the converter is in.
155
- */
156
- onBeginResolve(context) {
157
- if (this.disableSources)
158
- return;
159
- if (this.disableGit && !this.sourceLinkTemplate) {
160
- this.application.logger.error(i18n.disable_git_set_but_not_source_link_template());
161
- return;
162
- }
163
- if (this.disableGit &&
164
- this.sourceLinkTemplate.includes("{gitRevision}") &&
165
- !this.gitRevision) {
166
- this.application.logger.warn(i18n.disable_git_set_and_git_revision_used());
167
- }
168
- const basePath = this.displayBasePath || getCommonDirectory([...this.fileNames]);
169
- this.repositories ||= new RepositoryManager(basePath, this.gitRevision, this.gitRemote, this.sourceLinkTemplate, this.disableGit, this.application.logger);
170
- for (const id in context.project.reflections) {
171
- const refl = context.project.reflections[id];
172
- if (!(refl instanceof DeclarationReflection ||
173
- refl instanceof SignatureReflection)) {
174
- continue;
175
- }
176
- if (replaceSourcesWithParentSources(context, refl)) {
177
- refl.sources = refl.parent.sources;
178
- }
179
- for (const source of refl.sources || []) {
180
- if (this.disableGit || gitIsInstalled()) {
181
- const repo = this.repositories.getRepository(source.fullFileName);
182
- source.url = repo?.getURL(source.fullFileName, source.line);
183
- }
184
- source.fileName = normalizePath(relative(basePath, source.fullFileName));
185
- }
186
- }
187
- }
188
- };
189
- })();
190
- export { SourcePlugin };
191
- function getLocationNode(node) {
192
- if (isNamedNode(node))
193
- return node.name;
194
- return node;
195
- }
196
- function replaceSourcesWithParentSources(context, refl) {
197
- if (refl instanceof DeclarationReflection || !refl.sources) {
198
- return false;
199
- }
200
- const symbol = context.getSymbolFromReflection(refl.parent);
201
- if (!symbol?.declarations) {
202
- return false;
203
- }
204
- for (const decl of symbol.declarations) {
205
- const file = decl.getSourceFile();
206
- const pos = file.getLineAndCharacterOfPosition(decl.pos);
207
- const end = file.getLineAndCharacterOfPosition(decl.end);
208
- if (refl.sources.some((src) => src.fullFileName === file.fileName &&
209
- pos.line <= src.line - 1 &&
210
- src.line - 1 <= end.line)) {
211
- return false;
212
- }
213
- }
214
- return true;
215
- }
@@ -1,108 +0,0 @@
1
- import { DeclarationReflection, ReflectionKind, } from "../../models/index.js";
2
- import { ReferenceType } from "../../models/types.js";
3
- import { ConverterComponent } from "../components.js";
4
- import { ApplicationEvents } from "../../application-events.js";
5
- import { ConverterEvents } from "../converter-events.js";
6
- /**
7
- * Responsible for adding `implementedBy` / `implementedFrom`
8
- */
9
- export class TypePlugin extends ConverterComponent {
10
- reflections = new Set();
11
- constructor(owner) {
12
- super(owner);
13
- this.owner.on(ConverterEvents.RESOLVE, this.onResolve.bind(this));
14
- this.owner.on(ConverterEvents.RESOLVE_END, this.onResolveEnd.bind(this));
15
- this.owner.on(ConverterEvents.END, () => this.reflections.clear());
16
- this.application.on(ApplicationEvents.REVIVE, this.onRevive.bind(this), 100);
17
- }
18
- onRevive(project) {
19
- for (const id in project.reflections) {
20
- this.resolve(project, project.reflections[id]);
21
- }
22
- this.finishResolve(project);
23
- this.reflections.clear();
24
- }
25
- onResolve(context, reflection) {
26
- this.resolve(context.project, reflection);
27
- }
28
- resolve(project, reflection) {
29
- if (!(reflection instanceof DeclarationReflection))
30
- return;
31
- if (reflection.kindOf(ReflectionKind.ClassOrInterface)) {
32
- this.postpone(reflection);
33
- walk(reflection.implementedTypes, (target) => {
34
- this.postpone(target);
35
- target.implementedBy ||= [];
36
- if (!target.implementedBy.some((t) => t.reflection === reflection)) {
37
- target.implementedBy.push(ReferenceType.createResolvedReference(reflection.name, reflection, project));
38
- }
39
- });
40
- walk(reflection.extendedTypes, (target) => {
41
- this.postpone(target);
42
- target.extendedBy ||= [];
43
- if (!target.extendedBy.some((t) => t.reflection === reflection)) {
44
- target.extendedBy.push(ReferenceType.createResolvedReference(reflection.name, reflection, project));
45
- }
46
- });
47
- }
48
- function walk(types, callback) {
49
- if (!types) {
50
- return;
51
- }
52
- types.forEach((type) => {
53
- if (!(type instanceof ReferenceType)) {
54
- return;
55
- }
56
- if (!type.reflection ||
57
- !(type.reflection instanceof DeclarationReflection)) {
58
- return;
59
- }
60
- callback(type.reflection);
61
- });
62
- }
63
- }
64
- postpone(reflection) {
65
- this.reflections.add(reflection);
66
- }
67
- onResolveEnd(context) {
68
- this.finishResolve(context.project);
69
- }
70
- finishResolve(project) {
71
- this.reflections.forEach((reflection) => {
72
- if (reflection.implementedBy) {
73
- reflection.implementedBy.sort((a, b) => {
74
- if (a.name === b.name) {
75
- return 0;
76
- }
77
- return a.name > b.name ? 1 : -1;
78
- });
79
- }
80
- let root;
81
- let hierarchy;
82
- function push(types) {
83
- const level = { types: types };
84
- if (hierarchy) {
85
- hierarchy.next = level;
86
- hierarchy = level;
87
- }
88
- else {
89
- root = hierarchy = level;
90
- }
91
- }
92
- if (reflection.extendedTypes) {
93
- push(reflection.extendedTypes);
94
- }
95
- push([
96
- ReferenceType.createResolvedReference(reflection.name, reflection, project),
97
- ]);
98
- hierarchy.isTarget = true;
99
- if (reflection.extendedBy) {
100
- push(reflection.extendedBy);
101
- }
102
- // No point setting up a hierarchy if there is no hierarchy to display
103
- if (root.next) {
104
- reflection.typeHierarchy = root;
105
- }
106
- });
107
- }
108
- }
@@ -1,10 +0,0 @@
1
- export { CategoryPlugin } from "./CategoryPlugin.js";
2
- export { CommentPlugin } from "./CommentPlugin.js";
3
- export { GroupPlugin } from "./GroupPlugin.js";
4
- export { ImplementsPlugin } from "./ImplementsPlugin.js";
5
- export { IncludePlugin } from "./IncludePlugin.js";
6
- export { InheritDocPlugin } from "./InheritDocPlugin.js";
7
- export { LinkResolverPlugin } from "./LinkResolverPlugin.js";
8
- export { PackagePlugin } from "./PackagePlugin.js";
9
- export { SourcePlugin } from "./SourcePlugin.js";
10
- export { TypePlugin } from "./TypePlugin.js";