Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: bump typedoc from 0.26.11 to 0.27.1 #3644

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Nov 28, 2024

Bumps typedoc from 0.26.11 to 0.27.1.

Release notes

Sourced from typedoc's releases.

v0.27.1

Bug Fixes

  • Include classes which inherit from another package in class hierarchy in packages mode, #2467.
  • Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
  • Fixed automatic discovery of entry points in packages mode.
  • Reverted accidental style change for hierarchy page introduced in 0.27.0
  • The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

  • Convert to ESM to enable easier use of ESM-only dependencies.
  • Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
  • Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
  • Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
  • Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
  • Changed the default kindSortOrder to put references last.
  • Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
  • Changed default of suppressCommentWarningsInDeclarationFiles to true
  • API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
  • API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

  • Add support for TypeScript 5.7
  • TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
  • Relative links to markdown files may now include #anchor links to reference a heading within them.
  • Improved support for @param comments with nested object types, #2555.
  • Improved support for @param comments which reference a type alias/interface. Important properties on the referenced type can now be highlighted with @param options.foo, which will result in the additional note being included under the documentation for that parameter, #2147. Note:

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.1 (2024-11-28)

Bug Fixes

  • Include classes which inherit from another package in class hierarchy in packages mode, #2467.
  • Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
  • Fixed automatic discovery of entry points in packages mode.
  • Reverted accidental style change for hierarchy page introduced in 0.27.0
  • The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

  • Convert to ESM to enable easier use of ESM-only dependencies.
  • Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
  • Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
  • Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
  • Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space in rendered pages. TypeDoc now has logic to wrap types/signatures smartly, so this option is no longer necessary.
  • Changed the default kindSortOrder to put references last.
  • Changed the default sort order to use alphabetical-ignoring-documents instead of alphabetical.
  • Changed default of suppressCommentWarningsInDeclarationFiles to true
  • API: Constructor signatures now use the parent class name as their name (e.g. X, not new X)
  • API: @group, @category, @groupDescription and @categoryDescription will no longer be removed from the reflections they are present on. They are skipped during rendering with the notRenderedTags option.

Features

  • Add support for TypeScript 5.7
  • TypeDoc will now discover entry points from package.json exports if they are not provided manually, #1937.
  • Relative links to markdown files may now include #anchor links to reference a heading within them.
  • Improved support for @param comments with nested object types, #2555.
  • Improved support for @param comments which reference a type alias/interface. Important properties on the referenced type can now be highlighted with @param options.foo, which will result in the additional note being included under the documentation for that parameter, #2147. Note:

... (truncated)

Commits
  • 6142a5e Update changelog for release
  • 1ce36a4 Bump version to 0.27.1
  • fa2a322 Include classes from other packages in class hierarchy
  • 5d279c3 Minor hierarchy quality of life improvements
  • c2c1289 Fix @categoryDescription, @groupDescription on modules
  • 72b4054 Update @includeCode example
  • 110b081 Correct documentation for jsDocCompatibility
  • 51dcb74 Add @include and @includeCode to changelog for 0.27
  • 6adc8c6 Fix automatic entry point discovery for packages
  • 6868398 Fix broken links on plugin page
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot dependabot bot added the automerge Merge this Pull Request automatically once CI passes label Nov 28, 2024
Copy link

changeset-bot bot commented Nov 28, 2024

⚠️ No Changeset found

Latest commit: 545209c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

socket-security bot commented Nov 28, 2024

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package New capabilities Transitives Size Publisher
npm/[email protected] Transitive: environment, filesystem, network, shell, unsafe +3 676 kB hirokiosame
npm/[email protected] None 0 22.4 MB typescript-bot
npm/[email protected] environment, network 0 147 kB lpinca
npm/[email protected] None 0 10.2 kB sindresorhus

🚮 Removed packages: npm/[email protected], npm/[email protected]

View full report↗︎

Copy link

bundlemon bot commented Nov 28, 2024

BundleMon

