Update typedoc 0.23.28 → 0.24.8 (major)

[depfu]

Here is everything you need to know about this upgrade. Please take a good look at what changed and the test results before merging this pull request.

What changed?

✳️ typedoc (0.23.28 → 0.24.8) · Repo · Changelog

Release Notes

0.24.8

Features

• Added support for TypeScript 5.1, #2296.
• Added navigation.fullTree to control rendering the full navigation tree on each page, #2287.
  This option will likely be replaced in 0.25 with dynamic loading of the full tree.
• TypeDoc's --pretty option now also controls whether generated HTML contains line breaks, #2287.
• Optimized icon caching to reduce file size in generated HTML documentation, #2287.
• Render property description of "roughly top level" object types, #2276.
• Added MarkdownEvent.INCLUDE for plugins, #2284.

Bug Fixes

• When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type,
  and any other block tags in the order they are defined in the comment, #2285.
• Comments are no longer removed from classes/interfaces containing call signatures, #2290.

Thanks!

• @krisztianb
• @WikiRik

0.24.7

Features

• TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.

Bug Fixes

• Category children are now sorted according to the sort option, #2272.
• Inline tags no longer require a space after the tag name to be parsed as a tag, #2273.
• Fixed module/namespace links in navigation when viewed in Safari, #2275.

0.24.6

Features

• Improved error messaging if a provided entry point could not be converted into a documented module reflection, #2242.
• API: Added support for g, circle, ellipse, polygon, and polyline svg elements, #2259.
• Extended jsDocCompatibility option with inheritDocTag to ignore fully lowercase inheritDoc tags and
  ignoreUnescapedBraces to disable warnings about unescaped { and } characters in comments.

Bug Fixes

• --useTsLinkResolution is no longer ignored within block tags, #2260.
• The current namespace will also be expanded in the navigation on page load, #2260.
• Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
• Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.

Thanks!

• @FlippieCoetser

0.24.5

Features

• Categories and groups can now be shown in the navigation, added --navigation.includeCategories
  and --navigation.includeGroups to control this behavior. The --categorizeByGroup option also
  effects this behavior. If categorizeByGroup is set (the default) and navigation.includeGroups is
  not set, the value of navigation.includeCategories will be effectively ignored since categories
  will be created only within groups, #1532.
• Added support for discovering a "module" comment on global files, #2165.
• Added copy code to clipboard button, #2153.
• Function @returns blocks will now be rendered with the return type, #2180.
• Added --groupOrder option to specify the sort order of groups, #2251.

Bug Fixes

• Type parameter constraints now respect the --hideParameterTypesInTitle option, #2226.
• Even more contrast fixes, #2248.
• Fix semantic highlighting for predicate type's parameter references, #2249.
• Fixed broken links to heading titles.
• Fixed inconsistent styling between type parameter lists and parameter lists.
• TypeDoc will now warn if more than one @returns block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.

Thanks!

• @FlippieCoetser

0.24.4

Bug Fixes

• Fixed broken semantic coloring, #2247.
• Increased contrast for parameter titles in dark mode to meet WCAG AA contrast requirements, #2244.
• Underline color of index links now matches the text color, #2245.
• Increased contract for active menu item text in dark mode.

0.24.3

Bug Fixes

• Fixed path expansion on Windows preventing generation, #2243 and #2241.

0.24.2

Features

• Added semantic link coloring for reflection names & links, #2227.
  Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
  complicated signatures as such, TypeDoc now only renders parameter names in the signature title
  and includes the type in the parameter details as usual. This can be controlled with the new
  --hideParameterTypesInTitle option.
• Conditional types will now render their branches on the next line for easier comprehension.

Bug Fixes

• Fixed & showing as & and HTML text showing up in page contents navigation, #2224.
• Increased padding between sections when one navigation column is displayed, #2225.
• Correct padding for navigation elements with a displayed icon, #2229.
• Fixed source-order sort strategy failing to compare reflections within a file.
• Added enum-member-source-order specialization of the source-order sort strategy which only compares enum members, #2237.
• Updated highlight colors for semantic links to meet WCAG AA contrast requirements, #2228.
• Type parameters are now highlighted consistently, #2230.
• Fixed semantic coloring in type and function signatures, #2227.
• Fixed issue where removing a reflection indirectly containing an object/function type would only partially remove the reflection, #2231.
• Fixed "Implementation of X.y" links if a mixture of methods and property-methods are used, #2233.
• "Implementation of" text to symbol-properties not contained in the documentation will now use the resolved name instead of a __@ symbol name, #2234.
• Fix expansion of globs if a single entry point is provided, #2235.
• Validation will no longer be skipped for sub packages when running with --entryPointStrategy packages.
• Fixed broken theme toggle if the page contained a member named "theme".

Thanks!

• @RunDevelopment

0.24.1

Bug Fixes

• Improve detection for legacy JSDoc @example tags, #2222.
• The page footer will now appear at the bottom of the page even if the page is short, #2223.

0.24.0

Breaking Changes

• @link, @linkcode and @linkplain tags will now be resolved with TypeScript's link resolution by default. The useTsLinkResolution option
  can be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc.
• TypeDoc will no longer automatically load plugins from node_modules. Specify the --plugin option to indicate which modules should be loaded.
• The packages entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.
  The previous packages strategy has been preserved under legacy-packages and will be removed in 0.25. If the new strategy does not work
  for your use case, please open an issue.
