chore(deps-dev): bump typedoc from 0.27.9 to 0.28.0 #609

dependabot · 2025-03-17T17:26:14Z

Bumps typedoc from 0.27.9 to 0.28.0.

Release notes

v0.28.0

Breaking Changes

TypeDoc now expects all input globs paths to be specified with / path separators, #2825.

TypeDoc's --entryPointStrategy merge mode now requires JSON from at least version 0.28.0.

Removed jp translations from lang, to migrate switch to ja.

File name references in intentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.

The source-order sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.

TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set this change improves handling of monorepo setups where some packages have readme files and others do not, #2875.

Function-like variable exports will now only be automatically converted as function types if they are initialized with a function expression. TypeDoc can be instructed to convert them as functions with the @function tag, #2881.

Object literal type alias types will now be converted in a way which causes them to be rendered more similarly to how interfaces are rendered, #2817.

API Breaking Changes

ProjectReflection.getReflectionFromSymbol and ProjectReflection.getSymbolFromReflection have been moved to Context

Path and PathArray parameter types now always contain normalized paths.

Introduced a Router which is used for URL creation. Reflection.url, Reflection.anchor, and Reflection.hasOwnDocument have been removed.

Deserializer.reviveProject(s) no longer accepts an option to add project documents.

Deserializer.reviveProjects now requires an alwaysCreateEntryPointModule option.

Comment.serializeDisplayParts no longer requires a serializer argument.

ReflectionSymbolId.fileName is now optional, TypeDoc now stores a combination of a package name and package relative path instead. The fileName property will be present when initially created, but is not serialized.

Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.

i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.

ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings. The methods on Internationalization to do this previously have been removed.

The HTML output structure for the search box has changed to support the new modal.

DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful methods now require both a reflection and a type in order to support @expandType

Features

Add support for TypeScript 5.8.x

The search modal in the HTML output has been rewritten to provide better mobile support

Added a --router option which can be used to modify TypeDoc's output folder structure. This can be extended with plugins, #2111.

Introduced the @primaryExport modifier tag to provide more fine grained control over export conversion order, #2856

Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.

TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #2528.

Type packageOptions as Partial<TypeDocOptions>, #2878.

TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.

Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.28.0 (2025-03-15)

Breaking Changes

TypeDoc now expects all input globs paths to be specified with / path separators, #2825.

TypeDoc's --entryPointStrategy merge mode now requires JSON from at least version 0.28.0.

Removed jp translations from lang, to migrate switch to ja.

File name references in intentionallyNotExported now use a package name/package relative path instead of an absolute path for matching.

The source-order sort ordering now considers package names / package relative paths instead of using the absolute paths to a file.

TypeDoc will only check for a project README file next to the discovered package.json file if --readme is not set this change improves handling of monorepo setups where some packages have readme files and others do not, #2875.

Function-like variable exports will now only be automatically converted as function types if they are initialized with a function expression. TypeDoc can be instructed to convert them as functions with the @function tag, #2881.

Object literal type alias types will now be converted in a way which causes them to be rendered more similarly to how interfaces are rendered, #2817.

API Breaking Changes

ProjectReflection.getReflectionFromSymbol and ProjectReflection.getSymbolFromReflection have been moved to Context

Path and PathArray parameter types now always contain normalized paths.

Introduced a Router which is used for URL creation. Reflection.url, Reflection.anchor, and Reflection.hasOwnDocument have been removed.

Deserializer.reviveProject(s) no longer accepts an option to add project documents.

Deserializer.reviveProjects now requires an alwaysCreateEntryPointModule option.

Comment.serializeDisplayParts no longer requires a serializer argument.

ReflectionSymbolId.fileName is now optional, TypeDoc now stores a combination of a package name and package relative path instead. The fileName property will be present when initially created, but is not serialized.

Removed DeclarationReflection.relevanceBoost attribute which was added for plugins, but never used.

i18n proxy is no longer passed to many functions, instead, reference i18n exported from the module directly.

ReflectionKind.singularString and ReflectionKind.pluralString now returns translated strings. The methods on Internationalization to do this previously have been removed.

The HTML output structure for the search box has changed to support the new modal.

DefaultThemeRenderContext's typeDeclaration and typeDetailsIfUseful methods now require both a reflection and a type in order to support @expandType

Features

Add support for TypeScript 5.8.x

The search modal in the HTML output has been rewritten to provide better mobile support

Added a --router option which can be used to modify TypeDoc's output folder structure. This can be extended with plugins, #2111.

Introduced the @primaryExport modifier tag to provide more fine grained control over export conversion order, #2856

Introduced packagesRequiringDocumentation option for validation.notDocumented, TypeDoc will expect comments to be present for symbols in the specified packages.

TypeDoc now exports a typedoc/browser entrypoint for parsing and using serialized JSON files, #2528.

Type packageOptions as Partial<TypeDocOptions>, #2878.

TypeDoc will now warn if an option which should only be set at the root level is set in packageOptions, #2878.

Introduced @function tag to force TypeDoc to convert variable declarations with a type annotation as functions, #2881.

... (truncated)

Commits

