Update typedoc: 0.23.15 → 0.23.27 (minor)

[depfu]

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

What changed?

✳️ typedoc (0.23.15 → 0.23.27) · Repo · Changelog

Release Notes

0.23.27

Features

• Added --treatValidationWarningsAsErrors to treat only validation warnings as errors without treating all warnings as errors, #2199.

Bug Fixes

• Fixed a bug where optional properties were not appropriately marked as optional, #2200.
• Fixed shifted navigation pane on devices 1024px wide, #2191.
• Add missing @private and @protected tags to typedoc/tsdoc.json, #2187.

Thanks!

• @futurGH

0.23.26

Features

• Added Application.EVENT_VALIDATE_PROJECT event for plugins which implement custom validation, #2183.
• Plugins may now return an object from external symbol resolvers, #2066.
• Expose Comment.displayPartsToMarkdown on for themes overwriting the comment helper, #2115.

Bug Fixes

• Fix crash when converting export default undefined, #2175.
• Fix error in console when clicking on headings in the readme, #2170.
• TypeDoc will now ignore parameters of callback parameters when validating that all parameters have documentation, #2154.

Thanks!

• @captain-torch
• @loopingz
• @RebeccaStevens

0.23.25

Breaking Changes

• Upgraded Shiki, if your highlight theme was set to material-<theme>, the value will need to be changed to
  material-theme-<theme>, see the Shiki release notes.

Features

• Added new excludeNotDocumentedKinds variable to control which reflection types can be removed
  by the excludeNotDocumented option, #2162.
• Added typedoc.jsonc, typedoc.config.js, typedoc.config.cjs, typedoc.cjs to the list of files
  which TypeDoc will automatically use as configuration files.

Bug Fixes

• Entry points under node_modules will no longer be ignored, #2151.
• Corrected behavior of excludeNotDocumented on arrow function-variables, #2156.
• Added package.json to exports declaration.

Thanks!

• @boneskull
• @Mikkal24
• @Zamiell

0.23.24

Bug Fixes

• Fixed an issue where signature comments were preferred over property comments for indirectly created function-properties, #2135.
• Fixed symlink handling when expanding entry points, #2130.

Thanks!

• @boneskull

0.23.23

Features

• Added ts.Signature to emitted EVENT_CREATE_SIGNATURE event, #2002.

Bug Fixes

• Links to members hidden by filter settings now temporarily override the filter, #2092.
• If src/ and src/x are specified as entry points, src/ will no longer be ignored, #2121.

0.23.22

Features

• Add support for defining the kind sort order, #2109.

Bug Fixes

• Normalize all file paths on Windows, #2113.
• Fix @link tags within lists, #2103.

0.23.21

Features

• Added support for a catch-all wildcard in externalSymbolLinkMappings, #2102.
• Added support for TypeScript 4.9.

Thanks!

• @mistic100

0.23.20

Bug Fixes

• Fixed comment discovery for @inheritDoc if inheriting from a function type alias, #2087.

0.23.19

Bug Fixes

• Fixed title link if titleLink option was not specified, #2085.

Thanks!

• @krisztianb

0.23.18

Features

• Improved error reporting when failing to find entry points, #2080, #2082.

Bug Fixes

• Constructor parameter-properties will now use the @param comment for the parameter if available, #1261.
• Fixed display of object types containing methods, #1788.
• Fixed conversion of intrinsic string mapping types when converting without a type node, #2079.

0.23.17

Features

• Added titleLink, navigationLinks and sidebarLinks options to add additional links to the rendered output, #1830.
• Added sourceLinkTemplate option to allow more flexible specification of remote urls.
  Deprecated now redundant gitRevision detection starting with https?:// introduced in v0.23.16, #2068.

Thanks!

• @futurGH

0.23.16

Features

• Object types will now be pretty printed, #1793.
• Added support for specifying the tsconfig.json file in packages mode with { "typedoc": { "tsconfig": "tsconfig.lib.json" }} in package.json, #2061.
• In packages mode, readme files will now be automatically included if present, #2065.
• Added support for specifying the base file url for links to source code, #2068.

Bug Fixes

• Private parameter properties will no longer be ignored, #2064.

Thanks!

• @captainTorch

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 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)

[depfu]

Closed in favor of #17.