Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Mar 20, 2025

Bumps typedoc from 0.25.13 to 0.28.1.

Release notes

Sourced from typedoc's releases.

v0.28.1

Features

  • The TypeDocOptions interface now marks options as optional so it no longer has to be wrapped in Partial for use in config files, #2901.
  • API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports)
  • API: Expose method to disable TypeDoc usage of localStorage without clearing it, #2908.

Bug Fixes

  • --watch can now infer entry points from package.json as supported in non-watch mode, #2899.
  • @include with regions now works on files with CRLF line endings, #2902.
  • Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #2905.
  • Fixed a crash when converting module.exports = [], #2909.
  • Fixed URL generation which introduced a superfluous ./ in relative links, #2910.

Thanks!

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.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.28.1 (2025-03-20)

Features

  • The TypeDocOptions interface now marks options as optional so it no longer has to be wrapped in Partial for use in config files, #2901.
  • API: Expose control methods for deferred conversion for plugin use (typedoc-plugin-missing-exports)
  • API: Expose method to disable TypeDoc usage of localStorage without clearing it, #2908.

Bug Fixes

  • --watch can now infer entry points from package.json as supported in non-watch mode, #2899.
  • @include with regions now works on files with CRLF line endings, #2902.
  • Generated page names now correctly handles UTF-8 characters requiring more than 16 bits #2905.
  • Fixed a crash when converting module.exports = [], #2909.
  • Fixed URL generation which introduced a superfluous ./ in relative links, #2910.

Thanks!

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.

... (truncated)

Commits
  • 6090b3e Update changelog for release
  • 6421662 Release v0.28.1
  • c7ac719 Update changelog
  • a49c6c8 Make clearing TypeDoc fields from local storage optional (#2908)
  • b53a220 Fix #2910
  • 34ce994 Fix crash when converting array from module.exports
  • 2d95afa Merge pull request #2906 from romainmnr/master
  • df1033f style: remove useless spaces
  • c421520 text(createNormalizedUrl): add UTF8 & emoji tests
  • 383e164 fix(createNormalizedUrl): replace String.fromCharCode by String.fromCodePoint
  • 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)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) from 0.25.13 to 0.28.1.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.13...v0.28.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 requested a review from BelfordZ March 20, 2025 16:38
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code labels Mar 20, 2025
Copy link
Contributor Author

dependabot bot commented on behalf of github Apr 7, 2025

Superseded by #963.

@dependabot dependabot bot closed this Apr 7, 2025
@dependabot dependabot bot deleted the dependabot/npm_and_yarn/typedoc-0.28.1 branch April 7, 2025 17:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file javascript Pull requests that update javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant