Skip to content

chore: Update typedoc and related packages - #1717

Merged
Gudahtt merged 1 commit into
mainfrom
update-typedoc
Sep 26, 2023
Merged

chore: Update typedoc and related packages#1717
Gudahtt merged 1 commit into
mainfrom
update-typedoc

Conversation

@Gudahtt

Copy link
Copy Markdown
Member

Explanation

The typedoc package has been updated to match the version used by the module template. This was done in preparation for updating the TypeScript version used by the core monorepo as well. The current version of typedoc we use doesn't support TypeScript v4.8.

The typedoc-plugin-missing-exports package required an update to maintain compatibility with typedoc.

In both cases, none of the breaking changes affect our usage of the package. Mostly they include improvements to the generated documentation, and dropping support for older Node.js and TypeScript versions.

typedoc changelog: https://github.com/TypeStrong/typedoc/releases/tag/v0.23.0
typedoc-plugin-missing-exports changelog: https://github.com/Gerrit0/typedoc-plugin-missing-exports/blob/main/CHANGELOG.md#0230-2022-06-26

References

None

Changelog

N/A

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've highlighted breaking changes using the "BREAKING" category above as appropriate

@Gudahtt
Gudahtt marked this pull request as ready for review September 26, 2023 00:37
@Gudahtt
Gudahtt requested review from a team as code ownersSeptember 26, 2023 00:37
The `typedoc` package has been updated to match the version used by the
module template. This was done in preparation for updating the
TypeScript version used by the core monorepo as well. The current
version of `typedoc` we use doesn't support TypeScript v4.8.
The `typedoc-plugin-missing-exports` package required an update to
maintain compatibility with `typedoc`.
In both cases, none of the breaking changes affect our usage of the
package. Mostly they include improvements to the generated
documentation, and dropping support for older Node.js and TypeScript
versions.
`typedoc` changelog: https://github.com/TypeStrong/typedoc/releases/tag/v0.23.0
`typedoc-plugin-missing-exports` changelog: https://github.com/Gerrit0/typedoc-plugin-missing-exports/blob/main/CHANGELOG.md#0230-2022-06-26
@socket-security

Copy link
Copy Markdown

Updated dependencies detected. Learn more about Socket for GitHub ↗︎

PackagesVersionNew capabilitiesTransitivesSizePublisher
typedoc-plugin-missing-exports0.22.6...0.23.0None+72/-16844.9 MBgerrit0
typedoc0.22.18...0.23.28None+48/-14420.2 MBtypedoc-bot

@Gudahtt
Gudahtt merged commit d2a79aa into mainSep 26, 2023
@Gudahtt
Gudahtt deleted the update-typedoc branch September 26, 2023 12:32
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@Gudahtt@Mrtenz@legobeat