Unchanged files (125)
Status Path Size Limits
@solana/web3.js production bundle
library/dist/index.production.min.js
33.76KB -
rpc-graphql/dist/index.browser.mjs
18.79KB -
rpc-graphql/dist/index.native.mjs
18.79KB -
rpc-graphql/dist/index.node.mjs
18.79KB -
errors/dist/index.node.mjs
14KB -
errors/dist/index.browser.mjs
13.99KB -
errors/dist/index.native.mjs
13.98KB -
transaction-messages/dist/index.browser.mjs
7.05KB -
transaction-messages/dist/index.native.mjs
7.05KB -
transaction-messages/dist/index.node.mjs
7.05KB -
codecs-data-structures/dist/index.native.mjs
4.77KB -
codecs-data-structures/dist/index.browser.mjs
4.77KB -
codecs-data-structures/dist/index.node.mjs
4.77KB -
webcrypto-ed25519-polyfill/dist/index.node.mj
s
3.49KB -
webcrypto-ed25519-polyfill/dist/index.browser
.mjs
3.47KB -
webcrypto-ed25519-polyfill/dist/index.native.
mjs
3.45KB -
rpc-subscriptions/dist/index.browser.mjs
3.33KB -
codecs-core/dist/index.browser.mjs
3.3KB -
codecs-core/dist/index.native.mjs
3.3KB -
codecs-core/dist/index.node.mjs
3.3KB -
rpc-subscriptions/dist/index.native.mjs
3.26KB -
rpc-subscriptions/dist/index.node.mjs
3.25KB -
rpc-transformers/dist/index.browser.mjs
2.92KB -
rpc-transformers/dist/index.native.mjs
2.92KB -
rpc-transformers/dist/index.node.mjs
2.92KB -
addresses/dist/index.browser.mjs
2.8KB -
addresses/dist/index.native.mjs
2.8KB -
addresses/dist/index.node.mjs
2.8KB -
library/dist/index.browser.mjs
2.67KB -
library/dist/index.native.mjs
2.67KB -
library/dist/index.node.mjs
2.67KB -
codecs-strings/dist/index.browser.mjs
2.53KB -
signers/dist/index.browser.mjs
2.53KB -
signers/dist/index.native.mjs
2.53KB -
signers/dist/index.node.mjs
2.53KB -
codecs-strings/dist/index.node.mjs
2.48KB -
codecs-strings/dist/index.native.mjs
2.46KB -
sysvars/dist/index.browser.mjs
2.32KB -
sysvars/dist/index.native.mjs
2.31KB -
sysvars/dist/index.node.mjs
2.31KB -
transaction-confirmation/dist/index.browser.m
js
2.3KB -
transaction-confirmation/dist/index.native.mj
s
2.3KB -
transaction-confirmation/dist/index.node.mjs
2.3KB -
rpc-subscriptions-spec/dist/index.browser.mjs
2.04KB -
rpc-subscriptions-spec/dist/index.native.mjs
2.04KB -
rpc-subscriptions-spec/dist/index.node.mjs
2.03KB -
codecs-numbers/dist/index.native.mjs
2.01KB -
codecs-numbers/dist/index.browser.mjs
2.01KB -
codecs-numbers/dist/index.node.mjs
2.01KB -
transactions/dist/index.browser.mjs
1.99KB -
transactions/dist/index.native.mjs
1.99KB -
transactions/dist/index.node.mjs
1.99KB -
react/dist/index.native.mjs
1.98KB -
react/dist/index.browser.mjs
1.98KB -
react/dist/index.node.mjs
1.98KB -
rpc-transport-http/dist/index.browser.mjs
1.91KB -
rpc-transport-http/dist/index.native.mjs
1.91KB -
rpc/dist/index.node.mjs
1.86KB -
keys/dist/index.browser.mjs
1.86KB -
keys/dist/index.native.mjs
1.86KB -
keys/dist/index.node.mjs
1.85KB -
rpc/dist/index.browser.mjs
1.76KB -
rpc/dist/index.native.mjs
1.76KB -
rpc-transport-http/dist/index.node.mjs
1.75KB -
subscribable/dist/index.browser.mjs
1.69KB -
subscribable/dist/index.native.mjs
1.69KB -
subscribable/dist/index.node.mjs
1.69KB -
rpc-types/dist/index.browser.mjs
1.6KB -
rpc-types/dist/index.native.mjs
1.6KB -
rpc-types/dist/index.node.mjs
1.6KB -
rpc-subscriptions-channel-websocket/dist/inde
x.native.mjs
1.27KB -
rpc-subscriptions-channel-websocket/dist/inde
x.browser.mjs
1.26KB -
rpc-subscriptions-channel-websocket/dist/inde
x.node.mjs
1.25KB -
options/dist/index.browser.mjs
1.18KB -
options/dist/index.native.mjs
1.18KB -
options/dist/index.node.mjs
1.17KB -
accounts/dist/index.browser.mjs
1.13KB -
accounts/dist/index.native.mjs
1.12KB -
accounts/dist/index.node.mjs
1.12KB -
rpc-spec-types/dist/index.browser.mjs
964B -
rpc-api/dist/index.browser.mjs
963B -
rpc-api/dist/index.native.mjs
962B -
rpc-spec-types/dist/index.native.mjs
962B -
rpc-spec-types/dist/index.node.mjs
961B -
rpc-api/dist/index.node.mjs
960B -
rpc-subscriptions-api/dist/index.native.mjs
870B -
rpc-subscriptions-api/dist/index.node.mjs
869B -
rpc-subscriptions-api/dist/index.browser.mjs
868B -
rpc-spec/dist/index.browser.mjs
829B -
rpc-spec/dist/index.native.mjs
829B -
rpc-spec/dist/index.node.mjs
828B -
promises/dist/index.browser.mjs
799B -
promises/dist/index.native.mjs
798B -
promises/dist/index.node.mjs
797B -
assertions/dist/index.browser.mjs
790B -
instructions/dist/index.browser.mjs
771B -
instructions/dist/index.native.mjs
770B -
instructions/dist/index.node.mjs
768B -
assertions/dist/index.native.mjs
724B -
fast-stable-stringify/dist/index.browser.mjs
724B -
assertions/dist/index.node.mjs
723B -
fast-stable-stringify/dist/index.native.mjs
723B -
fast-stable-stringify/dist/index.node.mjs
722B -
compat/dist/index.browser.mjs
712B -
compat/dist/index.native.mjs
711B -
compat/dist/index.node.mjs
710B -
programs/dist/index.browser.mjs
329B -
programs/dist/index.native.mjs
327B -
programs/dist/index.node.mjs
325B -
functional/dist/index.browser.mjs
154B -
functional/dist/index.native.mjs
152B -
text-encoding-impl/dist/index.native.mjs
152B -
functional/dist/index.node.mjs
151B -
codecs/dist/index.browser.mjs
137B -
codecs/dist/index.native.mjs
136B -
codecs/dist/index.node.mjs
134B -
ws-impl/dist/index.node.mjs
131B -
text-encoding-impl/dist/index.browser.mjs
122B -
text-encoding-impl/dist/index.node.mjs
119B -
crypto-impl/dist/index.node.mjs
114B -
ws-impl/dist/index.browser.mjs
113B -
crypto-impl/dist/index.browser.mjs
109B -
rpc-parsed-types/dist/index.browser.mjs
66B -
rpc-parsed-types/dist/index.native.mjs
65B -
rpc-parsed-types/dist/index.node.mjs
63B -

No change in files bundle size

Final result: ✅

View report in BundleMon website ➡️


Current branch size history | Target branch size history

@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.27.1 branch from f58f35b to 9709265 Compare November 28, 2024 09:46
Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.26.11 to 0.27.1.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.26.11...v0.27.1)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot force-pushed the dependabot/npm_and_yarn/typedoc-0.27.1 branch from 9709265 to 545209c Compare November 28, 2024 09:48
@mergify mergify bot merged commit 4c3a15c into master Nov 28, 2024
12 checks passed
@mergify mergify bot deleted the dependabot/npm_and_yarn/typedoc-0.27.1 branch November 28, 2024 10:08
Copy link
Contributor

Because there has been no activity on this PR for 14 days since it was merged, it has been automatically locked. Please open a new issue if it requires a follow up.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
automerge Merge this Pull Request automatically once CI passes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants