@depup/typedoc 0.28.17-depup.0
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.
- package/LICENSE +201 -0
- package/README.md +34 -0
- package/bin/package.json +3 -0
- package/bin/typedoc +24 -0
- package/changes.json +22 -0
- package/dist/browser-locales/de.d.ts +2 -0
- package/dist/browser-locales/de.js +62 -0
- package/dist/browser-locales/en.d.ts +2 -0
- package/dist/browser-locales/en.js +62 -0
- package/dist/browser-locales/ja.d.ts +2 -0
- package/dist/browser-locales/ja.js +62 -0
- package/dist/browser-locales/ko.d.ts +2 -0
- package/dist/browser-locales/ko.js +62 -0
- package/dist/browser-locales/zh.d.ts +2 -0
- package/dist/browser-locales/zh.js +62 -0
- package/dist/browser-utils.d.ts +3 -0
- package/dist/browser-utils.js +3 -0
- package/dist/index.d.ts +49 -0
- package/dist/index.js +46 -0
- package/dist/lib/application-events.d.ts +5 -0
- package/dist/lib/application-events.js +5 -0
- package/dist/lib/application.d.ts +195 -0
- package/dist/lib/application.js +715 -0
- package/dist/lib/cli.d.ts +1 -0
- package/dist/lib/cli.js +111 -0
- package/dist/lib/converter/comments/blockLexer.d.ts +4 -0
- package/dist/lib/converter/comments/blockLexer.js +391 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts +3 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.js +218 -0
- package/dist/lib/converter/comments/discovery.d.ts +14 -0
- package/dist/lib/converter/comments/discovery.js +563 -0
- package/dist/lib/converter/comments/index.d.ts +37 -0
- package/dist/lib/converter/comments/index.js +241 -0
- package/dist/lib/converter/comments/lexer.d.ts +17 -0
- package/dist/lib/converter/comments/lexer.js +10 -0
- package/dist/lib/converter/comments/lineLexer.d.ts +3 -0
- package/dist/lib/converter/comments/lineLexer.js +279 -0
- package/dist/lib/converter/comments/linkResolver.d.ts +20 -0
- package/dist/lib/converter/comments/linkResolver.js +186 -0
- package/dist/lib/converter/comments/parser.d.ts +18 -0
- package/dist/lib/converter/comments/parser.js +538 -0
- package/dist/lib/converter/comments/rawLexer.d.ts +8 -0
- package/dist/lib/converter/comments/rawLexer.js +218 -0
- package/dist/lib/converter/comments/tagName.d.ts +8 -0
- package/dist/lib/converter/comments/tagName.js +58 -0
- package/dist/lib/converter/comments/textParser.d.ts +33 -0
- package/dist/lib/converter/comments/textParser.js +372 -0
- package/dist/lib/converter/components.d.ts +4 -0
- package/dist/lib/converter/components.js +3 -0
- package/dist/lib/converter/context.d.ts +101 -0
- package/dist/lib/converter/context.js +311 -0
- package/dist/lib/converter/convert-expression.d.ts +9 -0
- package/dist/lib/converter/convert-expression.js +58 -0
- package/dist/lib/converter/converter-events.d.ts +13 -0
- package/dist/lib/converter/converter-events.js +13 -0
- package/dist/lib/converter/converter.d.ts +238 -0
- package/dist/lib/converter/converter.js +705 -0
- package/dist/lib/converter/factories/index-signature.d.ts +3 -0
- package/dist/lib/converter/factories/index-signature.js +50 -0
- package/dist/lib/converter/factories/signature.d.ts +14 -0
- package/dist/lib/converter/factories/signature.js +353 -0
- package/dist/lib/converter/factories/symbol-id.d.ts +3 -0
- package/dist/lib/converter/factories/symbol-id.js +47 -0
- package/dist/lib/converter/index.d.ts +5 -0
- package/dist/lib/converter/index.js +3 -0
- package/dist/lib/converter/jsdoc.d.ts +4 -0
- package/dist/lib/converter/jsdoc.js +135 -0
- package/dist/lib/converter/plugins/CategoryPlugin.d.ts +48 -0
- package/dist/lib/converter/plugins/CategoryPlugin.js +278 -0
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +128 -0
- package/dist/lib/converter/plugins/CommentPlugin.js +770 -0
- package/dist/lib/converter/plugins/GroupPlugin.d.ts +48 -0
- package/dist/lib/converter/plugins/GroupPlugin.js +281 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts +42 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.js +438 -0
- package/dist/lib/converter/plugins/IncludePlugin.d.ts +14 -0
- package/dist/lib/converter/plugins/IncludePlugin.js +254 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.d.ts +32 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.js +220 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts +13 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.js +88 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts +12 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +50 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +31 -0
- package/dist/lib/converter/plugins/PackagePlugin.js +188 -0
- package/dist/lib/converter/plugins/SourcePlugin.d.ts +36 -0
- package/dist/lib/converter/plugins/SourcePlugin.js +215 -0
- package/dist/lib/converter/plugins/TypePlugin.d.ts +16 -0
- package/dist/lib/converter/plugins/TypePlugin.js +108 -0
- package/dist/lib/converter/plugins/index.d.ts +10 -0
- package/dist/lib/converter/plugins/index.js +10 -0
- package/dist/lib/converter/symbols.d.ts +3 -0
- package/dist/lib/converter/symbols.js +861 -0
- package/dist/lib/converter/types.d.ts +10 -0
- package/dist/lib/converter/types.js +833 -0
- package/dist/lib/converter/utils/nodes.d.ts +7 -0
- package/dist/lib/converter/utils/nodes.js +26 -0
- package/dist/lib/converter/utils/reflections.d.ts +2 -0
- package/dist/lib/converter/utils/reflections.js +17 -0
- package/dist/lib/converter/utils/repository.d.ts +96 -0
- package/dist/lib/converter/utils/repository.js +295 -0
- package/dist/lib/converter/utils/symbols.d.ts +2 -0
- package/dist/lib/converter/utils/symbols.js +12 -0
- package/dist/lib/debug/index.d.ts +2 -0
- package/dist/lib/debug/index.js +2 -0
- package/dist/lib/debug/reflectionLifetimes.d.ts +3 -0
- package/dist/lib/debug/reflectionLifetimes.js +27 -0
- package/dist/lib/debug/rendererUrls.d.ts +6 -0
- package/dist/lib/debug/rendererUrls.js +68 -0
- package/dist/lib/internationalization/index.d.ts +7 -0
- package/dist/lib/internationalization/index.js +7 -0
- package/dist/lib/internationalization/internationalization.d.ts +65 -0
- package/dist/lib/internationalization/internationalization.js +64 -0
- package/dist/lib/internationalization/locale-utils.cjs +8 -0
- package/dist/lib/internationalization/locale-utils.d.cts +8 -0
- package/dist/lib/internationalization/locales/de.cjs +401 -0
- package/dist/lib/internationalization/locales/de.d.cts +368 -0
- package/dist/lib/internationalization/locales/en.cjs +411 -0
- package/dist/lib/internationalization/locales/en.d.cts +380 -0
- package/dist/lib/internationalization/locales/ja.cjs +320 -0
- package/dist/lib/internationalization/locales/ja.d.cts +307 -0
- package/dist/lib/internationalization/locales/ko.cjs +233 -0
- package/dist/lib/internationalization/locales/ko.d.cts +221 -0
- package/dist/lib/internationalization/locales/zh.cjs +488 -0
- package/dist/lib/internationalization/locales/zh.d.cts +452 -0
- package/dist/lib/internationalization/translatable.d.ts +21 -0
- package/dist/lib/internationalization/translatable.js +8 -0
- package/dist/lib/models/Comment.d.ts +241 -0
- package/dist/lib/models/Comment.js +534 -0
- package/dist/lib/models/ContainerReflection.d.ts +56 -0
- package/dist/lib/models/ContainerReflection.js +159 -0
- package/dist/lib/models/DeclarationReflection.d.ts +149 -0
- package/dist/lib/models/DeclarationReflection.js +287 -0
- package/dist/lib/models/DocumentReflection.d.ts +32 -0
- package/dist/lib/models/DocumentReflection.js +66 -0
- package/dist/lib/models/FileRegistry.d.ts +46 -0
- package/dist/lib/models/FileRegistry.js +133 -0
- package/dist/lib/models/ParameterReflection.d.ts +21 -0
- package/dist/lib/models/ParameterReflection.js +39 -0
- package/dist/lib/models/ProjectReflection.d.ts +112 -0
- package/dist/lib/models/ProjectReflection.js +417 -0
- package/dist/lib/models/ReferenceReflection.d.ts +49 -0
- package/dist/lib/models/ReferenceReflection.js +85 -0
- package/dist/lib/models/Reflection.d.ts +229 -0
- package/dist/lib/models/Reflection.js +495 -0
- package/dist/lib/models/ReflectionCategory.d.ts +31 -0
- package/dist/lib/models/ReflectionCategory.js +56 -0
- package/dist/lib/models/ReflectionGroup.d.ts +38 -0
- package/dist/lib/models/ReflectionGroup.js +72 -0
- package/dist/lib/models/ReflectionSymbolId.d.ts +63 -0
- package/dist/lib/models/ReflectionSymbolId.js +85 -0
- package/dist/lib/models/SignatureReflection.d.ts +50 -0
- package/dist/lib/models/SignatureReflection.js +96 -0
- package/dist/lib/models/SourceReference.d.ts +33 -0
- package/dist/lib/models/SourceReference.js +50 -0
- package/dist/lib/models/TypeParameterReflection.d.ts +30 -0
- package/dist/lib/models/TypeParameterReflection.js +45 -0
- package/dist/lib/models/index.d.ts +19 -0
- package/dist/lib/models/index.js +19 -0
- package/dist/lib/models/kind.d.ts +84 -0
- package/dist/lib/models/kind.js +231 -0
- package/dist/lib/models/types.d.ts +553 -0
- package/dist/lib/models/types.js +1296 -0
- package/dist/lib/models/utils.d.ts +1 -0
- package/dist/lib/models/utils.js +26 -0
- package/dist/lib/models/variant.d.ts +21 -0
- package/dist/lib/models/variant.js +1 -0
- package/dist/lib/output/components.d.ts +53 -0
- package/dist/lib/output/components.js +133 -0
- package/dist/lib/output/events.d.ts +175 -0
- package/dist/lib/output/events.js +195 -0
- package/dist/lib/output/formatter.d.ts +88 -0
- package/dist/lib/output/formatter.js +660 -0
- package/dist/lib/output/index.d.ts +9 -0
- package/dist/lib/output/index.js +7 -0
- package/dist/lib/output/output.d.ts +14 -0
- package/dist/lib/output/output.js +92 -0
- package/dist/lib/output/plugins/AssetsPlugin.d.ts +20 -0
- package/dist/lib/output/plugins/AssetsPlugin.js +160 -0
- package/dist/lib/output/plugins/HierarchyPlugin.d.ts +7 -0
- package/dist/lib/output/plugins/HierarchyPlugin.js +65 -0
- package/dist/lib/output/plugins/IconsPlugin.d.ts +12 -0
- package/dist/lib/output/plugins/IconsPlugin.js +54 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts +22 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +222 -0
- package/dist/lib/output/plugins/NavigationPlugin.d.ts +7 -0
- package/dist/lib/output/plugins/NavigationPlugin.js +23 -0
- package/dist/lib/output/plugins/SitemapPlugin.d.ts +8 -0
- package/dist/lib/output/plugins/SitemapPlugin.js +82 -0
- package/dist/lib/output/plugins/index.d.ts +7 -0
- package/dist/lib/output/plugins/index.js +7 -0
- package/dist/lib/output/renderer.d.ts +227 -0
- package/dist/lib/output/renderer.js +387 -0
- package/dist/lib/output/router.d.ts +187 -0
- package/dist/lib/output/router.js +520 -0
- package/dist/lib/output/theme.d.ts +22 -0
- package/dist/lib/output/theme.js +17 -0
- package/dist/lib/output/themes/MarkedPlugin.d.ts +62 -0
- package/dist/lib/output/themes/MarkedPlugin.js +461 -0
- package/dist/lib/output/themes/default/DefaultTheme.d.ts +72 -0
- package/dist/lib/output/themes/default/DefaultTheme.js +367 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +105 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +151 -0
- package/dist/lib/output/themes/default/Slugger.d.ts +13 -0
- package/dist/lib/output/themes/default/Slugger.js +60 -0
- package/dist/lib/output/themes/default/layouts/default.d.ts +6 -0
- package/dist/lib/output/themes/default/layouts/default.js +89 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.js +9 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.js +11 -0
- package/dist/lib/output/themes/default/partials/comment.d.ts +8 -0
- package/dist/lib/output/themes/default/partials/comment.js +80 -0
- package/dist/lib/output/themes/default/partials/footer.d.ts +3 -0
- package/dist/lib/output/themes/default/partials/footer.js +37 -0
- package/dist/lib/output/themes/default/partials/header.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/header.js +39 -0
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/hierarchy.js +32 -0
- package/dist/lib/output/themes/default/partials/icon.d.ts +20 -0
- package/dist/lib/output/themes/default/partials/icon.js +101 -0
- package/dist/lib/output/themes/default/partials/index.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/index.js +24 -0
- package/dist/lib/output/themes/default/partials/member.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.declaration.js +35 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.js +12 -0
- package/dist/lib/output/themes/default/partials/member.js +36 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts +6 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.js +33 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.js +9 -0
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.signatures.js +9 -0
- package/dist/lib/output/themes/default/partials/member.sources.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/member.sources.js +55 -0
- package/dist/lib/output/themes/default/partials/members.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/members.js +17 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.js +68 -0
- package/dist/lib/output/themes/default/partials/navigation.d.ts +10 -0
- package/dist/lib/output/themes/default/partials/navigation.js +144 -0
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/reflectionPreview.js +26 -0
- package/dist/lib/output/themes/default/partials/toolbar.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/toolbar.js +13 -0
- package/dist/lib/output/themes/default/partials/type.d.ts +5 -0
- package/dist/lib/output/themes/default/partials/type.js +9 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.js +28 -0
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts +8 -0
- package/dist/lib/output/themes/default/partials/typeDetails.js +284 -0
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts +4 -0
- package/dist/lib/output/themes/default/partials/typeParameters.js +26 -0
- package/dist/lib/output/themes/default/templates/document.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/document.js +3 -0
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/hierarchy.js +31 -0
- package/dist/lib/output/themes/default/templates/index.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/index.js +3 -0
- package/dist/lib/output/themes/default/templates/reflection.d.ts +5 -0
- package/dist/lib/output/themes/default/templates/reflection.js +53 -0
- package/dist/lib/output/themes/lib.d.ts +44 -0
- package/dist/lib/output/themes/lib.js +218 -0
- package/dist/lib/serialization/components.d.ts +22 -0
- package/dist/lib/serialization/components.js +1 -0
- package/dist/lib/serialization/deserializer.d.ts +70 -0
- package/dist/lib/serialization/deserializer.js +235 -0
- package/dist/lib/serialization/events.d.ts +17 -0
- package/dist/lib/serialization/events.js +18 -0
- package/dist/lib/serialization/index.d.ts +5 -0
- package/dist/lib/serialization/index.js +4 -0
- package/dist/lib/serialization/schema.d.ts +283 -0
- package/dist/lib/serialization/schema.js +32 -0
- package/dist/lib/serialization/serializer.d.ts +52 -0
- package/dist/lib/serialization/serializer.js +65 -0
- package/dist/lib/utils/ValidatingFileRegistry.d.ts +12 -0
- package/dist/lib/utils/ValidatingFileRegistry.js +52 -0
- package/dist/lib/utils/component.d.ts +38 -0
- package/dist/lib/utils/component.js +41 -0
- package/dist/lib/utils/compress.d.ts +7 -0
- package/dist/lib/utils/compress.js +13 -0
- package/dist/lib/utils/declaration-maps.d.ts +3 -0
- package/dist/lib/utils/declaration-maps.js +51 -0
- package/dist/lib/utils/entry-point.d.ts +50 -0
- package/dist/lib/utils/entry-point.js +330 -0
- package/dist/lib/utils/fs.d.ts +65 -0
- package/dist/lib/utils/fs.js +372 -0
- package/dist/lib/utils/general.d.ts +4 -0
- package/dist/lib/utils/general.js +25 -0
- package/dist/lib/utils/highlighter.d.ts +9 -0
- package/dist/lib/utils/highlighter.js +150 -0
- package/dist/lib/utils/html-entities.d.ts +8926 -0
- package/dist/lib/utils/html-entities.js +2329 -0
- package/dist/lib/utils/html.d.ts +67 -0
- package/dist/lib/utils/html.js +635 -0
- package/dist/lib/utils/index.d.ts +17 -0
- package/dist/lib/utils/index.js +15 -0
- package/dist/lib/utils/loggers.d.ts +10 -0
- package/dist/lib/utils/loggers.js +71 -0
- package/dist/lib/utils/options/declaration.d.ts +514 -0
- package/dist/lib/utils/options/declaration.js +443 -0
- package/dist/lib/utils/options/defaults.d.ts +20 -0
- package/dist/lib/utils/options/defaults.js +104 -0
- package/dist/lib/utils/options/help.d.ts +7 -0
- package/dist/lib/utils/options/help.js +63 -0
- package/dist/lib/utils/options/index.d.ts +6 -0
- package/dist/lib/utils/options/index.js +4 -0
- package/dist/lib/utils/options/options.d.ts +199 -0
- package/dist/lib/utils/options/options.js +273 -0
- package/dist/lib/utils/options/readers/arguments.d.ts +15 -0
- package/dist/lib/utils/options/readers/arguments.js +109 -0
- package/dist/lib/utils/options/readers/index.d.ts +4 -0
- package/dist/lib/utils/options/readers/index.js +4 -0
- package/dist/lib/utils/options/readers/package-json.d.ts +9 -0
- package/dist/lib/utils/options/readers/package-json.js +40 -0
- package/dist/lib/utils/options/readers/tsconfig.d.ts +14 -0
- package/dist/lib/utils/options/readers/tsconfig.js +172 -0
- package/dist/lib/utils/options/readers/typedoc.d.ts +33 -0
- package/dist/lib/utils/options/readers/typedoc.js +136 -0
- package/dist/lib/utils/options/sources/index.d.ts +1 -0
- package/dist/lib/utils/options/sources/index.js +1 -0
- package/dist/lib/utils/options/sources/typedoc.d.ts +2 -0
- package/dist/lib/utils/options/sources/typedoc.js +876 -0
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +6 -0
- package/dist/lib/utils/options/tsdoc-defaults.js +94 -0
- package/dist/lib/utils/package-manifest.d.ts +11 -0
- package/dist/lib/utils/package-manifest.js +84 -0
- package/dist/lib/utils/paths.d.ts +27 -0
- package/dist/lib/utils/paths.js +127 -0
- package/dist/lib/utils/perf.d.ts +6 -0
- package/dist/lib/utils/perf.js +86 -0
- package/dist/lib/utils/plugins.d.ts +3 -0
- package/dist/lib/utils/plugins.js +61 -0
- package/dist/lib/utils/reflections.d.ts +5 -0
- package/dist/lib/utils/reflections.js +64 -0
- package/dist/lib/utils/sort.d.ts +11 -0
- package/dist/lib/utils/sort.js +153 -0
- package/dist/lib/utils/tsconfig.d.ts +5 -0
- package/dist/lib/utils/tsconfig.js +60 -0
- package/dist/lib/utils/tsutils.d.ts +3 -0
- package/dist/lib/utils/tsutils.js +23 -0
- package/dist/lib/utils-common/array.d.ts +57 -0
- package/dist/lib/utils-common/array.js +152 -0
- package/dist/lib/utils-common/declarationReference.d.ts +42 -0
- package/dist/lib/utils-common/declarationReference.js +341 -0
- package/dist/lib/utils-common/enum.d.ts +9 -0
- package/dist/lib/utils-common/enum.js +27 -0
- package/dist/lib/utils-common/events.d.ts +29 -0
- package/dist/lib/utils-common/events.js +49 -0
- package/dist/lib/utils-common/general.d.ts +40 -0
- package/dist/lib/utils-common/general.js +22 -0
- package/dist/lib/utils-common/hooks.d.ts +51 -0
- package/dist/lib/utils-common/hooks.js +90 -0
- package/dist/lib/utils-common/i18n.d.ts +18 -0
- package/dist/lib/utils-common/i18n.js +39 -0
- package/dist/lib/utils-common/index.d.ts +16 -0
- package/dist/lib/utils-common/index.js +17 -0
- package/dist/lib/utils-common/jsx.d.ts +53 -0
- package/dist/lib/utils-common/jsx.elements.d.ts +949 -0
- package/dist/lib/utils-common/jsx.elements.js +3 -0
- package/dist/lib/utils-common/jsx.js +187 -0
- package/dist/lib/utils-common/logger.d.ts +97 -0
- package/dist/lib/utils-common/logger.js +129 -0
- package/dist/lib/utils-common/map.d.ts +23 -0
- package/dist/lib/utils-common/map.js +63 -0
- package/dist/lib/utils-common/minimalSourceFile.d.ts +12 -0
- package/dist/lib/utils-common/minimalSourceFile.js +43 -0
- package/dist/lib/utils-common/path.d.ts +42 -0
- package/dist/lib/utils-common/path.js +130 -0
- package/dist/lib/utils-common/set.d.ts +3 -0
- package/dist/lib/utils-common/set.js +23 -0
- package/dist/lib/utils-common/string.d.ts +11 -0
- package/dist/lib/utils-common/string.js +84 -0
- package/dist/lib/utils-common/validation.d.ts +33 -0
- package/dist/lib/utils-common/validation.js +50 -0
- package/dist/lib/validation/documentation.d.ts +3 -0
- package/dist/lib/validation/documentation.js +91 -0
- package/dist/lib/validation/exports.d.ts +3 -0
- package/dist/lib/validation/exports.js +65 -0
- package/dist/lib/validation/links.d.ts +3 -0
- package/dist/lib/validation/links.js +78 -0
- package/dist/lib/validation/unusedMergeModuleWith.d.ts +3 -0
- package/dist/lib/validation/unusedMergeModuleWith.js +12 -0
- package/package.json +161 -0
- package/static/main.js +58 -0
- package/static/style.css +1633 -0
- package/tsdoc.json +247 -0
- package/typedoc-config.schema.json +941 -0
|
@@ -0,0 +1,284 @@
|
|
|
1
|
+
import { Comment, Reflection, ReflectionKind, } from "../../../../models/index.js";
|
|
2
|
+
import { assert, i18n, JSX } from "#utils";
|
|
3
|
+
import { classNames, getKindClass } from "../../lib.js";
|
|
4
|
+
import { anchorTargetIfPresent } from "./anchor-icon.js";
|
|
5
|
+
function renderingTypeDetailsIsUseful(container, type, notRenderedTags) {
|
|
6
|
+
const isUsefulVisitor = {
|
|
7
|
+
array(type) {
|
|
8
|
+
return renderingTypeDetailsIsUseful(container, type.elementType, notRenderedTags);
|
|
9
|
+
},
|
|
10
|
+
intersection(type) {
|
|
11
|
+
return type.types.some(t => renderingTypeDetailsIsUseful(container, t, notRenderedTags));
|
|
12
|
+
},
|
|
13
|
+
union(type) {
|
|
14
|
+
return !!type.elementSummaries ||
|
|
15
|
+
type.types.some(t => renderingTypeDetailsIsUseful(container, t, notRenderedTags));
|
|
16
|
+
},
|
|
17
|
+
reflection(type) {
|
|
18
|
+
return renderingChildIsUseful(type.declaration, notRenderedTags);
|
|
19
|
+
},
|
|
20
|
+
reference(type) {
|
|
21
|
+
return shouldExpandReference(container, type);
|
|
22
|
+
},
|
|
23
|
+
};
|
|
24
|
+
return type.visit(isUsefulVisitor) ?? false;
|
|
25
|
+
}
|
|
26
|
+
export function typeDeclaration(context, reflectionOwningType, type) {
|
|
27
|
+
assert(reflectionOwningType instanceof Reflection, "typeDeclaration(reflectionOwningType, type) called incorrectly");
|
|
28
|
+
if (renderingTypeDetailsIsUseful(reflectionOwningType, type, context.options.getValue("notRenderedTags"))) {
|
|
29
|
+
return (JSX.createElement("div", { class: "tsd-type-declaration" },
|
|
30
|
+
JSX.createElement("h4", null, i18n.theme_type_declaration()),
|
|
31
|
+
context.typeDetails(reflectionOwningType, type, true)));
|
|
32
|
+
}
|
|
33
|
+
return null;
|
|
34
|
+
}
|
|
35
|
+
const expandTypeCache = new WeakMap();
|
|
36
|
+
function getExpandTypeInfo(refl) {
|
|
37
|
+
const cache = expandTypeCache.get(refl);
|
|
38
|
+
if (cache)
|
|
39
|
+
return cache;
|
|
40
|
+
const expandType = new Set();
|
|
41
|
+
const preventExpand = new Set();
|
|
42
|
+
if (!refl.isProject()) {
|
|
43
|
+
const info = getExpandTypeInfo(refl.parent);
|
|
44
|
+
for (const item of info.expandType) {
|
|
45
|
+
expandType.add(item);
|
|
46
|
+
}
|
|
47
|
+
for (const item of info.preventExpand) {
|
|
48
|
+
preventExpand.add(item);
|
|
49
|
+
}
|
|
50
|
+
}
|
|
51
|
+
for (const tag of refl.comment?.blockTags || []) {
|
|
52
|
+
if (tag.tag === "@expandType") {
|
|
53
|
+
const name = Comment.combineDisplayParts(tag.content);
|
|
54
|
+
expandType.add(name);
|
|
55
|
+
preventExpand.delete(name);
|
|
56
|
+
}
|
|
57
|
+
else if (tag.tag === "@preventExpand") {
|
|
58
|
+
const name = Comment.combineDisplayParts(tag.content);
|
|
59
|
+
preventExpand.add(name);
|
|
60
|
+
expandType.delete(name);
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
expandTypeCache.set(refl, { expandType, preventExpand });
|
|
64
|
+
return { expandType, preventExpand };
|
|
65
|
+
}
|
|
66
|
+
const expanded = new Set();
|
|
67
|
+
function shouldExpandReference(container, reference) {
|
|
68
|
+
const target = reference.reflection;
|
|
69
|
+
if (!target) {
|
|
70
|
+
// If it doesn't exist, expand only if there are specific properties
|
|
71
|
+
// which the user annotated. Assume they know what they're doing.
|
|
72
|
+
return reference.highlightedProperties !== undefined;
|
|
73
|
+
}
|
|
74
|
+
// Prevent expansion of non-types
|
|
75
|
+
if (!target.kindOf(ReflectionKind.TypeAlias | ReflectionKind.Interface))
|
|
76
|
+
return false;
|
|
77
|
+
// Prevent recursive expand
|
|
78
|
+
if (expanded.has(target))
|
|
79
|
+
return false;
|
|
80
|
+
const info = getExpandTypeInfo(container);
|
|
81
|
+
// Expand if the user explicitly requested it with @param or @expand
|
|
82
|
+
if (reference.highlightedProperties || target.comment?.hasModifier("@expand") || info.expandType.has(target.name)) {
|
|
83
|
+
return !info.preventExpand.has(target.name);
|
|
84
|
+
}
|
|
85
|
+
return false;
|
|
86
|
+
}
|
|
87
|
+
export function typeDetails(context, reflectionOwningType, type, renderAnchors) {
|
|
88
|
+
return typeDetailsImpl(context, reflectionOwningType, type, renderAnchors);
|
|
89
|
+
}
|
|
90
|
+
export function typeDetailsImpl(context, reflectionOwningType, type, renderAnchors, highlighted) {
|
|
91
|
+
const result = type.visit({
|
|
92
|
+
array(type) {
|
|
93
|
+
return context.typeDetails(reflectionOwningType, type.elementType, renderAnchors);
|
|
94
|
+
},
|
|
95
|
+
intersection(type) {
|
|
96
|
+
return type.types.map((t) => context.typeDetails(reflectionOwningType, t, renderAnchors));
|
|
97
|
+
},
|
|
98
|
+
union(type) {
|
|
99
|
+
const result = [];
|
|
100
|
+
for (let i = 0; i < type.types.length; ++i) {
|
|
101
|
+
result.push(JSX.createElement("li", null,
|
|
102
|
+
context.type(type.types[i]),
|
|
103
|
+
context.displayParts(type.elementSummaries?.[i]),
|
|
104
|
+
context.typeDetailsIfUseful(reflectionOwningType, type.types[i])));
|
|
105
|
+
}
|
|
106
|
+
return JSX.createElement("ul", null, result);
|
|
107
|
+
},
|
|
108
|
+
reflection(type) {
|
|
109
|
+
const declaration = type.declaration;
|
|
110
|
+
if (highlighted) {
|
|
111
|
+
return highlightedDeclarationDetails(context, declaration, renderAnchors, highlighted);
|
|
112
|
+
}
|
|
113
|
+
return declarationDetails(context, declaration, renderAnchors);
|
|
114
|
+
},
|
|
115
|
+
reference(reference) {
|
|
116
|
+
if (shouldExpandReference(reflectionOwningType, reference)) {
|
|
117
|
+
const target = reference.reflection;
|
|
118
|
+
if (!target?.isDeclaration()) {
|
|
119
|
+
return highlightedPropertyDetails(context, reference.highlightedProperties);
|
|
120
|
+
}
|
|
121
|
+
// Ensure we don't go into an infinite loop here
|
|
122
|
+
expanded.add(target);
|
|
123
|
+
const details = target.type
|
|
124
|
+
? context.typeDetails(reflectionOwningType, target.type, renderAnchors)
|
|
125
|
+
: declarationDetails(context, target, renderAnchors);
|
|
126
|
+
expanded.delete(target);
|
|
127
|
+
return details;
|
|
128
|
+
}
|
|
129
|
+
},
|
|
130
|
+
// tuple??
|
|
131
|
+
});
|
|
132
|
+
if (!result && highlighted) {
|
|
133
|
+
return highlightedPropertyDetails(context, highlighted);
|
|
134
|
+
}
|
|
135
|
+
return result;
|
|
136
|
+
}
|
|
137
|
+
export function typeDetailsIfUseful(context, reflectionOwningType, type) {
|
|
138
|
+
assert(reflectionOwningType instanceof Reflection, "typeDetailsIfUseful(reflectionOwningType, type) called incorrectly");
|
|
139
|
+
if (type && renderingTypeDetailsIsUseful(reflectionOwningType, type, context.options.getValue("notRenderedTags"))) {
|
|
140
|
+
return context.typeDetails(reflectionOwningType, type, false);
|
|
141
|
+
}
|
|
142
|
+
}
|
|
143
|
+
function highlightedPropertyDetails(context, highlighted) {
|
|
144
|
+
if (!highlighted?.size)
|
|
145
|
+
return;
|
|
146
|
+
return (JSX.createElement("ul", { class: "tsd-parameters" }, Array.from(highlighted.entries(), ([name, parts]) => {
|
|
147
|
+
return (JSX.createElement("li", { class: "tsd-parameter" },
|
|
148
|
+
JSX.createElement("h5", null,
|
|
149
|
+
JSX.createElement("span", null, name)),
|
|
150
|
+
context.displayParts(parts)));
|
|
151
|
+
})));
|
|
152
|
+
}
|
|
153
|
+
function highlightedDeclarationDetails(context, declaration, renderAnchors, highlightedProperties) {
|
|
154
|
+
return (JSX.createElement("ul", { class: "tsd-parameters" }, declaration
|
|
155
|
+
.getProperties()
|
|
156
|
+
?.map((child) => highlightedProperties?.has(child.name) &&
|
|
157
|
+
renderChild(context, child, renderAnchors, highlightedProperties.get(child.name)))));
|
|
158
|
+
}
|
|
159
|
+
function declarationDetails(context, declaration, renderAnchors) {
|
|
160
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
161
|
+
context.commentSummary(declaration),
|
|
162
|
+
JSX.createElement("ul", { class: "tsd-parameters" },
|
|
163
|
+
declaration.signatures && (JSX.createElement("li", { class: "tsd-parameter-signature" },
|
|
164
|
+
JSX.createElement("ul", { class: classNames({ "tsd-signatures": true }, context.getReflectionClasses(declaration)) }, declaration.signatures.map((item) => {
|
|
165
|
+
const anchor = context.router.hasUrl(item) ? context.getAnchor(item) : undefined;
|
|
166
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
167
|
+
JSX.createElement("li", { class: "tsd-signature", id: anchor }, context.memberSignatureTitle(item, {
|
|
168
|
+
hideName: true,
|
|
169
|
+
})),
|
|
170
|
+
JSX.createElement("li", { class: "tsd-description" }, context.memberSignatureBody(item, {
|
|
171
|
+
hideSources: true,
|
|
172
|
+
}))));
|
|
173
|
+
})))),
|
|
174
|
+
declaration.indexSignatures?.map((index) => renderIndexSignature(context, index)),
|
|
175
|
+
declaration.getProperties()?.map((child) => renderChild(context, child, renderAnchors)))));
|
|
176
|
+
}
|
|
177
|
+
function renderChild(context, child, renderAnchors, highlight) {
|
|
178
|
+
if (child.signatures) {
|
|
179
|
+
return (JSX.createElement("li", { class: "tsd-parameter" },
|
|
180
|
+
JSX.createElement("h5", { id: anchorTargetIfPresent(context, child) },
|
|
181
|
+
child.flags.isRest && JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
|
|
182
|
+
JSX.createElement("span", { class: getKindClass(child) }, child.name),
|
|
183
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" },
|
|
184
|
+
child.flags.isOptional && "?",
|
|
185
|
+
":"),
|
|
186
|
+
" function"),
|
|
187
|
+
context.memberSignatures(child)));
|
|
188
|
+
}
|
|
189
|
+
function highlightOrComment(refl) {
|
|
190
|
+
if (highlight) {
|
|
191
|
+
return context.displayParts(highlight);
|
|
192
|
+
}
|
|
193
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
194
|
+
context.commentSummary(refl),
|
|
195
|
+
context.commentTags(refl)));
|
|
196
|
+
}
|
|
197
|
+
// standard type
|
|
198
|
+
if (child.type) {
|
|
199
|
+
const notRenderedTags = context.options.getValue("notRenderedTags");
|
|
200
|
+
return (JSX.createElement("li", { class: "tsd-parameter" },
|
|
201
|
+
JSX.createElement("h5", { id: anchorTargetIfPresent(context, child) },
|
|
202
|
+
context.reflectionFlags(child),
|
|
203
|
+
child.flags.isRest && JSX.createElement("span", { class: "tsd-signature-symbol" }, "..."),
|
|
204
|
+
JSX.createElement("span", { class: getKindClass(child) }, child.name),
|
|
205
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" },
|
|
206
|
+
child.flags.isOptional && "?",
|
|
207
|
+
": "),
|
|
208
|
+
context.type(child.type)),
|
|
209
|
+
highlightOrComment(child),
|
|
210
|
+
child.getProperties().some(prop => renderingChildIsUseful(prop, notRenderedTags)) && (JSX.createElement("ul", { class: "tsd-parameters" }, child.getProperties().map((c) => renderChild(context, c, renderAnchors))))));
|
|
211
|
+
}
|
|
212
|
+
// getter/setter
|
|
213
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
214
|
+
child.getSignature && (JSX.createElement("li", { class: "tsd-parameter" },
|
|
215
|
+
JSX.createElement("h5", { id: anchorTargetIfPresent(context, child) },
|
|
216
|
+
context.reflectionFlags(child.getSignature),
|
|
217
|
+
JSX.createElement("span", { class: "tsd-signature-keyword" }, "get"),
|
|
218
|
+
" ",
|
|
219
|
+
JSX.createElement("span", { class: getKindClass(child) }, child.name),
|
|
220
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, "():"),
|
|
221
|
+
" ",
|
|
222
|
+
context.type(child.getSignature.type)),
|
|
223
|
+
highlightOrComment(child.getSignature))),
|
|
224
|
+
child.setSignature && (JSX.createElement("li", { class: "tsd-parameter" },
|
|
225
|
+
JSX.createElement("h5", { id: !child.getSignature ? anchorTargetIfPresent(context, child) : undefined },
|
|
226
|
+
context.reflectionFlags(child.setSignature),
|
|
227
|
+
JSX.createElement("span", { class: "tsd-signature-keyword" }, "set"),
|
|
228
|
+
" ",
|
|
229
|
+
JSX.createElement("span", { class: getKindClass(child) }, child.name),
|
|
230
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, "("),
|
|
231
|
+
child.setSignature.parameters?.map((item) => (JSX.createElement(JSX.Fragment, null,
|
|
232
|
+
item.name,
|
|
233
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, ":"),
|
|
234
|
+
" ",
|
|
235
|
+
context.type(item.type)))),
|
|
236
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, "):"),
|
|
237
|
+
" ",
|
|
238
|
+
context.type(child.setSignature.type)),
|
|
239
|
+
highlightOrComment(child.setSignature)))));
|
|
240
|
+
}
|
|
241
|
+
function renderIndexSignature(context, index) {
|
|
242
|
+
return (JSX.createElement("li", { class: "tsd-parameter-index-signature" },
|
|
243
|
+
JSX.createElement("h5", null,
|
|
244
|
+
index.flags.isReadonly && (JSX.createElement(JSX.Fragment, null,
|
|
245
|
+
JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly"),
|
|
246
|
+
" ")),
|
|
247
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, "["),
|
|
248
|
+
index.parameters.map((item) => (JSX.createElement(JSX.Fragment, null,
|
|
249
|
+
JSX.createElement("span", { class: getKindClass(item) }, item.name),
|
|
250
|
+
": ",
|
|
251
|
+
context.type(item.type)))),
|
|
252
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, "]:"),
|
|
253
|
+
" ",
|
|
254
|
+
context.type(index.type)),
|
|
255
|
+
context.commentSummary(index),
|
|
256
|
+
context.commentTags(index),
|
|
257
|
+
context.typeDeclaration(index, index.type)));
|
|
258
|
+
}
|
|
259
|
+
function renderingChildIsUseful(refl, notRenderedTags) {
|
|
260
|
+
// Object types directly under a variable/type alias will always be considered useful.
|
|
261
|
+
// This probably isn't ideal, but it is an easy thing to check when assigning URLs
|
|
262
|
+
// in the default theme, so we'll make the assumption that those properties ought to always
|
|
263
|
+
// be rendered.
|
|
264
|
+
// This should be kept in sync with the DefaultTheme.applyAnchorUrl function.
|
|
265
|
+
if (refl.kindOf(ReflectionKind.TypeLiteral) &&
|
|
266
|
+
refl.parent?.kindOf(ReflectionKind.SomeExport) &&
|
|
267
|
+
refl.parent.type?.type === "reflection") {
|
|
268
|
+
return true;
|
|
269
|
+
}
|
|
270
|
+
if (renderingThisChildIsUseful(refl, notRenderedTags)) {
|
|
271
|
+
return true;
|
|
272
|
+
}
|
|
273
|
+
return refl.getProperties().some(prop => renderingThisChildIsUseful(prop, notRenderedTags));
|
|
274
|
+
}
|
|
275
|
+
function renderingThisChildIsUseful(refl, notRenderedTags) {
|
|
276
|
+
if (refl.hasComment(notRenderedTags))
|
|
277
|
+
return true;
|
|
278
|
+
const declaration = refl.type?.type === "reflection" ? refl.type.declaration : refl;
|
|
279
|
+
if (declaration.hasComment(notRenderedTags))
|
|
280
|
+
return true;
|
|
281
|
+
return declaration.getAllSignatures().some((sig) => {
|
|
282
|
+
return sig.hasComment(notRenderedTags) || sig.parameters?.some((p) => p.hasComment(notRenderedTags));
|
|
283
|
+
});
|
|
284
|
+
}
|
|
@@ -0,0 +1,4 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import type { TypeParameterReflection } from "../../../../models/index.js";
|
|
3
|
+
import { JSX } from "#utils";
|
|
4
|
+
export declare function typeParameters(context: DefaultThemeRenderContext, typeParameters: TypeParameterReflection[]): JSX.Element;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { i18n, JSX } from "#utils";
|
|
2
|
+
import { anchorTargetIfPresent } from "./anchor-icon.js";
|
|
3
|
+
export function typeParameters(context, typeParameters) {
|
|
4
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
5
|
+
JSX.createElement("section", { class: "tsd-panel" },
|
|
6
|
+
JSX.createElement("h4", null, i18n.kind_plural_type_parameter()),
|
|
7
|
+
JSX.createElement("ul", { class: "tsd-type-parameter-list" }, typeParameters.map((item) => (JSX.createElement("li", null,
|
|
8
|
+
JSX.createElement("span", { id: anchorTargetIfPresent(context, item) },
|
|
9
|
+
item.flags.isConst && (JSX.createElement(JSX.Fragment, null,
|
|
10
|
+
JSX.createElement("span", { class: "tsd-signature-keyword" }, "const"),
|
|
11
|
+
" ")),
|
|
12
|
+
item.varianceModifier && (JSX.createElement(JSX.Fragment, null,
|
|
13
|
+
JSX.createElement("span", { class: "tsd-signature-keyword" }, item.varianceModifier),
|
|
14
|
+
" ")),
|
|
15
|
+
JSX.createElement("span", { class: "tsd-kind-type-parameter" }, item.name),
|
|
16
|
+
!!item.type && (JSX.createElement(JSX.Fragment, null,
|
|
17
|
+
" ",
|
|
18
|
+
JSX.createElement("span", { class: "tsd-signature-keyword" }, "extends"),
|
|
19
|
+
" ",
|
|
20
|
+
context.type(item.type))),
|
|
21
|
+
!!item.default && (JSX.createElement(JSX.Fragment, null,
|
|
22
|
+
" = ",
|
|
23
|
+
context.type(item.default)))),
|
|
24
|
+
context.commentSummary(item),
|
|
25
|
+
context.commentTags(item))))))));
|
|
26
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import type { DocumentReflection } from "../../../../models/index.js";
|
|
3
|
+
import type { PageEvent } from "../../../events.js";
|
|
4
|
+
import { JSX } from "#utils";
|
|
5
|
+
export declare const documentTemplate: ({ markdown }: DefaultThemeRenderContext, props: PageEvent<DocumentReflection>) => JSX.Element;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import type { PageEvent } from "../../../events.js";
|
|
3
|
+
import { JSX } from "#utils";
|
|
4
|
+
import type { ProjectReflection } from "../../../../models/index.js";
|
|
5
|
+
export declare function hierarchyTemplate(context: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>): JSX.Element;
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import { i18n, JSX } from "#utils";
|
|
2
|
+
import { getHierarchyRoots } from "../../lib.js";
|
|
3
|
+
function fullHierarchy(context, root, seen) {
|
|
4
|
+
if (seen.has(root)) {
|
|
5
|
+
return (JSX.createElement("li", { "data-refl": root.id },
|
|
6
|
+
JSX.createElement("a", { href: context.urlTo(root) },
|
|
7
|
+
context.reflectionIcon(root),
|
|
8
|
+
root.name)));
|
|
9
|
+
}
|
|
10
|
+
seen.add(root);
|
|
11
|
+
const children = [];
|
|
12
|
+
for (const child of [...(root.implementedBy || []), ...(root.extendedBy || [])]) {
|
|
13
|
+
if (child.reflection) {
|
|
14
|
+
children.push(fullHierarchy(context, child.reflection, seen));
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
// Note: We don't use root.anchor for the anchor, because those are built on a per page basis.
|
|
18
|
+
// And classes/interfaces get their own page, so all the anchors will be empty anyways.
|
|
19
|
+
// Full name should be safe here, since this list only includes classes/interfaces.
|
|
20
|
+
return (JSX.createElement("li", { "data-refl": root.id, id: root.getFullName() },
|
|
21
|
+
JSX.createElement("a", { href: context.urlTo(root) },
|
|
22
|
+
context.reflectionIcon(root),
|
|
23
|
+
root.name),
|
|
24
|
+
!!children.length && JSX.createElement("ul", null, children)));
|
|
25
|
+
}
|
|
26
|
+
export function hierarchyTemplate(context, props) {
|
|
27
|
+
const seen = new Set();
|
|
28
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
29
|
+
JSX.createElement("h2", null, i18n.theme_hierarchy_summary()),
|
|
30
|
+
getHierarchyRoots(props.project).map((root) => (JSX.createElement("ul", { class: "tsd-full-hierarchy" }, fullHierarchy(context, root, seen))))));
|
|
31
|
+
}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import type { ProjectReflection } from "../../../../models/index.js";
|
|
3
|
+
import type { PageEvent } from "../../../events.js";
|
|
4
|
+
import { JSX } from "#utils";
|
|
5
|
+
export declare const indexTemplate: ({ markdown }: DefaultThemeRenderContext, props: PageEvent<ProjectReflection>) => JSX.Element;
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../DefaultThemeRenderContext.js";
|
|
2
|
+
import type { PageEvent } from "../../../events.js";
|
|
3
|
+
import { type ContainerReflection } from "../../../../models/index.js";
|
|
4
|
+
import { JSX } from "#utils";
|
|
5
|
+
export declare function reflectionTemplate(context: DefaultThemeRenderContext, props: PageEvent<ContainerReflection>): JSX.Element;
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { classNames, getKindClass, hasTypeParameters } from "../../lib.js";
|
|
2
|
+
import { DeclarationReflection, ReflectionKind, } from "../../../../models/index.js";
|
|
3
|
+
import { i18n, JSX } from "#utils";
|
|
4
|
+
export function reflectionTemplate(context, props) {
|
|
5
|
+
if (props.model.kindOf(ReflectionKind.TypeAlias | ReflectionKind.Variable) &&
|
|
6
|
+
props.model instanceof DeclarationReflection &&
|
|
7
|
+
props.model.type) {
|
|
8
|
+
return context.memberDeclaration(props.model);
|
|
9
|
+
}
|
|
10
|
+
if (props.model.kindOf(ReflectionKind.ExportContainer) &&
|
|
11
|
+
(props.model.isDeclaration() || props.model.isProject())) {
|
|
12
|
+
return context.moduleReflection(props.model);
|
|
13
|
+
}
|
|
14
|
+
return (JSX.createElement(JSX.Fragment, null,
|
|
15
|
+
props.model.hasComment(context.options.getValue("notRenderedTags")) && (JSX.createElement("section", { class: "tsd-panel tsd-comment" },
|
|
16
|
+
context.commentSummary(props.model),
|
|
17
|
+
context.commentTags(props.model))),
|
|
18
|
+
context.reflectionPreview(props.model),
|
|
19
|
+
hasTypeParameters(props.model) && JSX.createElement(JSX.Fragment, null, context.typeParameters(props.model.typeParameters)),
|
|
20
|
+
props.model instanceof DeclarationReflection && (JSX.createElement(JSX.Fragment, null,
|
|
21
|
+
context.hierarchy(props.model.typeHierarchy),
|
|
22
|
+
!!props.model.implementedTypes && (JSX.createElement("section", { class: "tsd-panel" },
|
|
23
|
+
JSX.createElement("h4", null, i18n.theme_implements()),
|
|
24
|
+
JSX.createElement("ul", { class: "tsd-hierarchy" }, props.model.implementedTypes.map((item) => JSX.createElement("li", null, context.type(item)))))),
|
|
25
|
+
!!props.model.implementedBy && (JSX.createElement("section", { class: "tsd-panel" },
|
|
26
|
+
JSX.createElement("h4", null, i18n.theme_implemented_by()),
|
|
27
|
+
JSX.createElement("ul", { class: "tsd-hierarchy" }, props.model.implementedBy.map((item) => JSX.createElement("li", null, context.type(item)))))),
|
|
28
|
+
!!props.model.signatures?.length && (JSX.createElement("section", { class: "tsd-panel" }, context.memberSignatures(props.model))),
|
|
29
|
+
!!props.model.indexSignatures?.length && (JSX.createElement("section", { class: "tsd-panel" },
|
|
30
|
+
JSX.createElement("h4", { class: "tsd-before-signature" }, i18n.theme_indexable()),
|
|
31
|
+
JSX.createElement("ul", { class: "tsd-signatures" }, props.model.indexSignatures.map((index) => renderIndexSignature(context, index))))),
|
|
32
|
+
!props.model.signatures && context.memberSources(props.model))),
|
|
33
|
+
!!props.model.childrenIncludingDocuments?.length && context.index(props.model),
|
|
34
|
+
context.members(props.model)));
|
|
35
|
+
}
|
|
36
|
+
function renderIndexSignature(context, index) {
|
|
37
|
+
return (JSX.createElement("li", { class: classNames({ "tsd-index-signature": true }, context.getReflectionClasses(index)) },
|
|
38
|
+
JSX.createElement("div", { class: "tsd-signature" },
|
|
39
|
+
index.flags.isReadonly && (JSX.createElement(JSX.Fragment, null,
|
|
40
|
+
JSX.createElement("span", { class: "tsd-signature-keyword" }, "readonly"),
|
|
41
|
+
" ")),
|
|
42
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, "["),
|
|
43
|
+
index.parameters.map((item) => (JSX.createElement(JSX.Fragment, null,
|
|
44
|
+
JSX.createElement("span", { class: getKindClass(item) }, item.name),
|
|
45
|
+
": ",
|
|
46
|
+
context.type(item.type)))),
|
|
47
|
+
JSX.createElement("span", { class: "tsd-signature-symbol" }, "]:"),
|
|
48
|
+
" ",
|
|
49
|
+
context.type(index.type)),
|
|
50
|
+
context.commentSummary(index),
|
|
51
|
+
context.commentTags(index),
|
|
52
|
+
context.typeDetailsIfUseful(index, index.type)));
|
|
53
|
+
}
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
import type { DefaultThemeRenderContext } from "../index.js";
|
|
2
|
+
import { type CommentDisplayPart, type ContainerReflection, DeclarationReflection, type DocumentReflection, ProjectReflection, type Reflection, type TypeParameterReflection } from "../../models/index.js";
|
|
3
|
+
import { JSX } from "#utils";
|
|
4
|
+
export declare function stringify(data: unknown): string;
|
|
5
|
+
export declare function getDisplayName(refl: Reflection): string;
|
|
6
|
+
export declare function toStyleClass(str: string): string;
|
|
7
|
+
export declare function getKindClass(refl: Reflection): string;
|
|
8
|
+
/**
|
|
9
|
+
* Insert word break tags ``<wbr>`` into the given string.
|
|
10
|
+
*
|
|
11
|
+
* Breaks the given string at ``_``, ``-`` and capital letters.
|
|
12
|
+
*
|
|
13
|
+
* @param str The string that should be split.
|
|
14
|
+
* @return The original string containing ``<wbr>`` tags where possible.
|
|
15
|
+
*/
|
|
16
|
+
export declare function wbr(str: string): (string | JSX.Element)[];
|
|
17
|
+
export declare function join<T>(joiner: JSX.Children, list: readonly T[], cb: (x: T) => JSX.Children): JSX.Element;
|
|
18
|
+
export declare function classNames(names: Record<string, boolean | null | undefined>, extraCss?: string): string | undefined;
|
|
19
|
+
export declare function hasTypeParameters(reflection: Reflection): reflection is Reflection & {
|
|
20
|
+
typeParameters: TypeParameterReflection[];
|
|
21
|
+
};
|
|
22
|
+
export declare function renderTypeParametersSignature(context: DefaultThemeRenderContext, typeParameters: readonly TypeParameterReflection[] | undefined): JSX.Element;
|
|
23
|
+
/**
|
|
24
|
+
* Renders the reflection name with an additional `?` if optional.
|
|
25
|
+
*/
|
|
26
|
+
export declare function renderName(refl: Reflection): JSX.Element | (string | JSX.Element)[];
|
|
27
|
+
export declare function getHierarchyRoots(project: ProjectReflection): DeclarationReflection[];
|
|
28
|
+
export declare function isNoneSection(section: MemberSection): boolean;
|
|
29
|
+
export interface MemberSection {
|
|
30
|
+
title: string;
|
|
31
|
+
description?: CommentDisplayPart[];
|
|
32
|
+
children: Array<DocumentReflection | DeclarationReflection>;
|
|
33
|
+
}
|
|
34
|
+
export declare function getMemberSections(parent: ContainerReflection, childFilter?: (refl: Reflection) => boolean): MemberSection[];
|
|
35
|
+
/**
|
|
36
|
+
* Returns a (hopefully) globally unique path for the given reflection.
|
|
37
|
+
*
|
|
38
|
+
* This only works for exportable symbols, so e.g. methods are not affected by this.
|
|
39
|
+
*
|
|
40
|
+
* If the given reflection has a globally unique name already, then it will be returned as is. If the name is
|
|
41
|
+
* ambiguous (i.e. there are two classes with the same name in different namespaces), then the namespaces path of the
|
|
42
|
+
* reflection will be returned.
|
|
43
|
+
*/
|
|
44
|
+
export declare function getUniquePath(reflection: Reflection): Reflection[];
|