• Removed --logger option, to disable all logging, set the logLevel option to none.
• Dropped support for legacy [[link]]s, removed deprecated Reflection.findReflectionByName.
• Added @overload to default ignored tags.

API Breaking Changes

• The label property on Reflection has moved to Comment.
• The default value of the out option has been changed from "" to "./docs", #2195.
• Renamed DeclarationReflection#version to DeclarationReflection#projectVersion to match property on ProjectReflection.
• Removed unused Reflection#originalName.
• Removed Reflection#kindString, use ReflectionKind.singularString(reflection.kind) or ReflectionKind.pluralString(reflection.kind) instead.
• The named-tuple-member and template-literal type kind have been replaced with namedTupleMember and templateLiteral, #2100.
• Properties related to rendering are no longer stored on Reflection, including url, anchor, hasOwnDocument, and cssClasses.
• Application.bootstrap will no longer load plugins. If you want to load plugins, use Application.bootstrapWithPlugins instead, #1635.
• The options passed to Application.bootstrap will now be applied both before and after reading options files, which may cause a change in configuration
  if using a custom script to run TypeDoc that includes some options, but other options are set in config files.
• Moved sources property previously declared on base Reflection class to DeclarationReflection and SignatureReflection.
• Moved relevanceBoost from ContainerReflection to DeclarationReflection since setting it on the parent class has no effect.
• Removed internal ReferenceType.getSymbol, reference types no longer reference the ts.Symbol to enable generation from serialized JSON.
• OptionsReader.priority has been renamed to OptionsReader.order to more accurately reflect how it works.
• ReferenceTypes which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports.
• ReferenceTypes now longer include an id property for their target. They now instead include a target property.
• Removed Renderer.addExternalSymbolResolver, use Converter.addExternalSymbolResolver instead.
• Removed CallbackLogger.
• Removed SerializeEventData from serialization events.
• A PageEvent is now required for getRenderContext. If caching the context object, page must be updated when getRenderContext is called.
• PageEvent no longer includes the template property. The Theme.render method is now expected to take the template to render the page with as its second argument.
• Removed secondaryNavigation member on DefaultThemeRenderContext.
• Renamed navigation to sidebar on DefaultThemeRenderContext and navigation.begin/navigation.end hooks to sidebar.begin/sidebar.end.

Features

• Added --useTsLinkResolution option (on by default) which tells TypeDoc to use TypeScript's @link resolution.
• Added --jsDocCompatibility option (on by default) which controls TypeDoc's automatic detection of code blocks in @example and @default tags.
• Reworked default theme navigation to add support for a page table of contents, #1478, #2189.
• Added support for @interface on type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519
• Added support for @namespace on variable declarations to tell TypeDoc to convert the variable as a namespace, #2055.
• Added support for @prop/@property to specify documentation for a child property of a symbol, intended for use with @interface.
• TypeDoc will now produce more informative error messages for options which cannot be set from the cli, #2022.
• TypeDoc will now attempt to guess what option you may have meant if given an invalid option name.
• Plugins may now return a Promise<void> from their load function, #185.
• TypeDoc now supports plugins written with ESM, #1635.
• Added Renderer.preRenderAsyncJobs and Renderer.postRenderAsyncJobs, which may be used by plugins to perform async processing for rendering, #185.
  Note: Conversion is still intentionally a synchronous process to ensure stability of converted projects between runs.
• TypeDoc options may now be set under the typedocOptions key in package.json, #2112.
• Added --cacheBust option to tell TypeDoc to include include the generation time in files, #2124.
• Added --excludeReferences option to tell TypeDoc to omit re-exports of a symbol already included from the documentation.
• Introduced new render hooks pageSidebar.begin and pageSidebar.end.

Bug Fixes

• TypeDoc will now ignore package.json files not containing a name field, #2190.
• Fixed @inheritDoc on signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature.
• Interfaces/classes created via extending a module will no longer contain variables/functions where the member should have been converted as properties/methods, #2150.
• TypeDoc will now ignore a leading v in versions, #2212.
• Category titles now render with the same format in the page index and heading title, #2196.
• Fixed crash when using typeof on a reference with type arguments, #2220.
• Fixed broken anchor links generated to signatures nested within objects.

Thanks!

• @bodil
• @futurGH
• @jm4rtinez
• @muratgozel

Does any of this look wrong? Please let us know.

Commits

See the full diff on Github. The new version differs by more commits than we can show here.

---

Depfu will automatically keep this PR conflict-free, as long as you don't add any commits to this branch yourself. You can also trigger a rebase manually by commenting with @depfu rebase.

All Depfu comment commands

@​depfu rebase

Rebases against your default branch and redoes this update

@​depfu recreate

Recreates this PR, overwriting any edits that you've made to it

@​depfu merge

Merges this PR once your tests are passing and conflicts are resolved

@​depfu cancel merge

Cancels automatic merging of this PR

@​depfu close

Closes this PR and deletes the branch

@​depfu reopen

Restores the branch and reopens this PR (if it's closed)

@​depfu pause

Ignores all future updates for this dependency and closes this PR

@​depfu pause [minor|major]

Ignores all future minor/major updates for this dependency and closes this PR

@​depfu resume

Future versions of this dependency will create PRs again (leaves this PR as is)