chore: Update typedoc and related packages
#1717
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
legobeat
approved these changes
Sep 26, 2023
Mrtenz
approved these changes
Sep 26, 2023
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
Gudahtt
force-pushed
the
update-typedoc
branch
from
1bdd52e to
b28a13b
Compare
|
Updated dependencies detected. Learn more about Socket for GitHub ↗︎
|
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
## 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 - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate
MajorLift
pushed a commit
that referenced
this pull request
Oct 11, 2023
## 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 - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Explanation
The
typedocpackage 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 oftypedocwe use doesn't support TypeScript v4.8.The
typedoc-plugin-missing-exportspackage required an update to maintain compatibility withtypedoc.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.
typedocchangelog: https://github.com/TypeStrong/typedoc/releases/tag/v0.23.0typedoc-plugin-missing-exportschangelog: https://github.com/Gerrit0/typedoc-plugin-missing-exports/blob/main/CHANGELOG.md#0230-2022-06-26References
None
Changelog
N/A
Checklist