typedoc 0.27.8 → 0.28.0-beta.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/README.md +26 -26
- package/bin/package.json +1 -1
- 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.d.ts.map +1 -0
- package/dist/browser-utils.js +3 -0
- package/dist/browser-utils.js.map +1 -0
- package/dist/generated/en.d.ts +2 -0
- package/dist/generated/en.js +62 -0
- package/dist/generated/ja.d.ts +2 -0
- package/dist/generated/ja.js +62 -0
- package/dist/generated/ko.d.ts +2 -0
- package/dist/generated/ko.js +62 -0
- package/dist/generated/zh.d.ts +2 -0
- package/dist/generated/zh.js +62 -0
- package/dist/index.d.ts +15 -9
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +13 -7
- package/dist/index.js.map +1 -0
- package/dist/lib/application-events.d.ts.map +1 -0
- package/dist/lib/application-events.js.map +1 -0
- package/dist/lib/application.d.ts +8 -9
- package/dist/lib/application.d.ts.map +1 -0
- package/dist/lib/application.js +69 -56
- package/dist/lib/application.js.map +1 -0
- package/dist/lib/cli.d.ts.map +1 -0
- package/dist/lib/cli.js +4 -3
- package/dist/lib/cli.js.map +1 -0
- package/dist/lib/converter/comments/blockLexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/blockLexer.js +2 -2
- package/dist/lib/converter/comments/blockLexer.js.map +1 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts +1 -1
- package/dist/lib/converter/comments/declarationReferenceResolver.d.ts.map +1 -0
- package/dist/lib/converter/comments/declarationReferenceResolver.js +8 -10
- package/dist/lib/converter/comments/declarationReferenceResolver.js.map +1 -0
- package/dist/lib/converter/comments/discovery.d.ts +1 -1
- package/dist/lib/converter/comments/discovery.d.ts.map +1 -0
- package/dist/lib/converter/comments/discovery.js +3 -4
- package/dist/lib/converter/comments/discovery.js.map +1 -0
- package/dist/lib/converter/comments/index.d.ts +1 -1
- package/dist/lib/converter/comments/index.d.ts.map +1 -0
- package/dist/lib/converter/comments/index.js +5 -7
- package/dist/lib/converter/comments/index.js.map +1 -0
- package/dist/lib/converter/comments/lexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/lexer.js.map +1 -0
- package/dist/lib/converter/comments/lineLexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/lineLexer.js.map +1 -0
- package/dist/lib/converter/comments/linkResolver.d.ts +1 -1
- package/dist/lib/converter/comments/linkResolver.d.ts.map +1 -0
- package/dist/lib/converter/comments/linkResolver.js +10 -16
- package/dist/lib/converter/comments/linkResolver.js.map +1 -0
- package/dist/lib/converter/comments/parser.d.ts +2 -2
- package/dist/lib/converter/comments/parser.d.ts.map +1 -0
- package/dist/lib/converter/comments/parser.js +8 -8
- package/dist/lib/converter/comments/parser.js.map +1 -0
- package/dist/lib/converter/comments/rawLexer.d.ts.map +1 -0
- package/dist/lib/converter/comments/rawLexer.js.map +1 -0
- package/dist/lib/converter/comments/tagName.d.ts.map +1 -0
- package/dist/lib/converter/comments/tagName.js.map +1 -0
- package/dist/lib/converter/comments/textParser.d.ts +3 -2
- package/dist/lib/converter/comments/textParser.d.ts.map +1 -0
- package/dist/lib/converter/comments/textParser.js +1 -2
- package/dist/lib/converter/comments/textParser.js.map +1 -0
- package/dist/lib/converter/components.d.ts.map +1 -0
- package/dist/lib/converter/components.js.map +1 -0
- package/dist/lib/converter/context.d.ts +13 -14
- package/dist/lib/converter/context.d.ts.map +1 -0
- package/dist/lib/converter/context.js +50 -13
- package/dist/lib/converter/context.js.map +1 -0
- package/dist/lib/converter/convert-expression.d.ts.map +1 -0
- package/dist/lib/converter/convert-expression.js.map +1 -0
- package/dist/lib/converter/converter-events.d.ts.map +1 -0
- package/dist/lib/converter/converter-events.js.map +1 -0
- package/dist/lib/converter/converter.d.ts +10 -5
- package/dist/lib/converter/converter.d.ts.map +1 -0
- package/dist/lib/converter/converter.js +59 -42
- package/dist/lib/converter/converter.js.map +1 -0
- package/dist/lib/converter/factories/index-signature.d.ts.map +1 -0
- package/dist/lib/converter/factories/index-signature.js.map +1 -0
- package/dist/lib/converter/factories/signature.d.ts.map +1 -0
- package/dist/lib/converter/factories/signature.js +5 -6
- package/dist/lib/converter/factories/signature.js.map +1 -0
- package/dist/lib/converter/factories/symbol-id.d.ts +4 -0
- package/dist/lib/converter/factories/symbol-id.d.ts.map +1 -0
- package/dist/lib/converter/factories/symbol-id.js +92 -0
- package/dist/lib/converter/factories/symbol-id.js.map +1 -0
- package/dist/lib/converter/factories/types.d.ts +4 -0
- package/dist/lib/converter/factories/types.d.ts.map +1 -0
- package/dist/lib/converter/factories/types.js +13 -0
- package/dist/lib/converter/factories/types.js.map +1 -0
- package/dist/lib/converter/index.d.ts +3 -4
- package/dist/lib/converter/index.d.ts.map +1 -0
- package/dist/lib/converter/index.js +2 -2
- package/dist/lib/converter/index.js.map +1 -0
- package/dist/lib/converter/jsdoc.d.ts.map +1 -0
- package/dist/lib/converter/jsdoc.js +3 -3
- package/dist/lib/converter/jsdoc.js.map +1 -0
- package/dist/lib/converter/plugins/CategoryPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/CategoryPlugin.js +4 -2
- package/dist/lib/converter/plugins/CategoryPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/CommentPlugin.d.ts +0 -1
- package/dist/lib/converter/plugins/CommentPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/CommentPlugin.js +8 -6
- package/dist/lib/converter/plugins/CommentPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/GroupPlugin.d.ts +2 -3
- package/dist/lib/converter/plugins/GroupPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/GroupPlugin.js +8 -7
- package/dist/lib/converter/plugins/GroupPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/ImplementsPlugin.js +6 -8
- package/dist/lib/converter/plugins/ImplementsPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/IncludePlugin.d.ts +1 -1
- package/dist/lib/converter/plugins/IncludePlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/IncludePlugin.js +19 -16
- package/dist/lib/converter/plugins/IncludePlugin.js.map +1 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/InheritDocPlugin.js +7 -9
- package/dist/lib/converter/plugins/InheritDocPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/LinkResolverPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js +3 -2
- package/dist/lib/converter/plugins/MergeModuleWithPlugin.js.map +1 -0
- package/dist/lib/converter/plugins/PackagePlugin.d.ts +3 -2
- package/dist/lib/converter/plugins/PackagePlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/PackagePlugin.js +7 -13
- package/dist/lib/converter/plugins/PackagePlugin.js.map +1 -0
- package/dist/lib/converter/plugins/SourcePlugin.d.ts +2 -1
- package/dist/lib/converter/plugins/SourcePlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/SourcePlugin.js +10 -9
- package/dist/lib/converter/plugins/SourcePlugin.js.map +1 -0
- package/dist/lib/converter/plugins/TypePlugin.d.ts +1 -1
- package/dist/lib/converter/plugins/TypePlugin.d.ts.map +1 -0
- package/dist/lib/converter/plugins/TypePlugin.js +1 -1
- package/dist/lib/converter/plugins/TypePlugin.js.map +1 -0
- package/dist/lib/converter/plugins/index.d.ts +1 -1
- package/dist/lib/converter/plugins/index.d.ts.map +1 -0
- package/dist/lib/converter/plugins/index.js +1 -1
- package/dist/lib/converter/plugins/index.js.map +1 -0
- package/dist/lib/converter/symbols.d.ts.map +1 -0
- package/dist/lib/converter/symbols.js +58 -30
- package/dist/lib/converter/symbols.js.map +1 -0
- package/dist/lib/converter/types.d.ts.map +1 -0
- package/dist/lib/converter/types.js +14 -13
- package/dist/lib/converter/types.js.map +1 -0
- package/dist/lib/converter/utils/nodes.d.ts.map +1 -0
- package/dist/lib/converter/utils/nodes.js.map +1 -0
- package/dist/lib/converter/utils/reflections.d.ts.map +1 -0
- package/dist/lib/converter/utils/reflections.js.map +1 -0
- package/dist/lib/converter/utils/repository.d.ts +1 -1
- package/dist/lib/converter/utils/repository.d.ts.map +1 -0
- package/dist/lib/converter/utils/repository.js +2 -2
- package/dist/lib/converter/utils/repository.js.map +1 -0
- package/dist/lib/converter/utils/symbols.d.ts.map +1 -0
- package/dist/lib/converter/utils/symbols.js.map +1 -0
- package/dist/lib/debug/index.d.ts +2 -2
- package/dist/lib/debug/index.d.ts.map +1 -0
- package/dist/lib/debug/index.js +2 -2
- package/dist/lib/debug/index.js.map +1 -0
- package/dist/lib/debug/{debugReflectionLifetimes.d.ts → reflectionLifetimes.d.ts} +2 -1
- package/dist/lib/debug/reflectionLifetimes.d.ts.map +1 -0
- package/dist/lib/debug/{debugReflectionLifetimes.js → reflectionLifetimes.js} +12 -4
- package/dist/lib/debug/reflectionLifetimes.js.map +1 -0
- package/dist/lib/debug/{debugRendererUrls.d.ts → rendererUrls.d.ts} +1 -0
- package/dist/lib/debug/rendererUrls.d.ts.map +1 -0
- package/dist/lib/debug/rendererUrls.js +68 -0
- package/dist/lib/debug/rendererUrls.js.map +1 -0
- package/dist/lib/internationalization/index.d.ts +2 -1
- package/dist/lib/internationalization/index.d.ts.map +1 -0
- package/dist/lib/internationalization/index.js +2 -1
- package/dist/lib/internationalization/index.js.map +1 -0
- package/dist/lib/internationalization/internationalization.d.ts +16 -46
- package/dist/lib/internationalization/internationalization.d.ts.map +1 -0
- package/dist/lib/internationalization/internationalization.js +44 -213
- package/dist/lib/internationalization/internationalization.js.map +1 -0
- package/dist/lib/internationalization/locale-utils.cjs.map +1 -0
- package/dist/lib/internationalization/locale-utils.d.cts.map +1 -0
- package/dist/lib/internationalization/locales/en.cjs +7 -1
- package/dist/lib/internationalization/locales/en.cjs.map +1 -0
- package/dist/lib/internationalization/locales/en.d.cts +7 -1
- package/dist/lib/internationalization/locales/en.d.cts.map +1 -0
- package/dist/lib/internationalization/locales/ja.cjs +1 -0
- package/dist/lib/internationalization/locales/ja.cjs.map +1 -0
- package/dist/lib/internationalization/locales/ja.d.cts.map +1 -0
- package/dist/lib/internationalization/locales/ko.cjs.map +1 -0
- package/dist/lib/internationalization/locales/ko.d.cts.map +1 -0
- package/dist/lib/internationalization/locales/zh.cjs +53 -2
- package/dist/lib/internationalization/locales/zh.cjs.map +1 -0
- package/dist/lib/internationalization/locales/zh.d.cts +20 -1
- package/dist/lib/internationalization/locales/zh.d.cts.map +1 -0
- package/dist/lib/internationalization/translatable.d.ts +2 -1
- package/dist/lib/internationalization/translatable.d.ts.map +1 -0
- package/dist/lib/internationalization/translatable.js.map +1 -0
- package/dist/lib/models/{comments/comment.d.ts → Comment.d.ts} +9 -8
- package/dist/lib/models/Comment.d.ts.map +1 -0
- package/dist/lib/models/{comments/comment.js → Comment.js} +15 -18
- package/dist/lib/models/Comment.js.map +1 -0
- package/dist/lib/models/{reflections/container.d.ts → ContainerReflection.d.ts} +6 -6
- package/dist/lib/models/ContainerReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/container.js → ContainerReflection.js} +4 -5
- package/dist/lib/models/ContainerReflection.js.map +1 -0
- package/dist/lib/models/{reflections/declaration.d.ts → DeclarationReflection.d.ts} +11 -19
- package/dist/lib/models/DeclarationReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/declaration.js → DeclarationReflection.js} +11 -29
- package/dist/lib/models/DeclarationReflection.js.map +1 -0
- package/dist/lib/models/{reflections/document.d.ts → DocumentReflection.d.ts} +3 -3
- package/dist/lib/models/DocumentReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/document.js → DocumentReflection.js} +3 -3
- package/dist/lib/models/DocumentReflection.js.map +1 -0
- package/dist/lib/models/FileRegistry.d.ts +12 -20
- package/dist/lib/models/FileRegistry.d.ts.map +1 -0
- package/dist/lib/models/FileRegistry.js +8 -44
- package/dist/lib/models/FileRegistry.js.map +1 -0
- package/dist/lib/models/{reflections/parameter.d.ts → ParameterReflection.d.ts} +4 -4
- package/dist/lib/models/ParameterReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/parameter.js → ParameterReflection.js} +2 -2
- package/dist/lib/models/ParameterReflection.js.map +1 -0
- package/dist/lib/models/{reflections/project.d.ts → ProjectReflection.d.ts} +12 -21
- package/dist/lib/models/ProjectReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/project.js → ProjectReflection.js} +16 -48
- package/dist/lib/models/ProjectReflection.js.map +1 -0
- package/dist/lib/models/{reflections/reference.d.ts → ReferenceReflection.d.ts} +3 -3
- package/dist/lib/models/ReferenceReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/reference.js → ReferenceReflection.js} +3 -4
- package/dist/lib/models/ReferenceReflection.js.map +1 -0
- package/dist/lib/models/{reflections/abstract.d.ts → Reflection.d.ts} +15 -28
- package/dist/lib/models/Reflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/abstract.js → Reflection.js} +38 -21
- package/dist/lib/models/Reflection.js.map +1 -0
- package/dist/lib/models/ReflectionCategory.d.ts +2 -6
- package/dist/lib/models/ReflectionCategory.d.ts.map +1 -0
- package/dist/lib/models/ReflectionCategory.js +3 -9
- package/dist/lib/models/ReflectionCategory.js.map +1 -0
- package/dist/lib/models/ReflectionGroup.d.ts +1 -5
- package/dist/lib/models/ReflectionGroup.d.ts.map +1 -0
- package/dist/lib/models/ReflectionGroup.js +2 -8
- package/dist/lib/models/ReflectionGroup.js.map +1 -0
- package/dist/lib/models/{reflections/ReflectionSymbolId.d.ts → ReflectionSymbolId.d.ts} +23 -10
- package/dist/lib/models/ReflectionSymbolId.d.ts.map +1 -0
- package/dist/lib/models/ReflectionSymbolId.js +75 -0
- package/dist/lib/models/ReflectionSymbolId.js.map +1 -0
- package/dist/lib/models/{reflections/signature.d.ts → SignatureReflection.d.ts} +8 -7
- package/dist/lib/models/SignatureReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/signature.js → SignatureReflection.js} +7 -11
- package/dist/lib/models/SignatureReflection.js.map +1 -0
- package/dist/lib/models/{sources/file.d.ts → SourceReference.d.ts} +3 -4
- package/dist/lib/models/SourceReference.d.ts.map +1 -0
- package/dist/lib/models/SourceReference.js.map +1 -0
- package/dist/lib/models/{reflections/type-parameter.d.ts → TypeParameterReflection.d.ts} +6 -5
- package/dist/lib/models/TypeParameterReflection.d.ts.map +1 -0
- package/dist/lib/models/{reflections/type-parameter.js → TypeParameterReflection.js} +4 -1
- package/dist/lib/models/TypeParameterReflection.js.map +1 -0
- package/dist/lib/models/index.d.ts +18 -6
- package/dist/lib/models/index.d.ts.map +1 -0
- package/dist/lib/models/index.js +18 -6
- package/dist/lib/models/index.js.map +1 -0
- package/dist/lib/models/{reflections/kind.d.ts → kind.d.ts} +2 -8
- package/dist/lib/models/kind.d.ts.map +1 -0
- package/dist/lib/models/{reflections/kind.js → kind.js} +99 -30
- package/dist/lib/models/kind.js.map +1 -0
- package/dist/lib/models/types.d.ts +8 -10
- package/dist/lib/models/types.d.ts.map +1 -0
- package/dist/lib/models/types.js +11 -22
- package/dist/lib/models/types.js.map +1 -0
- package/dist/lib/models/utils.d.ts.map +1 -0
- package/dist/lib/models/utils.js.map +1 -0
- package/dist/lib/models/{reflections/variant.d.ts → variant.d.ts} +7 -7
- package/dist/lib/models/variant.d.ts.map +1 -0
- package/dist/lib/models/variant.js.map +1 -0
- package/dist/lib/output/components.d.ts +2 -2
- package/dist/lib/output/components.d.ts.map +1 -0
- package/dist/lib/output/components.js +1 -1
- package/dist/lib/output/components.js.map +1 -0
- package/dist/lib/output/events.d.ts +10 -18
- package/dist/lib/output/events.d.ts.map +1 -0
- package/dist/lib/output/events.js +10 -27
- package/dist/lib/output/events.js.map +1 -0
- package/dist/lib/output/formatter.d.ts +8 -5
- package/dist/lib/output/formatter.d.ts.map +1 -0
- package/dist/lib/output/formatter.js +45 -18
- package/dist/lib/output/formatter.js.map +1 -0
- package/dist/lib/output/index.d.ts +4 -3
- package/dist/lib/output/index.d.ts.map +1 -0
- package/dist/lib/output/index.js +4 -3
- package/dist/lib/output/index.js.map +1 -0
- package/dist/lib/output/models/UrlMapping.d.ts +1 -1
- package/dist/lib/output/models/UrlMapping.d.ts.map +1 -0
- package/dist/lib/output/models/UrlMapping.js.map +1 -0
- package/dist/lib/output/output.d.ts.map +1 -0
- package/dist/lib/output/output.js +5 -4
- package/dist/lib/output/output.js.map +1 -0
- package/dist/lib/output/plugins/AssetsPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/AssetsPlugin.js +7 -6
- package/dist/lib/output/plugins/AssetsPlugin.js.map +1 -0
- package/dist/lib/output/plugins/HierarchyPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/HierarchyPlugin.js +4 -3
- package/dist/lib/output/plugins/HierarchyPlugin.js.map +1 -0
- package/dist/lib/output/plugins/IconsPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/IconsPlugin.js +3 -3
- package/dist/lib/output/plugins/IconsPlugin.js.map +1 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js +12 -17
- package/dist/lib/output/plugins/JavascriptIndexPlugin.js.map +1 -0
- package/dist/lib/output/plugins/NavigationPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/NavigationPlugin.js.map +1 -0
- package/dist/lib/output/plugins/SitemapPlugin.d.ts.map +1 -0
- package/dist/lib/output/plugins/SitemapPlugin.js +6 -7
- package/dist/lib/output/plugins/SitemapPlugin.js.map +1 -0
- package/dist/lib/output/plugins/index.d.ts.map +1 -0
- package/dist/lib/output/plugins/index.js.map +1 -0
- package/dist/lib/output/renderer.d.ts +22 -14
- package/dist/lib/output/renderer.d.ts.map +1 -0
- package/dist/lib/output/renderer.js +76 -36
- package/dist/lib/output/renderer.js.map +1 -0
- package/dist/lib/output/router.d.ts +175 -0
- package/dist/lib/output/router.d.ts.map +1 -0
- package/dist/lib/output/router.js +472 -0
- package/dist/lib/output/router.js.map +1 -0
- package/dist/lib/output/theme.d.ts +3 -28
- package/dist/lib/output/theme.d.ts.map +1 -0
- package/dist/lib/output/theme.js +2 -15
- package/dist/lib/output/theme.js.map +1 -0
- package/dist/lib/output/themes/MarkedPlugin.d.ts +2 -2
- package/dist/lib/output/themes/MarkedPlugin.d.ts.map +1 -0
- package/dist/lib/output/themes/MarkedPlugin.js +31 -29
- package/dist/lib/output/themes/MarkedPlugin.js.map +1 -0
- package/dist/lib/output/themes/default/DefaultTheme.d.ts +7 -40
- package/dist/lib/output/themes/default/DefaultTheme.d.ts.map +1 -0
- package/dist/lib/output/themes/default/DefaultTheme.js +208 -406
- package/dist/lib/output/themes/default/DefaultTheme.js.map +1 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts +49 -47
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.d.ts.map +1 -0
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js +27 -14
- package/dist/lib/output/themes/default/DefaultThemeRenderContext.js.map +1 -0
- package/dist/lib/output/themes/default/Slugger.d.ts.map +1 -0
- package/dist/lib/output/themes/default/Slugger.js +1 -1
- package/dist/lib/output/themes/default/Slugger.js.map +1 -0
- package/dist/lib/output/themes/default/layouts/default.d.ts +1 -1
- package/dist/lib/output/themes/default/layouts/default.d.ts.map +1 -0
- package/dist/lib/output/themes/default/layouts/default.js +6 -6
- package/dist/lib/output/themes/default/layouts/default.js.map +1 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts +4 -1
- package/dist/lib/output/themes/default/partials/anchor-icon.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/anchor-icon.js +12 -2
- package/dist/lib/output/themes/default/partials/anchor-icon.js.map +1 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/breadcrumb.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/breadcrumb.js +11 -5
- package/dist/lib/output/themes/default/partials/breadcrumb.js.map +1 -0
- package/dist/lib/output/themes/default/partials/comment.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/comment.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/comment.js +9 -9
- package/dist/lib/output/themes/default/partials/comment.js.map +1 -0
- package/dist/lib/output/themes/default/partials/footer.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/footer.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/footer.js +2 -2
- package/dist/lib/output/themes/default/partials/footer.js.map +1 -0
- package/dist/lib/output/themes/default/partials/header.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/header.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/header.js +4 -3
- package/dist/lib/output/themes/default/partials/header.js.map +1 -0
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/hierarchy.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/hierarchy.js +10 -8
- package/dist/lib/output/themes/default/partials/hierarchy.js.map +1 -0
- package/dist/lib/output/themes/default/partials/icon.d.ts +2 -3
- package/dist/lib/output/themes/default/partials/icon.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/icon.js +3 -3
- package/dist/lib/output/themes/default/partials/icon.js.map +1 -0
- package/dist/lib/output/themes/default/partials/index.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/index.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/index.js +10 -18
- package/dist/lib/output/themes/default/partials/index.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.declaration.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.declaration.js +2 -2
- package/dist/lib/output/themes/default/partials/member.declaration.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.getterSetter.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.getterSetter.js +5 -5
- package/dist/lib/output/themes/default/partials/member.getterSetter.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.js +10 -9
- package/dist/lib/output/themes/default/partials/member.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.signature.body.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.body.js +4 -4
- package/dist/lib/output/themes/default/partials/member.signature.body.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.signature.title.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signature.title.js +1 -1
- package/dist/lib/output/themes/default/partials/member.signature.title.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.signatures.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.signatures.js +4 -4
- package/dist/lib/output/themes/default/partials/member.signatures.js.map +1 -0
- package/dist/lib/output/themes/default/partials/member.sources.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/member.sources.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/member.sources.js +7 -7
- package/dist/lib/output/themes/default/partials/member.sources.js.map +1 -0
- package/dist/lib/output/themes/default/partials/members.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/members.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/members.js +2 -2
- package/dist/lib/output/themes/default/partials/members.js.map +1 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts +2 -2
- package/dist/lib/output/themes/default/partials/moduleReflection.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/moduleReflection.js +5 -5
- package/dist/lib/output/themes/default/partials/moduleReflection.js.map +1 -0
- package/dist/lib/output/themes/default/partials/navigation.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/navigation.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/navigation.js +17 -15
- package/dist/lib/output/themes/default/partials/navigation.js.map +1 -0
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/reflectionPreview.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/reflectionPreview.js +2 -2
- package/dist/lib/output/themes/default/partials/reflectionPreview.js.map +1 -0
- package/dist/lib/output/themes/default/partials/toolbar.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/toolbar.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/toolbar.js +10 -13
- package/dist/lib/output/themes/default/partials/toolbar.js.map +1 -0
- package/dist/lib/output/themes/default/partials/type.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/type.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/type.js +1 -1
- package/dist/lib/output/themes/default/partials/type.js.map +1 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/typeAndParent.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/typeAndParent.js +3 -3
- package/dist/lib/output/themes/default/partials/typeAndParent.js.map +1 -0
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/typeDetails.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/typeDetails.js +23 -19
- package/dist/lib/output/themes/default/partials/typeDetails.js.map +1 -0
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts +1 -1
- package/dist/lib/output/themes/default/partials/typeParameters.d.ts.map +1 -0
- package/dist/lib/output/themes/default/partials/typeParameters.js +7 -8
- package/dist/lib/output/themes/default/partials/typeParameters.js.map +1 -0
- package/dist/lib/output/themes/default/templates/document.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/document.d.ts.map +1 -0
- package/dist/lib/output/themes/default/templates/document.js +2 -2
- package/dist/lib/output/themes/default/templates/document.js.map +1 -0
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/hierarchy.d.ts.map +1 -0
- package/dist/lib/output/themes/default/templates/hierarchy.js +4 -3
- package/dist/lib/output/themes/default/templates/hierarchy.js.map +1 -0
- package/dist/lib/output/themes/default/templates/index.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/index.d.ts.map +1 -0
- package/dist/lib/output/themes/default/templates/index.js +2 -2
- package/dist/lib/output/themes/default/templates/index.js.map +1 -0
- package/dist/lib/output/themes/default/templates/reflection.d.ts +1 -1
- package/dist/lib/output/themes/default/templates/reflection.d.ts.map +1 -0
- package/dist/lib/output/themes/default/templates/reflection.js +9 -12
- package/dist/lib/output/themes/default/templates/reflection.js.map +1 -0
- package/dist/lib/output/themes/lib.d.ts +1 -1
- package/dist/lib/output/themes/lib.d.ts.map +1 -0
- package/dist/lib/output/themes/lib.js +3 -3
- package/dist/lib/output/themes/lib.js.map +1 -0
- package/dist/lib/serialization/components.d.ts +1 -1
- package/dist/lib/serialization/components.d.ts.map +1 -0
- package/dist/lib/serialization/components.js.map +1 -0
- package/dist/lib/serialization/deserializer.d.ts +9 -13
- package/dist/lib/serialization/deserializer.d.ts.map +1 -0
- package/dist/lib/serialization/deserializer.js +22 -24
- package/dist/lib/serialization/deserializer.js.map +1 -0
- package/dist/lib/serialization/events.d.ts +1 -1
- package/dist/lib/serialization/events.d.ts.map +1 -0
- package/dist/lib/serialization/events.js.map +1 -0
- package/dist/lib/serialization/index.d.ts +1 -1
- package/dist/lib/serialization/index.d.ts.map +1 -0
- package/dist/lib/serialization/index.js +1 -1
- package/dist/lib/serialization/index.js.map +1 -0
- package/dist/lib/serialization/schema.d.ts +15 -10
- package/dist/lib/serialization/schema.d.ts.map +1 -0
- package/dist/lib/serialization/schema.js +1 -1
- package/dist/lib/serialization/schema.js.map +1 -0
- package/dist/lib/serialization/serializer.d.ts +4 -4
- package/dist/lib/serialization/serializer.d.ts.map +1 -0
- package/dist/lib/serialization/serializer.js +1 -2
- package/dist/lib/serialization/serializer.js.map +1 -0
- package/dist/lib/utils/ValidatingFileRegistry.d.ts +10 -0
- package/dist/lib/utils/ValidatingFileRegistry.d.ts.map +1 -0
- package/dist/lib/utils/ValidatingFileRegistry.js +34 -0
- package/dist/lib/utils/ValidatingFileRegistry.js.map +1 -0
- package/dist/lib/utils/component.d.ts +1 -1
- package/dist/lib/utils/component.d.ts.map +1 -0
- package/dist/lib/utils/component.js +1 -1
- package/dist/lib/utils/component.js.map +1 -0
- package/dist/lib/utils/compress.d.ts.map +1 -0
- package/dist/lib/utils/compress.js.map +1 -0
- package/dist/lib/utils/entry-point.d.ts +3 -3
- package/dist/lib/utils/entry-point.d.ts.map +1 -0
- package/dist/lib/utils/entry-point.js +29 -26
- package/dist/lib/utils/entry-point.js.map +1 -0
- package/dist/lib/utils/fs.d.ts +5 -9
- package/dist/lib/utils/fs.d.ts.map +1 -0
- package/dist/lib/utils/fs.js +11 -46
- package/dist/lib/utils/fs.js.map +1 -0
- package/dist/lib/utils/general.d.ts +1 -47
- package/dist/lib/utils/general.d.ts.map +1 -0
- package/dist/lib/utils/general.js +4 -74
- package/dist/lib/utils/general.js.map +1 -0
- package/dist/lib/utils/highlighter.d.ts.map +1 -0
- package/dist/lib/utils/highlighter.js +1 -2
- package/dist/lib/utils/highlighter.js.map +1 -0
- package/dist/lib/utils/html-entities.d.ts.map +1 -0
- package/dist/lib/utils/html-entities.js.map +1 -0
- package/dist/lib/utils/html.d.ts +0 -1
- package/dist/lib/utils/html.d.ts.map +1 -0
- package/dist/lib/utils/html.js +4 -13
- package/dist/lib/utils/html.js.map +1 -0
- package/dist/lib/utils/index.d.ts +9 -17
- package/dist/lib/utils/index.d.ts.map +1 -0
- package/dist/lib/utils/index.js +8 -15
- package/dist/lib/utils/index.js.map +1 -0
- package/dist/lib/utils/loggers.d.ts +5 -108
- package/dist/lib/utils/loggers.d.ts.map +1 -0
- package/dist/lib/utils/loggers.js +24 -168
- package/dist/lib/utils/loggers.js.map +1 -0
- package/dist/lib/utils/options/declaration.d.ts +50 -37
- package/dist/lib/utils/options/declaration.d.ts.map +1 -0
- package/dist/lib/utils/options/declaration.js +56 -66
- package/dist/lib/utils/options/declaration.js.map +1 -0
- package/dist/lib/utils/options/defaults.d.ts +1 -1
- package/dist/lib/utils/options/defaults.d.ts.map +1 -0
- package/dist/lib/utils/options/defaults.js.map +1 -0
- package/dist/lib/utils/options/help.d.ts +1 -2
- package/dist/lib/utils/options/help.d.ts.map +1 -0
- package/dist/lib/utils/options/help.js +5 -5
- package/dist/lib/utils/options/help.js.map +1 -0
- package/dist/lib/utils/options/index.d.ts +4 -4
- package/dist/lib/utils/options/index.d.ts.map +1 -0
- package/dist/lib/utils/options/index.js +3 -3
- package/dist/lib/utils/options/index.js.map +1 -0
- package/dist/lib/utils/options/options.d.ts +3 -6
- package/dist/lib/utils/options/options.d.ts.map +1 -0
- package/dist/lib/utils/options/options.js +10 -12
- package/dist/lib/utils/options/options.js.map +1 -0
- package/dist/lib/utils/options/readers/arguments.d.ts +2 -2
- package/dist/lib/utils/options/readers/arguments.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/arguments.js +4 -3
- package/dist/lib/utils/options/readers/arguments.js.map +1 -0
- package/dist/lib/utils/options/readers/index.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/index.js.map +1 -0
- package/dist/lib/utils/options/readers/package-json.d.ts +1 -1
- package/dist/lib/utils/options/readers/package-json.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/package-json.js +3 -2
- package/dist/lib/utils/options/readers/package-json.js.map +1 -0
- package/dist/lib/utils/options/readers/tsconfig.d.ts +1 -1
- package/dist/lib/utils/options/readers/tsconfig.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/tsconfig.js +27 -27
- package/dist/lib/utils/options/readers/tsconfig.js.map +1 -0
- package/dist/lib/utils/options/readers/typedoc.d.ts +1 -1
- package/dist/lib/utils/options/readers/typedoc.d.ts.map +1 -0
- package/dist/lib/utils/options/readers/typedoc.js +8 -9
- package/dist/lib/utils/options/readers/typedoc.js.map +1 -0
- package/dist/lib/utils/options/sources/index.d.ts.map +1 -0
- package/dist/lib/utils/options/sources/index.js.map +1 -0
- package/dist/lib/utils/options/sources/typedoc.d.ts.map +1 -0
- package/dist/lib/utils/options/sources/typedoc.js +143 -135
- package/dist/lib/utils/options/sources/typedoc.js.map +1 -0
- package/dist/lib/utils/options/tsdoc-defaults.d.ts +1 -1
- package/dist/lib/utils/options/tsdoc-defaults.d.ts.map +1 -0
- package/dist/lib/utils/options/tsdoc-defaults.js +2 -1
- package/dist/lib/utils/options/tsdoc-defaults.js.map +1 -0
- package/dist/lib/utils/package-manifest.d.ts +3 -3
- package/dist/lib/utils/package-manifest.d.ts.map +1 -0
- package/dist/lib/utils/package-manifest.js +9 -8
- package/dist/lib/utils/package-manifest.js.map +1 -0
- package/dist/lib/utils/paths.d.ts +17 -6
- package/dist/lib/utils/paths.d.ts.map +1 -0
- package/dist/lib/utils/paths.js +94 -11
- package/dist/lib/utils/paths.js.map +1 -0
- package/dist/lib/utils/perf.d.ts +4 -1
- package/dist/lib/utils/perf.d.ts.map +1 -0
- package/dist/lib/utils/perf.js +32 -13
- package/dist/lib/utils/perf.js.map +1 -0
- package/dist/lib/utils/plugins.d.ts.map +1 -0
- package/dist/lib/utils/plugins.js +4 -3
- package/dist/lib/utils/plugins.js.map +1 -0
- package/dist/lib/utils/reflections.d.ts.map +1 -0
- package/dist/lib/utils/reflections.js.map +1 -0
- package/dist/lib/utils/sort.d.ts +1 -1
- package/dist/lib/utils/sort.d.ts.map +1 -0
- package/dist/lib/utils/sort.js +8 -3
- package/dist/lib/utils/sort.js.map +1 -0
- package/dist/lib/utils/tsconfig.d.ts +1 -1
- package/dist/lib/utils/tsconfig.d.ts.map +1 -0
- package/dist/lib/utils/tsconfig.js +4 -3
- package/dist/lib/utils/tsconfig.js.map +1 -0
- package/dist/lib/utils/tsutils.d.ts.map +1 -0
- package/dist/lib/utils/tsutils.js.map +1 -0
- package/dist/lib/utils-common/array.d.ts.map +1 -0
- package/dist/lib/utils-common/array.js.map +1 -0
- package/dist/lib/utils-common/declarationReference.d.ts.map +1 -0
- package/dist/lib/utils-common/declarationReference.js.map +1 -0
- package/dist/lib/utils-common/enum.d.ts.map +1 -0
- package/dist/lib/utils-common/enum.js.map +1 -0
- package/dist/lib/utils-common/events.d.ts.map +1 -0
- package/dist/lib/utils-common/events.js.map +1 -0
- package/dist/lib/utils-common/general.d.ts +40 -0
- package/dist/lib/utils-common/general.d.ts.map +1 -0
- package/dist/lib/utils-common/general.js +20 -0
- package/dist/lib/utils-common/general.js.map +1 -0
- package/dist/lib/utils-common/hooks.d.ts.map +1 -0
- package/dist/lib/utils-common/hooks.js.map +1 -0
- package/dist/lib/utils-common/i18n.d.ts +17 -0
- package/dist/lib/utils-common/i18n.d.ts.map +1 -0
- package/dist/lib/utils-common/i18n.js +39 -0
- package/dist/lib/utils-common/i18n.js.map +1 -0
- package/dist/lib/utils-common/index.d.ts +16 -0
- package/dist/lib/utils-common/index.d.ts.map +1 -0
- package/dist/lib/utils-common/index.js +18 -0
- package/dist/lib/utils-common/index.js.map +1 -0
- package/dist/lib/{utils → utils-common}/jsx.d.ts +3 -3
- package/dist/lib/utils-common/jsx.d.ts.map +1 -0
- package/dist/lib/utils-common/jsx.elements.d.ts.map +1 -0
- package/dist/lib/utils-common/jsx.elements.js.map +1 -0
- package/dist/lib/{utils → utils-common}/jsx.js +1 -1
- package/dist/lib/utils-common/jsx.js.map +1 -0
- package/dist/lib/utils-common/logger.d.ts +86 -0
- package/dist/lib/utils-common/logger.d.ts.map +1 -0
- package/dist/lib/utils-common/logger.js +120 -0
- package/dist/lib/utils-common/logger.js.map +1 -0
- package/dist/lib/utils-common/map.d.ts.map +1 -0
- package/dist/lib/utils-common/map.js.map +1 -0
- package/dist/lib/{utils → utils-common}/minimalSourceFile.d.ts +7 -2
- package/dist/lib/utils-common/minimalSourceFile.d.ts.map +1 -0
- package/dist/lib/{utils → utils-common}/minimalSourceFile.js +3 -2
- package/dist/lib/utils-common/minimalSourceFile.js.map +1 -0
- package/dist/lib/utils-common/path.d.ts +35 -0
- package/dist/lib/utils-common/path.d.ts.map +1 -0
- package/dist/lib/utils-common/path.js +123 -0
- package/dist/lib/utils-common/path.js.map +1 -0
- package/dist/lib/utils-common/set.d.ts.map +1 -0
- package/dist/lib/utils-common/set.js.map +1 -0
- package/dist/lib/utils-common/string.d.ts +11 -0
- package/dist/lib/utils-common/string.d.ts.map +1 -0
- package/dist/lib/utils-common/string.js +84 -0
- package/dist/lib/utils-common/string.js.map +1 -0
- package/dist/lib/utils-common/validation.d.ts.map +1 -0
- package/dist/lib/utils-common/validation.js.map +1 -0
- package/dist/lib/validation/documentation.d.ts +2 -2
- package/dist/lib/validation/documentation.d.ts.map +1 -0
- package/dist/lib/validation/documentation.js +5 -6
- package/dist/lib/validation/documentation.js.map +1 -0
- package/dist/lib/validation/exports.d.ts +1 -1
- package/dist/lib/validation/exports.d.ts.map +1 -0
- package/dist/lib/validation/exports.js +4 -4
- package/dist/lib/validation/exports.js.map +1 -0
- package/dist/lib/validation/links.d.ts +1 -1
- package/dist/lib/validation/links.d.ts.map +1 -0
- package/dist/lib/validation/links.js +9 -8
- package/dist/lib/validation/links.js.map +1 -0
- package/dist/lib/validation/unusedMergeModuleWith.d.ts +1 -1
- package/dist/lib/validation/unusedMergeModuleWith.d.ts.map +1 -0
- package/dist/lib/validation/unusedMergeModuleWith.js +3 -2
- package/dist/lib/validation/unusedMergeModuleWith.js.map +1 -0
- package/package.json +59 -38
- package/static/main.js +4 -4
- package/static/style.css +218 -200
- package/tsdoc.json +4 -0
- package/dist/lib/debug/debugRendererUrls.js +0 -59
- package/dist/lib/internationalization/locales/jp.cjs +0 -3
- package/dist/lib/internationalization/locales/jp.d.cts +0 -2
- package/dist/lib/models/comments/index.d.ts +0 -2
- package/dist/lib/models/comments/index.js +0 -1
- package/dist/lib/models/reflections/ReflectionSymbolId.js +0 -133
- package/dist/lib/models/reflections/index.d.ts +0 -15
- package/dist/lib/models/reflections/index.js +0 -12
- package/dist/lib/models/sources/index.d.ts +0 -1
- package/dist/lib/models/sources/index.js +0 -1
- /package/dist/lib/models/{sources/file.js → SourceReference.js} +0 -0
- /package/dist/lib/models/{reflections/utils.d.ts → utils.d.ts} +0 -0
- /package/dist/lib/models/{reflections/utils.js → utils.js} +0 -0
- /package/dist/lib/models/{reflections/variant.js → variant.js} +0 -0
- /package/dist/lib/{utils → utils-common}/array.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/array.js +0 -0
- /package/dist/lib/{converter/comments → utils-common}/declarationReference.d.ts +0 -0
- /package/dist/lib/{converter/comments → utils-common}/declarationReference.js +0 -0
- /package/dist/lib/{utils → utils-common}/enum.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/enum.js +0 -0
- /package/dist/lib/{utils → utils-common}/events.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/events.js +0 -0
- /package/dist/lib/{utils → utils-common}/hooks.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/hooks.js +0 -0
- /package/dist/lib/{utils → utils-common}/jsx.elements.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/jsx.elements.js +0 -0
- /package/dist/lib/{utils → utils-common}/map.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/map.js +0 -0
- /package/dist/lib/{utils → utils-common}/set.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/set.js +0 -0
- /package/dist/lib/{utils → utils-common}/validation.d.ts +0 -0
- /package/dist/lib/{utils → utils-common}/validation.js +0 -0
|
@@ -1,17 +1,14 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import { ParameterType, ParameterHint, EmitStrategy, CommentStyle, } from "../declaration.js";
|
|
1
|
+
import { CommentStyle, EmitStrategy, ParameterHint, ParameterType } from "../declaration.js";
|
|
3
2
|
import * as OptionDefaults from "../defaults.js";
|
|
4
3
|
import { SORT_STRATEGIES } from "../../sort.js";
|
|
5
4
|
import { EntryPointStrategy } from "../../entry-point.js";
|
|
6
|
-
import { ReflectionKind } from "../../../models/
|
|
7
|
-
import * as Validation from "../../validation.js";
|
|
5
|
+
import { ReflectionKind } from "../../../models/kind.js";
|
|
8
6
|
import { blockTags, inlineTags, modifierTags } from "../tsdoc-defaults.js";
|
|
9
|
-
import { getEnumKeys } from "
|
|
10
|
-
import { getSupportedLanguages, getSupportedThemes
|
|
11
|
-
import { setDifference } from "../../set.js";
|
|
7
|
+
import { getEnumKeys, i18n, LogLevel, setDifference, Validation } from "#utils";
|
|
8
|
+
import { getSupportedLanguages, getSupportedThemes } from "../../highlighter.js";
|
|
12
9
|
import { extname } from "path";
|
|
13
10
|
function makeTagArrayValidator(name) {
|
|
14
|
-
return (value
|
|
11
|
+
return (value) => {
|
|
15
12
|
if (!Validation.validate([Array, Validation.isTagString], value)) {
|
|
16
13
|
throw new Error(i18n.option_0_values_must_be_array_of_tags(name));
|
|
17
14
|
}
|
|
@@ -25,23 +22,23 @@ export function addTypeDocOptions(options) {
|
|
|
25
22
|
options.addDeclaration({
|
|
26
23
|
type: ParameterType.Path,
|
|
27
24
|
name: "options",
|
|
28
|
-
help: (
|
|
25
|
+
help: () => i18n.help_options(),
|
|
29
26
|
hint: ParameterHint.File,
|
|
30
27
|
defaultValue: "",
|
|
31
28
|
});
|
|
32
29
|
options.addDeclaration({
|
|
33
30
|
type: ParameterType.Path,
|
|
34
31
|
name: "tsconfig",
|
|
35
|
-
help: (
|
|
32
|
+
help: () => i18n.help_tsconfig(),
|
|
36
33
|
hint: ParameterHint.File,
|
|
37
34
|
defaultValue: "",
|
|
38
35
|
});
|
|
39
36
|
options.addDeclaration({
|
|
40
37
|
name: "compilerOptions",
|
|
41
|
-
help: (
|
|
38
|
+
help: () => i18n.help_compilerOptions(),
|
|
42
39
|
type: ParameterType.Mixed,
|
|
43
40
|
configFileOnly: true,
|
|
44
|
-
validate(value
|
|
41
|
+
validate(value) {
|
|
45
42
|
if (!Validation.validate({}, value)) {
|
|
46
43
|
throw new Error(i18n.option_0_must_be_an_object("compilerOptions"));
|
|
47
44
|
}
|
|
@@ -49,17 +46,17 @@ export function addTypeDocOptions(options) {
|
|
|
49
46
|
});
|
|
50
47
|
options.addDeclaration({
|
|
51
48
|
name: "lang",
|
|
52
|
-
help: (
|
|
49
|
+
help: () => i18n.help_lang(),
|
|
53
50
|
type: ParameterType.String,
|
|
54
51
|
defaultValue: "en",
|
|
55
52
|
});
|
|
56
53
|
options.addDeclaration({
|
|
57
54
|
name: "locales",
|
|
58
|
-
help: (
|
|
55
|
+
help: () => i18n.help_locales(),
|
|
59
56
|
type: ParameterType.Mixed,
|
|
60
57
|
configFileOnly: true,
|
|
61
58
|
defaultValue: {},
|
|
62
|
-
validate(value
|
|
59
|
+
validate(value) {
|
|
63
60
|
if (typeof value !== "object" || !value) {
|
|
64
61
|
throw new Error(i18n.locales_must_be_an_object());
|
|
65
62
|
}
|
|
@@ -77,11 +74,11 @@ export function addTypeDocOptions(options) {
|
|
|
77
74
|
});
|
|
78
75
|
options.addDeclaration({
|
|
79
76
|
name: "packageOptions",
|
|
80
|
-
help: (
|
|
77
|
+
help: () => i18n.help_packageOptions(),
|
|
81
78
|
type: ParameterType.Mixed,
|
|
82
79
|
configFileOnly: true,
|
|
83
80
|
defaultValue: {},
|
|
84
|
-
validate(value
|
|
81
|
+
validate(value) {
|
|
85
82
|
if (!Validation.validate({}, value)) {
|
|
86
83
|
throw new Error(i18n.option_0_must_be_an_object("packageOptions"));
|
|
87
84
|
}
|
|
@@ -92,52 +89,52 @@ export function addTypeDocOptions(options) {
|
|
|
92
89
|
///////////////////////////
|
|
93
90
|
options.addDeclaration({
|
|
94
91
|
name: "entryPoints",
|
|
95
|
-
help: (
|
|
92
|
+
help: () => i18n.help_entryPoints(),
|
|
96
93
|
type: ParameterType.GlobArray,
|
|
97
94
|
});
|
|
98
95
|
options.addDeclaration({
|
|
99
96
|
name: "entryPointStrategy",
|
|
100
|
-
help: (
|
|
97
|
+
help: () => i18n.help_entryPointStrategy(),
|
|
101
98
|
type: ParameterType.Map,
|
|
102
99
|
map: EntryPointStrategy,
|
|
103
100
|
defaultValue: EntryPointStrategy.Resolve,
|
|
104
101
|
});
|
|
105
102
|
options.addDeclaration({
|
|
106
103
|
name: "alwaysCreateEntryPointModule",
|
|
107
|
-
help: (
|
|
104
|
+
help: () => i18n.help_alwaysCreateEntryPointModule(),
|
|
108
105
|
type: ParameterType.Boolean,
|
|
109
106
|
});
|
|
110
107
|
options.addDeclaration({
|
|
111
108
|
name: "projectDocuments",
|
|
112
|
-
help: (
|
|
109
|
+
help: () => i18n.help_projectDocuments(),
|
|
113
110
|
type: ParameterType.GlobArray,
|
|
114
111
|
});
|
|
115
112
|
options.addDeclaration({
|
|
116
113
|
name: "exclude",
|
|
117
|
-
help: (
|
|
114
|
+
help: () => i18n.help_exclude(),
|
|
118
115
|
type: ParameterType.GlobArray,
|
|
119
116
|
});
|
|
120
117
|
options.addDeclaration({
|
|
121
118
|
name: "externalPattern",
|
|
122
|
-
help: (
|
|
119
|
+
help: () => i18n.help_externalPattern(),
|
|
123
120
|
type: ParameterType.GlobArray,
|
|
124
121
|
defaultValue: ["**/node_modules/**"],
|
|
125
122
|
});
|
|
126
123
|
options.addDeclaration({
|
|
127
124
|
name: "excludeExternals",
|
|
128
|
-
help: (
|
|
125
|
+
help: () => i18n.help_excludeExternals(),
|
|
129
126
|
type: ParameterType.Boolean,
|
|
130
127
|
});
|
|
131
128
|
options.addDeclaration({
|
|
132
129
|
name: "excludeNotDocumented",
|
|
133
|
-
help: (
|
|
130
|
+
help: () => i18n.help_excludeNotDocumented(),
|
|
134
131
|
type: ParameterType.Boolean,
|
|
135
132
|
});
|
|
136
133
|
options.addDeclaration({
|
|
137
134
|
name: "excludeNotDocumentedKinds",
|
|
138
|
-
help: (
|
|
135
|
+
help: () => i18n.help_excludeNotDocumentedKinds(),
|
|
139
136
|
type: ParameterType.Array,
|
|
140
|
-
validate(value
|
|
137
|
+
validate(value) {
|
|
141
138
|
const invalid = new Set(value);
|
|
142
139
|
const valid = new Set(getEnumKeys(ReflectionKind));
|
|
143
140
|
for (const notPermitted of [
|
|
@@ -159,37 +156,37 @@ export function addTypeDocOptions(options) {
|
|
|
159
156
|
});
|
|
160
157
|
options.addDeclaration({
|
|
161
158
|
name: "excludeInternal",
|
|
162
|
-
help: (
|
|
159
|
+
help: () => i18n.help_excludeInternal(),
|
|
163
160
|
type: ParameterType.Boolean,
|
|
164
161
|
});
|
|
165
162
|
options.addDeclaration({
|
|
166
163
|
name: "excludeCategories",
|
|
167
|
-
help: (
|
|
164
|
+
help: () => i18n.help_excludeCategories(),
|
|
168
165
|
type: ParameterType.Array,
|
|
169
166
|
defaultValue: [],
|
|
170
167
|
});
|
|
171
168
|
options.addDeclaration({
|
|
172
169
|
name: "excludePrivate",
|
|
173
|
-
help: (
|
|
170
|
+
help: () => i18n.help_excludePrivate(),
|
|
174
171
|
type: ParameterType.Boolean,
|
|
175
172
|
defaultValue: true,
|
|
176
173
|
});
|
|
177
174
|
options.addDeclaration({
|
|
178
175
|
name: "excludeProtected",
|
|
179
|
-
help: (
|
|
176
|
+
help: () => i18n.help_excludeProtected(),
|
|
180
177
|
type: ParameterType.Boolean,
|
|
181
178
|
});
|
|
182
179
|
options.addDeclaration({
|
|
183
180
|
name: "excludeReferences",
|
|
184
|
-
help: (
|
|
181
|
+
help: () => i18n.help_excludeReferences(),
|
|
185
182
|
type: ParameterType.Boolean,
|
|
186
183
|
});
|
|
187
184
|
options.addDeclaration({
|
|
188
185
|
name: "externalSymbolLinkMappings",
|
|
189
|
-
help: (
|
|
186
|
+
help: () => i18n.help_externalSymbolLinkMappings(),
|
|
190
187
|
type: ParameterType.Mixed,
|
|
191
188
|
defaultValue: {},
|
|
192
|
-
validate(value
|
|
189
|
+
validate(value) {
|
|
193
190
|
if (!Validation.validate({}, value)) {
|
|
194
191
|
throw new Error(i18n.external_symbol_link_mappings_must_be_object());
|
|
195
192
|
}
|
|
@@ -210,11 +207,11 @@ export function addTypeDocOptions(options) {
|
|
|
210
207
|
///////////////////////////
|
|
211
208
|
options.addDeclaration({
|
|
212
209
|
name: "outputs",
|
|
213
|
-
help: (
|
|
210
|
+
help: () => i18n.help_out(),
|
|
214
211
|
type: ParameterType.Mixed,
|
|
215
212
|
configFileOnly: true,
|
|
216
213
|
defaultValue: undefined,
|
|
217
|
-
validate(value
|
|
214
|
+
validate(value) {
|
|
218
215
|
if (!Validation.validate([
|
|
219
216
|
Array,
|
|
220
217
|
{
|
|
@@ -231,7 +228,7 @@ export function addTypeDocOptions(options) {
|
|
|
231
228
|
});
|
|
232
229
|
options.addDeclaration({
|
|
233
230
|
name: "out",
|
|
234
|
-
help: (
|
|
231
|
+
help: () => i18n.help_out(),
|
|
235
232
|
type: ParameterType.Path,
|
|
236
233
|
hint: ParameterHint.Directory,
|
|
237
234
|
defaultValue: "./docs",
|
|
@@ -239,44 +236,50 @@ export function addTypeDocOptions(options) {
|
|
|
239
236
|
options.addDeclaration({
|
|
240
237
|
name: "html",
|
|
241
238
|
outputShortcut: "html",
|
|
242
|
-
help: (
|
|
239
|
+
help: () => i18n.help_html(),
|
|
243
240
|
type: ParameterType.Path,
|
|
244
241
|
hint: ParameterHint.Directory,
|
|
245
242
|
});
|
|
246
243
|
options.addDeclaration({
|
|
247
244
|
name: "json",
|
|
248
245
|
outputShortcut: "json",
|
|
249
|
-
help: (
|
|
246
|
+
help: () => i18n.help_json(),
|
|
250
247
|
type: ParameterType.Path,
|
|
251
248
|
hint: ParameterHint.File,
|
|
252
249
|
});
|
|
253
250
|
options.addDeclaration({
|
|
254
251
|
name: "pretty",
|
|
255
|
-
help: (
|
|
252
|
+
help: () => i18n.help_pretty(),
|
|
256
253
|
type: ParameterType.Boolean,
|
|
257
254
|
defaultValue: true,
|
|
258
255
|
});
|
|
259
256
|
options.addDeclaration({
|
|
260
257
|
name: "emit",
|
|
261
|
-
help: (
|
|
258
|
+
help: () => i18n.help_emit(),
|
|
262
259
|
type: ParameterType.Map,
|
|
263
260
|
map: EmitStrategy,
|
|
264
261
|
defaultValue: "docs",
|
|
265
262
|
});
|
|
266
263
|
options.addDeclaration({
|
|
267
264
|
name: "theme",
|
|
268
|
-
help: (
|
|
265
|
+
help: () => i18n.help_theme(),
|
|
269
266
|
type: ParameterType.String,
|
|
270
267
|
defaultValue: "default",
|
|
271
268
|
});
|
|
269
|
+
options.addDeclaration({
|
|
270
|
+
name: "router",
|
|
271
|
+
help: () => i18n.help_router(),
|
|
272
|
+
type: ParameterType.String,
|
|
273
|
+
defaultValue: "kind",
|
|
274
|
+
});
|
|
272
275
|
const defaultLightTheme = "light-plus";
|
|
273
276
|
const defaultDarkTheme = "dark-plus";
|
|
274
277
|
options.addDeclaration({
|
|
275
278
|
name: "lightHighlightTheme",
|
|
276
|
-
help: (
|
|
279
|
+
help: () => i18n.help_lightHighlightTheme(),
|
|
277
280
|
type: ParameterType.String,
|
|
278
281
|
defaultValue: defaultLightTheme,
|
|
279
|
-
validate(value
|
|
282
|
+
validate(value) {
|
|
280
283
|
if (!getSupportedThemes().includes(value)) {
|
|
281
284
|
throw new Error(i18n.highlight_theme_0_must_be_one_of_1("lightHighlightTheme", getSupportedThemes().join(", ")));
|
|
282
285
|
}
|
|
@@ -284,10 +287,10 @@ export function addTypeDocOptions(options) {
|
|
|
284
287
|
});
|
|
285
288
|
options.addDeclaration({
|
|
286
289
|
name: "darkHighlightTheme",
|
|
287
|
-
help: (
|
|
290
|
+
help: () => i18n.help_darkHighlightTheme(),
|
|
288
291
|
type: ParameterType.String,
|
|
289
292
|
defaultValue: defaultDarkTheme,
|
|
290
|
-
validate(value
|
|
293
|
+
validate(value) {
|
|
291
294
|
if (!getSupportedThemes().includes(value)) {
|
|
292
295
|
throw new Error(i18n.highlight_theme_0_must_be_one_of_1("darkHighlightTheme", getSupportedThemes().join(", ")));
|
|
293
296
|
}
|
|
@@ -295,10 +298,10 @@ export function addTypeDocOptions(options) {
|
|
|
295
298
|
});
|
|
296
299
|
options.addDeclaration({
|
|
297
300
|
name: "highlightLanguages",
|
|
298
|
-
help: (
|
|
301
|
+
help: () => i18n.help_highlightLanguages(),
|
|
299
302
|
type: ParameterType.Array,
|
|
300
303
|
defaultValue: OptionDefaults.highlightLanguages,
|
|
301
|
-
validate(value
|
|
304
|
+
validate(value) {
|
|
302
305
|
const invalid = setDifference(value, getSupportedLanguages());
|
|
303
306
|
if (invalid.size) {
|
|
304
307
|
throw new Error(i18n.highlightLanguages_contains_invalid_languages_0(Array.from(invalid).join(", ")));
|
|
@@ -307,36 +310,36 @@ export function addTypeDocOptions(options) {
|
|
|
307
310
|
});
|
|
308
311
|
options.addDeclaration({
|
|
309
312
|
name: "ignoredHighlightLanguages",
|
|
310
|
-
help: (
|
|
313
|
+
help: () => i18n.help_ignoredHighlightLanguages(),
|
|
311
314
|
type: ParameterType.Array,
|
|
312
315
|
defaultValue: OptionDefaults.ignoredHighlightLanguages,
|
|
313
316
|
});
|
|
314
317
|
options.addDeclaration({
|
|
315
318
|
name: "typePrintWidth",
|
|
316
|
-
help: (
|
|
319
|
+
help: () => i18n.help_typePrintWidth(),
|
|
317
320
|
type: ParameterType.Number,
|
|
318
321
|
defaultValue: 80,
|
|
319
322
|
});
|
|
320
323
|
options.addDeclaration({
|
|
321
324
|
name: "customCss",
|
|
322
|
-
help: (
|
|
325
|
+
help: () => i18n.help_customCss(),
|
|
323
326
|
type: ParameterType.Path,
|
|
324
327
|
});
|
|
325
328
|
options.addDeclaration({
|
|
326
329
|
name: "customJs",
|
|
327
|
-
help: (
|
|
330
|
+
help: () => i18n.help_customJs(),
|
|
328
331
|
type: ParameterType.Path,
|
|
329
332
|
});
|
|
330
333
|
options.addDeclaration({
|
|
331
334
|
name: "markdownItOptions",
|
|
332
|
-
help: (
|
|
335
|
+
help: () => i18n.help_markdownItOptions(),
|
|
333
336
|
type: ParameterType.Mixed,
|
|
334
337
|
configFileOnly: true,
|
|
335
338
|
defaultValue: {
|
|
336
339
|
html: true,
|
|
337
340
|
linkify: true,
|
|
338
341
|
},
|
|
339
|
-
validate(value
|
|
342
|
+
validate(value) {
|
|
340
343
|
if (!Validation.validate({}, value)) {
|
|
341
344
|
throw new Error(i18n.option_0_must_be_an_object("markdownItOptions"));
|
|
342
345
|
}
|
|
@@ -344,11 +347,11 @@ export function addTypeDocOptions(options) {
|
|
|
344
347
|
});
|
|
345
348
|
options.addDeclaration({
|
|
346
349
|
name: "markdownItLoader",
|
|
347
|
-
help: (
|
|
350
|
+
help: () => i18n.help_markdownItLoader(),
|
|
348
351
|
type: ParameterType.Mixed,
|
|
349
352
|
configFileOnly: true,
|
|
350
353
|
defaultValue: () => { },
|
|
351
|
-
validate(value
|
|
354
|
+
validate(value) {
|
|
352
355
|
if (typeof value !== "function") {
|
|
353
356
|
throw new Error(i18n.option_0_must_be_a_function("markdownItLoader"));
|
|
354
357
|
}
|
|
@@ -356,60 +359,60 @@ export function addTypeDocOptions(options) {
|
|
|
356
359
|
});
|
|
357
360
|
options.addDeclaration({
|
|
358
361
|
name: "maxTypeConversionDepth",
|
|
359
|
-
help: (
|
|
362
|
+
help: () => i18n.help_maxTypeConversionDepth(),
|
|
360
363
|
defaultValue: 10,
|
|
361
364
|
type: ParameterType.Number,
|
|
362
365
|
});
|
|
363
366
|
options.addDeclaration({
|
|
364
367
|
name: "name",
|
|
365
|
-
help: (
|
|
368
|
+
help: () => i18n.help_name(),
|
|
366
369
|
});
|
|
367
370
|
options.addDeclaration({
|
|
368
371
|
name: "includeVersion",
|
|
369
|
-
help: (
|
|
372
|
+
help: () => i18n.help_includeVersion(),
|
|
370
373
|
type: ParameterType.Boolean,
|
|
371
374
|
});
|
|
372
375
|
options.addDeclaration({
|
|
373
376
|
name: "disableSources",
|
|
374
|
-
help: (
|
|
377
|
+
help: () => i18n.help_disableSources(),
|
|
375
378
|
type: ParameterType.Boolean,
|
|
376
379
|
});
|
|
377
380
|
options.addDeclaration({
|
|
378
381
|
name: "sourceLinkTemplate",
|
|
379
|
-
help: (
|
|
382
|
+
help: () => i18n.help_sourceLinkTemplate(),
|
|
380
383
|
});
|
|
381
384
|
options.addDeclaration({
|
|
382
385
|
name: "gitRevision",
|
|
383
|
-
help: (
|
|
386
|
+
help: () => i18n.help_gitRevision(),
|
|
384
387
|
});
|
|
385
388
|
options.addDeclaration({
|
|
386
389
|
name: "gitRemote",
|
|
387
|
-
help: (
|
|
390
|
+
help: () => i18n.help_gitRemote(),
|
|
388
391
|
defaultValue: "origin",
|
|
389
392
|
});
|
|
390
393
|
options.addDeclaration({
|
|
391
394
|
name: "disableGit",
|
|
392
|
-
help: (
|
|
395
|
+
help: () => i18n.help_disableGit(),
|
|
393
396
|
type: ParameterType.Boolean,
|
|
394
397
|
});
|
|
395
398
|
options.addDeclaration({
|
|
396
399
|
name: "basePath",
|
|
397
|
-
help: (
|
|
400
|
+
help: () => i18n.help_basePath(),
|
|
398
401
|
type: ParameterType.Path,
|
|
399
402
|
});
|
|
400
403
|
options.addDeclaration({
|
|
401
404
|
name: "readme",
|
|
402
|
-
help: (
|
|
405
|
+
help: () => i18n.help_readme(),
|
|
403
406
|
type: ParameterType.Path,
|
|
404
407
|
});
|
|
405
408
|
options.addDeclaration({
|
|
406
409
|
name: "cname",
|
|
407
|
-
help: (
|
|
410
|
+
help: () => i18n.help_cname(),
|
|
408
411
|
});
|
|
409
412
|
options.addDeclaration({
|
|
410
413
|
name: "favicon",
|
|
411
|
-
help: (
|
|
412
|
-
validate(value
|
|
414
|
+
help: () => i18n.help_favicon(),
|
|
415
|
+
validate(value) {
|
|
413
416
|
const allowedExtension = [".ico", ".png", ".svg"];
|
|
414
417
|
if (!/^https?:\/\//i.test(value) &&
|
|
415
418
|
!allowedExtension.includes(extname(value))) {
|
|
@@ -420,25 +423,25 @@ export function addTypeDocOptions(options) {
|
|
|
420
423
|
});
|
|
421
424
|
options.addDeclaration({
|
|
422
425
|
name: "sourceLinkExternal",
|
|
423
|
-
help: (
|
|
426
|
+
help: () => i18n.help_sourceLinkExternal(),
|
|
424
427
|
type: ParameterType.Boolean,
|
|
425
428
|
});
|
|
426
429
|
options.addDeclaration({
|
|
427
430
|
name: "markdownLinkExternal",
|
|
428
|
-
help: (
|
|
431
|
+
help: () => i18n.help_markdownLinkExternal(),
|
|
429
432
|
type: ParameterType.Boolean,
|
|
430
433
|
defaultValue: true,
|
|
431
434
|
});
|
|
432
435
|
options.addDeclaration({
|
|
433
436
|
name: "githubPages",
|
|
434
|
-
help: (
|
|
437
|
+
help: () => i18n.help_githubPages(),
|
|
435
438
|
type: ParameterType.Boolean,
|
|
436
439
|
defaultValue: true,
|
|
437
440
|
});
|
|
438
441
|
options.addDeclaration({
|
|
439
442
|
name: "hostedBaseUrl",
|
|
440
|
-
help: (
|
|
441
|
-
validate(value
|
|
443
|
+
help: () => i18n.help_hostedBaseUrl(),
|
|
444
|
+
validate(value) {
|
|
442
445
|
if (!/^https?:\/\//i.test(value)) {
|
|
443
446
|
throw new Error(i18n.hostedBaseUrl_must_start_with_http());
|
|
444
447
|
}
|
|
@@ -446,56 +449,56 @@ export function addTypeDocOptions(options) {
|
|
|
446
449
|
});
|
|
447
450
|
options.addDeclaration({
|
|
448
451
|
name: "useHostedBaseUrlForAbsoluteLinks",
|
|
449
|
-
help: (
|
|
452
|
+
help: () => i18n.help_useHostedBaseUrlForAbsoluteLinks(),
|
|
450
453
|
type: ParameterType.Boolean,
|
|
451
454
|
});
|
|
452
455
|
options.addDeclaration({
|
|
453
456
|
name: "hideGenerator",
|
|
454
|
-
help: (
|
|
457
|
+
help: () => i18n.help_hideGenerator(),
|
|
455
458
|
type: ParameterType.Boolean,
|
|
456
459
|
});
|
|
457
460
|
options.addDeclaration({
|
|
458
461
|
name: "customFooterHtml",
|
|
459
|
-
help: (
|
|
462
|
+
help: () => i18n.help_customFooterHtml(),
|
|
460
463
|
type: ParameterType.String,
|
|
461
464
|
});
|
|
462
465
|
options.addDeclaration({
|
|
463
466
|
name: "customFooterHtmlDisableWrapper",
|
|
464
|
-
help: (
|
|
467
|
+
help: () => i18n.help_customFooterHtmlDisableWrapper(),
|
|
465
468
|
type: ParameterType.Boolean,
|
|
466
469
|
});
|
|
467
470
|
options.addDeclaration({
|
|
468
471
|
name: "cacheBust",
|
|
469
|
-
help: (
|
|
472
|
+
help: () => i18n.help_cacheBust(),
|
|
470
473
|
type: ParameterType.Boolean,
|
|
471
474
|
});
|
|
472
475
|
options.addDeclaration({
|
|
473
476
|
name: "searchInComments",
|
|
474
|
-
help: (
|
|
477
|
+
help: () => i18n.help_searchInComments(),
|
|
475
478
|
type: ParameterType.Boolean,
|
|
476
479
|
});
|
|
477
480
|
options.addDeclaration({
|
|
478
481
|
name: "searchInDocuments",
|
|
479
|
-
help: (
|
|
482
|
+
help: () => i18n.help_searchInDocuments(),
|
|
480
483
|
type: ParameterType.Boolean,
|
|
481
484
|
});
|
|
482
485
|
options.addDeclaration({
|
|
483
486
|
name: "cleanOutputDir",
|
|
484
|
-
help: (
|
|
487
|
+
help: () => i18n.help_cleanOutputDir(),
|
|
485
488
|
type: ParameterType.Boolean,
|
|
486
489
|
defaultValue: true,
|
|
487
490
|
});
|
|
488
491
|
options.addDeclaration({
|
|
489
492
|
name: "titleLink",
|
|
490
|
-
help: (
|
|
493
|
+
help: () => i18n.help_titleLink(),
|
|
491
494
|
type: ParameterType.String,
|
|
492
495
|
});
|
|
493
496
|
options.addDeclaration({
|
|
494
497
|
name: "navigationLinks",
|
|
495
|
-
help: (
|
|
498
|
+
help: () => i18n.help_navigationLinks(),
|
|
496
499
|
type: ParameterType.Mixed,
|
|
497
500
|
defaultValue: {},
|
|
498
|
-
validate(value
|
|
501
|
+
validate(value) {
|
|
499
502
|
if (!isObject(value)) {
|
|
500
503
|
throw new Error(i18n.option_0_must_be_object_with_urls("navigationLinks"));
|
|
501
504
|
}
|
|
@@ -506,10 +509,10 @@ export function addTypeDocOptions(options) {
|
|
|
506
509
|
});
|
|
507
510
|
options.addDeclaration({
|
|
508
511
|
name: "sidebarLinks",
|
|
509
|
-
help: (
|
|
512
|
+
help: () => i18n.help_sidebarLinks(),
|
|
510
513
|
type: ParameterType.Mixed,
|
|
511
514
|
defaultValue: {},
|
|
512
|
-
validate(value
|
|
515
|
+
validate(value) {
|
|
513
516
|
if (!isObject(value)) {
|
|
514
517
|
throw new Error(i18n.option_0_must_be_object_with_urls("sidebarLinks"));
|
|
515
518
|
}
|
|
@@ -520,12 +523,12 @@ export function addTypeDocOptions(options) {
|
|
|
520
523
|
});
|
|
521
524
|
options.addDeclaration({
|
|
522
525
|
name: "navigationLeaves",
|
|
523
|
-
help: (
|
|
526
|
+
help: () => i18n.help_navigationLeaves(),
|
|
524
527
|
type: ParameterType.Array,
|
|
525
528
|
});
|
|
526
529
|
options.addDeclaration({
|
|
527
530
|
name: "navigation",
|
|
528
|
-
help: (
|
|
531
|
+
help: () => i18n.help_navigation(),
|
|
529
532
|
type: ParameterType.Flags,
|
|
530
533
|
defaults: {
|
|
531
534
|
includeCategories: false,
|
|
@@ -537,7 +540,7 @@ export function addTypeDocOptions(options) {
|
|
|
537
540
|
});
|
|
538
541
|
options.addDeclaration({
|
|
539
542
|
name: "headings",
|
|
540
|
-
help: (
|
|
543
|
+
help: () => i18n.help_headings(),
|
|
541
544
|
type: ParameterType.Flags,
|
|
542
545
|
defaults: {
|
|
543
546
|
readme: true,
|
|
@@ -546,7 +549,7 @@ export function addTypeDocOptions(options) {
|
|
|
546
549
|
});
|
|
547
550
|
options.addDeclaration({
|
|
548
551
|
name: "sluggerConfiguration",
|
|
549
|
-
help: (
|
|
552
|
+
help: () => i18n.help_sluggerConfiguration(),
|
|
550
553
|
type: ParameterType.Flags,
|
|
551
554
|
defaults: {
|
|
552
555
|
lowercase: true,
|
|
@@ -554,13 +557,13 @@ export function addTypeDocOptions(options) {
|
|
|
554
557
|
});
|
|
555
558
|
options.addDeclaration({
|
|
556
559
|
name: "includeHierarchySummary",
|
|
557
|
-
help: (
|
|
560
|
+
help: () => i18n.help_includeHierarchySummary(),
|
|
558
561
|
type: ParameterType.Boolean,
|
|
559
562
|
defaultValue: true,
|
|
560
563
|
});
|
|
561
564
|
options.addDeclaration({
|
|
562
565
|
name: "visibilityFilters",
|
|
563
|
-
help: (
|
|
566
|
+
help: () => i18n.help_visibilityFilters(),
|
|
564
567
|
type: ParameterType.Mixed,
|
|
565
568
|
configFileOnly: true,
|
|
566
569
|
defaultValue: {
|
|
@@ -569,7 +572,7 @@ export function addTypeDocOptions(options) {
|
|
|
569
572
|
inherited: true,
|
|
570
573
|
external: false,
|
|
571
574
|
},
|
|
572
|
-
validate(value
|
|
575
|
+
validate(value) {
|
|
573
576
|
const knownKeys = ["protected", "private", "inherited", "external"];
|
|
574
577
|
if (!value || typeof value !== "object") {
|
|
575
578
|
throw new Error(i18n.option_0_must_be_an_object("visibilityFilters"));
|
|
@@ -586,11 +589,11 @@ export function addTypeDocOptions(options) {
|
|
|
586
589
|
});
|
|
587
590
|
options.addDeclaration({
|
|
588
591
|
name: "searchCategoryBoosts",
|
|
589
|
-
help: (
|
|
592
|
+
help: () => i18n.help_searchCategoryBoosts(),
|
|
590
593
|
type: ParameterType.Mixed,
|
|
591
594
|
configFileOnly: true,
|
|
592
595
|
defaultValue: {},
|
|
593
|
-
validate(value
|
|
596
|
+
validate(value) {
|
|
594
597
|
if (!isObject(value)) {
|
|
595
598
|
throw new Error(i18n.option_0_must_be_an_object("searchCategoryBoosts"));
|
|
596
599
|
}
|
|
@@ -601,11 +604,11 @@ export function addTypeDocOptions(options) {
|
|
|
601
604
|
});
|
|
602
605
|
options.addDeclaration({
|
|
603
606
|
name: "searchGroupBoosts",
|
|
604
|
-
help: (
|
|
607
|
+
help: () => i18n.help_searchGroupBoosts(),
|
|
605
608
|
type: ParameterType.Mixed,
|
|
606
609
|
configFileOnly: true,
|
|
607
610
|
defaultValue: {},
|
|
608
|
-
validate(value
|
|
611
|
+
validate(value) {
|
|
609
612
|
if (!isObject(value)) {
|
|
610
613
|
throw new Error(i18n.option_0_must_be_an_object("searchGroupBoosts"));
|
|
611
614
|
}
|
|
@@ -616,7 +619,7 @@ export function addTypeDocOptions(options) {
|
|
|
616
619
|
});
|
|
617
620
|
options.addDeclaration({
|
|
618
621
|
name: "useFirstParagraphOfCommentAsSummary",
|
|
619
|
-
help: (
|
|
622
|
+
help: () => i18n.help_useFirstParagraphOfCommentAsSummary(),
|
|
620
623
|
type: ParameterType.Boolean,
|
|
621
624
|
});
|
|
622
625
|
///////////////////////////
|
|
@@ -624,7 +627,7 @@ export function addTypeDocOptions(options) {
|
|
|
624
627
|
///////////////////////////
|
|
625
628
|
options.addDeclaration({
|
|
626
629
|
name: "jsDocCompatibility",
|
|
627
|
-
help: (
|
|
630
|
+
help: () => i18n.help_jsDocCompatibility(),
|
|
628
631
|
type: ParameterType.Flags,
|
|
629
632
|
defaults: {
|
|
630
633
|
defaultTag: true,
|
|
@@ -635,67 +638,67 @@ export function addTypeDocOptions(options) {
|
|
|
635
638
|
});
|
|
636
639
|
options.addDeclaration({
|
|
637
640
|
name: "suppressCommentWarningsInDeclarationFiles",
|
|
638
|
-
help: (
|
|
641
|
+
help: () => i18n.help_suppressCommentWarningsInDeclarationFiles(),
|
|
639
642
|
type: ParameterType.Boolean,
|
|
640
643
|
defaultValue: true,
|
|
641
644
|
});
|
|
642
645
|
options.addDeclaration({
|
|
643
646
|
name: "commentStyle",
|
|
644
|
-
help: (
|
|
647
|
+
help: () => i18n.help_commentStyle(),
|
|
645
648
|
type: ParameterType.Map,
|
|
646
649
|
map: CommentStyle,
|
|
647
650
|
defaultValue: CommentStyle.JSDoc,
|
|
648
651
|
});
|
|
649
652
|
options.addDeclaration({
|
|
650
653
|
name: "useTsLinkResolution",
|
|
651
|
-
help: (
|
|
654
|
+
help: () => i18n.help_useTsLinkResolution(),
|
|
652
655
|
type: ParameterType.Boolean,
|
|
653
656
|
defaultValue: true,
|
|
654
657
|
});
|
|
655
658
|
options.addDeclaration({
|
|
656
659
|
name: "preserveLinkText",
|
|
657
|
-
help: (
|
|
660
|
+
help: () => i18n.help_preserveLinkText(),
|
|
658
661
|
type: ParameterType.Boolean,
|
|
659
662
|
defaultValue: true,
|
|
660
663
|
});
|
|
661
664
|
options.addDeclaration({
|
|
662
665
|
name: "blockTags",
|
|
663
|
-
help: (
|
|
666
|
+
help: () => i18n.help_blockTags(),
|
|
664
667
|
type: ParameterType.Array,
|
|
665
668
|
defaultValue: blockTags,
|
|
666
669
|
validate: makeTagArrayValidator("blockTags"),
|
|
667
670
|
});
|
|
668
671
|
options.addDeclaration({
|
|
669
672
|
name: "inlineTags",
|
|
670
|
-
help: (
|
|
673
|
+
help: () => i18n.help_inlineTags(),
|
|
671
674
|
type: ParameterType.Array,
|
|
672
675
|
defaultValue: inlineTags,
|
|
673
676
|
validate: makeTagArrayValidator("inlineTags"),
|
|
674
677
|
});
|
|
675
678
|
options.addDeclaration({
|
|
676
679
|
name: "modifierTags",
|
|
677
|
-
help: (
|
|
680
|
+
help: () => i18n.help_modifierTags(),
|
|
678
681
|
type: ParameterType.Array,
|
|
679
682
|
defaultValue: modifierTags,
|
|
680
683
|
validate: makeTagArrayValidator("modifierTags"),
|
|
681
684
|
});
|
|
682
685
|
options.addDeclaration({
|
|
683
686
|
name: "excludeTags",
|
|
684
|
-
help: (
|
|
687
|
+
help: () => i18n.help_excludeTags(),
|
|
685
688
|
type: ParameterType.Array,
|
|
686
689
|
defaultValue: OptionDefaults.excludeTags,
|
|
687
690
|
validate: makeTagArrayValidator("excludeTags"),
|
|
688
691
|
});
|
|
689
692
|
options.addDeclaration({
|
|
690
693
|
name: "notRenderedTags",
|
|
691
|
-
help: (
|
|
694
|
+
help: () => i18n.help_notRenderedTags(),
|
|
692
695
|
type: ParameterType.Array,
|
|
693
696
|
defaultValue: OptionDefaults.notRenderedTags,
|
|
694
697
|
validate: makeTagArrayValidator("notRenderedTags"),
|
|
695
698
|
});
|
|
696
699
|
options.addDeclaration({
|
|
697
700
|
name: "cascadedModifierTags",
|
|
698
|
-
help: (
|
|
701
|
+
help: () => i18n.help_modifierTags(),
|
|
699
702
|
type: ParameterType.Array,
|
|
700
703
|
defaultValue: OptionDefaults.cascadedModifierTags,
|
|
701
704
|
validate: makeTagArrayValidator("cascadedModifierTags"),
|
|
@@ -705,38 +708,38 @@ export function addTypeDocOptions(options) {
|
|
|
705
708
|
///////////////////////////
|
|
706
709
|
options.addDeclaration({
|
|
707
710
|
name: "categorizeByGroup",
|
|
708
|
-
help: (
|
|
711
|
+
help: () => i18n.help_categorizeByGroup(),
|
|
709
712
|
type: ParameterType.Boolean,
|
|
710
713
|
defaultValue: false,
|
|
711
714
|
});
|
|
712
715
|
options.addDeclaration({
|
|
713
716
|
name: "groupReferencesByType",
|
|
714
|
-
help: (
|
|
717
|
+
help: () => i18n.help_groupReferencesByType(),
|
|
715
718
|
type: ParameterType.Boolean,
|
|
716
719
|
defaultValue: false,
|
|
717
720
|
});
|
|
718
721
|
options.addDeclaration({
|
|
719
722
|
name: "defaultCategory",
|
|
720
|
-
help: (
|
|
723
|
+
help: () => i18n.help_defaultCategory(),
|
|
721
724
|
defaultValue: "Other",
|
|
722
725
|
});
|
|
723
726
|
options.addDeclaration({
|
|
724
727
|
name: "categoryOrder",
|
|
725
|
-
help: (
|
|
728
|
+
help: () => i18n.help_categoryOrder(),
|
|
726
729
|
type: ParameterType.Array,
|
|
727
730
|
});
|
|
728
731
|
options.addDeclaration({
|
|
729
732
|
name: "groupOrder",
|
|
730
|
-
help: (
|
|
733
|
+
help: () => i18n.help_groupOrder(),
|
|
731
734
|
type: ParameterType.Array,
|
|
732
735
|
// default order specified in GroupPlugin to correctly handle localization.
|
|
733
736
|
});
|
|
734
737
|
options.addDeclaration({
|
|
735
738
|
name: "sort",
|
|
736
|
-
help: (
|
|
739
|
+
help: () => i18n.help_sort(),
|
|
737
740
|
type: ParameterType.Array,
|
|
738
741
|
defaultValue: OptionDefaults.sort,
|
|
739
|
-
validate(value
|
|
742
|
+
validate(value) {
|
|
740
743
|
const invalid = new Set(value);
|
|
741
744
|
for (const v of SORT_STRATEGIES) {
|
|
742
745
|
invalid.delete(v);
|
|
@@ -748,16 +751,16 @@ export function addTypeDocOptions(options) {
|
|
|
748
751
|
});
|
|
749
752
|
options.addDeclaration({
|
|
750
753
|
name: "sortEntryPoints",
|
|
751
|
-
help: (
|
|
754
|
+
help: () => i18n.help_sortEntryPoints(),
|
|
752
755
|
type: ParameterType.Boolean,
|
|
753
756
|
defaultValue: true,
|
|
754
757
|
});
|
|
755
758
|
options.addDeclaration({
|
|
756
759
|
name: "kindSortOrder",
|
|
757
|
-
help: (
|
|
760
|
+
help: () => i18n.help_kindSortOrder(),
|
|
758
761
|
type: ParameterType.Array,
|
|
759
762
|
defaultValue: [],
|
|
760
|
-
validate(value
|
|
763
|
+
validate(value) {
|
|
761
764
|
const invalid = setDifference(value, getEnumKeys(ReflectionKind));
|
|
762
765
|
if (invalid.size !== 0) {
|
|
763
766
|
throw new Error(i18n.option_0_specified_1_but_only_2_is_valid(`kindSortOrder`, Array.from(invalid).join(", "), getEnumKeys(ReflectionKind).join(", ")));
|
|
@@ -769,67 +772,67 @@ export function addTypeDocOptions(options) {
|
|
|
769
772
|
///////////////////////////
|
|
770
773
|
options.addDeclaration({
|
|
771
774
|
name: "watch",
|
|
772
|
-
help: (
|
|
775
|
+
help: () => i18n.help_watch(),
|
|
773
776
|
type: ParameterType.Boolean,
|
|
774
777
|
});
|
|
775
778
|
options.addDeclaration({
|
|
776
779
|
name: "preserveWatchOutput",
|
|
777
|
-
help: (
|
|
780
|
+
help: () => i18n.help_preserveWatchOutput(),
|
|
778
781
|
type: ParameterType.Boolean,
|
|
779
782
|
});
|
|
780
783
|
options.addDeclaration({
|
|
781
784
|
name: "skipErrorChecking",
|
|
782
|
-
help: (
|
|
785
|
+
help: () => i18n.help_skipErrorChecking(),
|
|
783
786
|
type: ParameterType.Boolean,
|
|
784
787
|
defaultValue: false,
|
|
785
788
|
});
|
|
786
789
|
options.addDeclaration({
|
|
787
790
|
name: "help",
|
|
788
|
-
help: (
|
|
791
|
+
help: () => i18n.help_help(),
|
|
789
792
|
type: ParameterType.Boolean,
|
|
790
793
|
});
|
|
791
794
|
options.addDeclaration({
|
|
792
795
|
name: "version",
|
|
793
|
-
help: (
|
|
796
|
+
help: () => i18n.help_version(),
|
|
794
797
|
type: ParameterType.Boolean,
|
|
795
798
|
});
|
|
796
799
|
options.addDeclaration({
|
|
797
800
|
name: "showConfig",
|
|
798
|
-
help: (
|
|
801
|
+
help: () => i18n.help_showConfig(),
|
|
799
802
|
type: ParameterType.Boolean,
|
|
800
803
|
});
|
|
801
804
|
options.addDeclaration({
|
|
802
805
|
name: "plugin",
|
|
803
|
-
help: (
|
|
806
|
+
help: () => i18n.help_plugin(),
|
|
804
807
|
type: ParameterType.ModuleArray,
|
|
805
808
|
});
|
|
806
809
|
options.addDeclaration({
|
|
807
810
|
name: "logLevel",
|
|
808
|
-
help: (
|
|
811
|
+
help: () => i18n.help_logLevel(),
|
|
809
812
|
type: ParameterType.Map,
|
|
810
813
|
map: LogLevel,
|
|
811
814
|
defaultValue: LogLevel.Info,
|
|
812
815
|
});
|
|
813
816
|
options.addDeclaration({
|
|
814
817
|
name: "treatWarningsAsErrors",
|
|
815
|
-
help: (
|
|
818
|
+
help: () => i18n.help_treatWarningsAsErrors(),
|
|
816
819
|
type: ParameterType.Boolean,
|
|
817
820
|
});
|
|
818
821
|
options.addDeclaration({
|
|
819
822
|
name: "treatValidationWarningsAsErrors",
|
|
820
|
-
help: (
|
|
823
|
+
help: () => i18n.help_treatValidationWarningsAsErrors(),
|
|
821
824
|
type: ParameterType.Boolean,
|
|
822
825
|
});
|
|
823
826
|
options.addDeclaration({
|
|
824
827
|
name: "intentionallyNotExported",
|
|
825
|
-
help: (
|
|
828
|
+
help: () => i18n.help_intentionallyNotExported(),
|
|
826
829
|
type: ParameterType.Array,
|
|
827
830
|
});
|
|
828
831
|
options.addDeclaration({
|
|
829
832
|
name: "requiredToBeDocumented",
|
|
830
|
-
help: (
|
|
833
|
+
help: () => i18n.help_requiredToBeDocumented(),
|
|
831
834
|
type: ParameterType.Array,
|
|
832
|
-
validate(values
|
|
835
|
+
validate(values) {
|
|
833
836
|
// this is good enough because the values of the ReflectionKind enum are all numbers
|
|
834
837
|
const validValues = getEnumKeys(ReflectionKind);
|
|
835
838
|
for (const kind of values) {
|
|
@@ -840,15 +843,20 @@ export function addTypeDocOptions(options) {
|
|
|
840
843
|
},
|
|
841
844
|
defaultValue: OptionDefaults.requiredToBeDocumented,
|
|
842
845
|
});
|
|
846
|
+
options.addDeclaration({
|
|
847
|
+
name: "packagesRequiringDocumentation",
|
|
848
|
+
help: () => i18n.help_packagesRequiringDocumentation(),
|
|
849
|
+
type: ParameterType.Array,
|
|
850
|
+
});
|
|
843
851
|
options.addDeclaration({
|
|
844
852
|
name: "intentionallyNotDocumented",
|
|
845
|
-
help: (
|
|
853
|
+
help: () => i18n.help_intentionallyNotDocumented(),
|
|
846
854
|
type: ParameterType.Array,
|
|
847
855
|
defaultValue: [],
|
|
848
856
|
});
|
|
849
857
|
options.addDeclaration({
|
|
850
858
|
name: "validation",
|
|
851
|
-
help: (
|
|
859
|
+
help: () => i18n.help_validation(),
|
|
852
860
|
type: ParameterType.Flags,
|
|
853
861
|
defaults: {
|
|
854
862
|
notExported: true,
|