Skip to content

chore(deps): update dependency typedoc-plugin-markdown to v4.5.2 #6606

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

chore(deps): update dependency typedoc-plugin-markdown to v4.5.2 #6606

wants to merge 1 commit into from

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Mar 16, 2025 •
edited
Loading

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 4.4.2 -> 4.5.2 age adoption passing confidence

Release Notes

typedoc2md/typedoc-plugin-markdown (typedoc-plugin-markdown)

v4.5.2

Compare Source

Patch Changes
  • Ensure all file paths use forward slashes in windows (#​782).

v4.5.1

Compare Source

Patch Changes
  • Correctly handle package index paths (#​782).
  • Make all options optional in PluginOptions interface (#​781).

v4.5.0

Compare Source

This release introduces support for TypeDoc 0.28 that contains several under-the-hood breaking API changes.

From a consumer perspective there should be no direct breaking change from the plugin itself, but there are some architectural and output structure changes to consider.

Architectural Changes
  • This plugin now utilizes TypeDoc's router feature. This implementation replaces the now deprecated "outputFileStrategy" option. "outputFileStrategy" is still supported for now, but will now point to the "member" and "module" router keys respectively. Further details are contained in the documentation website.
  • Please note that separate strategies for output generation in different packages (when entryPointStrategy=packages) is no longer possible with this new architecture.
Structural Changes
  • As per TypeDoc model updates, Object literal Type Alias members are now rendered in groups ("Properties", "Methods") etc rather than under a single "Type Declaration" heading.
  • A new option "typeAliasPropertiesFormat" has been exposed to place properties rendered from the updated structure to a table format.
  • Type parameter list views have been updated to separate items with markdown headings for consistency and to improve readability when parameters have detailed explanations or complex properties. If type parameters are straightforward and few in number switching to typeParametersFormat=table might be preferable.
Minor Changes
  • Implemented custom routers for plugin to support TypeDoc 0.28 router implementation.
  • Added "typeAliasPropertiesFormat" option to support TypeDoc 0.28 updated behaviour for Object literal type alias types.
Patch Changes
  • Mark object properties as optional in PluginOptions interface (#​777).

Configuration

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

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ 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 requested review from a team as code owners March 16, 2025 01:56
@vercel
Copy link

vercel bot commented Mar 16, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
next-prisma-starter ✅ Ready (Inspect) Visit Preview Mar 19, 2025 11:08pm
og-image ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 19, 2025 11:08pm
www ❌ Failed (Inspect) Mar 19, 2025 11:08pm

kodiakhq[bot]
kodiakhq bot previously approved these changes Mar 16, 2025
View reviewed changes
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2025

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.

trpc-bot
trpc-bot previously approved these changes Mar 16, 2025
View reviewed changes
@trpc-bot trpc-bot enabled auto-merge (squash) March 16, 2025 01:56
@pkg-pr-new
Copy link

pkg-pr-new bot commented Mar 16, 2025 •
edited
Loading

Open in Stackblitz

@trpc/client

npm i https://pkg.pr.new/trpc/trpc/@trpc/client@6606

@trpc/next

npm i https://pkg.pr.new/trpc/trpc/@trpc/next@6606

@trpc/server

npm i https://pkg.pr.new/trpc/trpc/@trpc/server@6606

@trpc/react-query

npm i https://pkg.pr.new/trpc/trpc/@trpc/react-query@6606

@trpc/tanstack-react-query

npm i https://pkg.pr.new/trpc/trpc/@trpc/tanstack-react-query@6606

@trpc/upgrade

npm i https://pkg.pr.new/trpc/trpc/@trpc/upgrade@6606

commit: 9ccf22c

@renovate renovate bot dismissed stale reviews from trpc-bot and kodiakhq[bot] via 1168170 March 16, 2025 18:35
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 1b6abeb to 1168170 Compare March 16, 2025 18:35
kodiakhq[bot]
kodiakhq bot previously approved these changes Mar 16, 2025
View reviewed changes
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 1168170 to 978340d Compare March 16, 2025 19:31
trpc-bot
trpc-bot previously approved these changes Mar 16, 2025
View reviewed changes
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.5.1 chore(deps): update dependency typedoc-plugin-markdown to v4.5.2 Mar 19, 2025
@renovate renovate bot dismissed stale reviews from trpc-bot and kodiakhq[bot] via c59c81b March 19, 2025 10:46
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 9ac6d4c to c59c81b Compare March 19, 2025 10:46
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from c59c81b to b178ca0 Compare March 19, 2025 17:26
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from b178ca0 to 9ccf22c Compare March 19, 2025 23:07
@renovate
Copy link
Contributor Author

renovate bot commented Mar 21, 2025

Edited/Blocked Notification

Renovate will not automatically rebase this PR, because it does not recognize the last commit author and assumes somebody else may have edited the PR.

You can manually request rebase by checking the rebase/retry box above.

⚠️ Warning: custom changes will be lost.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kodiakhq kodiakhq[bot] kodiakhq[bot] approved these changes

@trpc-bot trpc-bot trpc-bot approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@trpc-bot