28f6d63 Update changelog for release
9ed2e6f Bump version to 0.28, upgrade deps
de7f969 Fix rendering of index headings
4c2712f Export new types
97de828 Update changelog pre-release
0f339fa Update changelog
ceedb73 Merge branch 'beta'
5eaa109 Merge pull request #2894 from crimx/patch-1
f5d676e Make rendering types more lax
309a07c Fix formatting of functions within types
Additional commits viewable in compare view

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)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.27.9 to 0.28.0. - [Release notes](https://github.com/TypeStrong/TypeDoc/releases) - [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md) - [Commits](TypeStrong/typedoc@v0.27.9...v0.28.0) --- updated-dependencies: - dependency-name: typedoc dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>

cloudflare-workers-and-pages · 2025-03-17T17:26:17Z

Deploying ant-design-x with Cloudflare Pages

Latest commit:	`48ed9a1`
Status:	✅ Deploy successful!
Preview URL:	https://702ab088.ant-design-x.pages.dev
Branch Preview URL:	https://dependabot-npm-and-yarn-type-yof6.ant-design-x.pages.dev

View logs

coderabbitai · 2025-03-17T17:26:21Z

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

petercat-assistant · 2025-03-17T17:26:29Z

Walkthrough

This pull request updates the typedoc dependency from version 0.27.9 to 0.28.0. The update includes several breaking changes and new features, such as support for TypeScript 5.8.x and improved handling of monorepo setups. The changes may affect how paths are specified and how certain types are rendered.

Changes

File	Summary
package.json	Updated `typedoc` version from 0.27.9 to 0.28.0, which includes breaking changes and new features.

petercat-assistant · 2025-03-17T17:26:31Z

package.json

@@ -261,7 +261,7 @@
    "tar-fs": "^3.0.6",
    "terser": "^5.32.0",
    "tsx": "^4.19.1",
-    "typedoc": "^0.27.6",
+    "typedoc": "^0.28.0",


This update to typedoc from 0.27.9 to 0.28.0 includes several breaking changes and new features. Ensure that your project is compatible with these changes, especially regarding path specifications and type rendering.

github-actions · 2025-03-17T17:27:12Z

codecov · 2025-03-17T17:28:02Z

Bundle Report

Changes will increase total bundle size by 231.32kB (171.73%) ⬆️⚠️, exceeding the configured threshold of 5%.

Bundle name	Size	Change
antdx-array-push	366.02kB	231.32kB (171.73%) ⬆️⚠️

Affected Assets, Files, and Routes:

view changes for bundle: antdx-array-push

Assets Changed:

Asset Name	Size Change	Total Size	Change (%)
`antdx.js` (New)	366.02kB	366.02kB	100.0% 🚀
~~`antdx.min.js`~~ (Deleted)	-134.7kB	0 bytes	-100.0% 🗑️

socket-security · 2025-03-17T17:28:06Z

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

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	None	`0`	54.5 kB	ljharb
npm/[email protected]	None	`0`	27.9 kB	benjamn
npm/[email protected]	None	`0`	22.9 MB	andrewbranch, minestarks, rbuckton, ...5 more

View full report↗︎

github-actions · 2025-03-17T17:28:43Z

size-limit report 📦

Path	Size
`dist/antdx.min.js`	36.63 KB

codecov · 2025-03-17T17:29:22Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.81%. Comparing base (346ba3e) to head (48ed9a1).
Report is 4 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #609   +/-   ##
=======================================
  Coverage   91.81%   91.81%           
=======================================
  Files          67       67           
  Lines        1466     1466           
  Branches      372      372           
=======================================
  Hits         1346     1346           
  Misses        120      120

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Mar 17, 2025

petercat-assistant bot reviewed Mar 17, 2025

View reviewed changes

afc163 enabled auto-merge (squash) March 18, 2025 13:54

afc163 approved these changes Mar 18, 2025

View reviewed changes

afc163 merged commit 63f5195 into main Mar 18, 2025
15 checks passed

afc163 deleted the dependabot/npm_and_yarn/typedoc-0.28.0 branch March 18, 2025 13:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(deps-dev): bump typedoc from 0.27.9 to 0.28.0 #609

chore(deps-dev): bump typedoc from 0.27.9 to 0.28.0 #609

dependabot bot commented on behalf of github Mar 17, 2025

cloudflare-workers-and-pages bot commented Mar 17, 2025 •

edited

Loading

coderabbitai bot commented Mar 17, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

petercat-assistant bot commented Mar 17, 2025

petercat-assistant bot Mar 17, 2025

github-actions bot commented Mar 17, 2025 •

edited

Loading

codecov bot commented Mar 17, 2025 •

edited

Loading

Assets Changed:

socket-security bot commented Mar 17, 2025

github-actions bot commented Mar 17, 2025

codecov bot commented Mar 17, 2025 •

edited

Loading

chore(deps-dev): bump typedoc from 0.27.9 to 0.28.0 #609

chore(deps-dev): bump typedoc from 0.27.9 to 0.28.0 #609

Conversation

dependabot bot commented on behalf of github Mar 17, 2025

v0.28.0

Breaking Changes

API Breaking Changes

Features

v0.28.0 (2025-03-15)

Breaking Changes

API Breaking Changes

Features

cloudflare-workers-and-pages bot commented Mar 17, 2025 • edited Loading

Deploying ant-design-x with Cloudflare Pages

coderabbitai bot commented Mar 17, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

petercat-assistant bot commented Mar 17, 2025

Walkthrough

Changes

petercat-assistant bot Mar 17, 2025

Choose a reason for hiding this comment

github-actions bot commented Mar 17, 2025 • edited Loading

codecov bot commented Mar 17, 2025 • edited Loading

Bundle Report

Affected Assets, Files, and Routes:

Assets Changed:

socket-security bot commented Mar 17, 2025

github-actions bot commented Mar 17, 2025

size-limit report 📦

codecov bot commented Mar 17, 2025 • edited Loading

Codecov Report

cloudflare-workers-and-pages bot commented Mar 17, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

github-actions bot commented Mar 17, 2025 •

edited

Loading

codecov bot commented Mar 17, 2025 •

edited

Loading

codecov bot commented Mar 17, 2025 •

edited

Loading