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

Update dependency typedoc to ^0.28.0 #1195

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 16, 2025

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc (source) ^0.27.1 -> ^0.28.0 age adoption passing confidence

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.28.0

Compare Source

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.
  • Exposed a TypeDoc global object in the HTML theme which can be used to prevent TypeDoc from using localStorage, #​2872.
  • Introduced @preventInline and @inlineType tags for further control extending the @inline tag, #​2862.
  • Introduced @preventExpand and @expandType tags for further control extending the @expand tag, #​2862.
  • API: Introduced DefaultThemeRenderContext.reflectionIcon for more granular control over displayed reflection icons.
Bug Fixes
  • TypeDoc will now only create references for symbols re-exported from modules.
  • Variable-functions will now prefer placing the comment on the signature if there is only one signature present, #​2824.
  • User filter settings will no longer sometimes cause the search to have fewer visible results than expected.
  • Fixed handling of expando functions which were also merged with a namespace, #​2876.
  • Fixed rendering of function types within arrays and union types, #​2892.
  • Fixed an issue where if the theme JS didn't load, the page wouldn't be shown, #​2894.
Thanks!

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Enabled.

Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot enabled auto-merge (squash) March 16, 2025 12:02
Copy link
Contributor Author

renovate bot commented Mar 16, 2025

⚠️ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: package-lock.json
npm warn Unknown env config "store". This will stop working in the next major version of npm.
npm error code ERESOLVE
npm error ERESOLVE could not resolve
npm error
npm error While resolving: [email protected]
npm error Found: [email protected]
npm error node_modules/typedoc
npm error   dev typedoc@"^0.28.0" from the root project
npm error
npm error Could not resolve dependency:
npm error peer typedoc@"0.27.x" from [email protected]
npm error node_modules/typedoc-plugin-markdown
npm error   dev typedoc-plugin-markdown@"^4.3.0" from the root project
npm error
npm error Conflicting peer dependency: [email protected]
npm error node_modules/typedoc
npm error   peer typedoc@"0.27.x" from [email protected]
npm error   node_modules/typedoc-plugin-markdown
npm error     dev typedoc-plugin-markdown@"^4.3.0" from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /runner/cache/others/npm/_logs/2025-03-20T07_30_36_507Z-eresolve-report.txt
npm error A complete log of this run can be found in: /runner/cache/others/npm/_logs/2025-03-20T07_30_36_507Z-debug-0.log

@renovate renovate bot force-pushed the renovate/typedoc-0.x branch 2 times, most recently from e172a24 to c9d4d5d Compare March 20, 2025 01:35
@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from c9d4d5d to 95edf55 Compare March 20, 2025 07:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants