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(deps): update dependency typedoc-plugin-markdown to v4.4.2 #3858

Closed
wants to merge 1 commit into from

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Mar 8, 2025

This PR contains the following updates:

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

Release Notes

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

v4.4.2

Compare Source

Patch Changes
  • Handle duplicate symbols with leading underscores.
  • Correctly flag optional nested parameters (#​765).
  • Introduced ja theme translations as per TypeDoc 0.27.7.
  • Expose anchors to relative document links (thanks @​matus-vacula).

v4.4.1

Compare Source

Patch Changes
  • Correctly display inline objects for tuple optional types (#​745).
  • Expose isDeprecated flag to navigation category items.

v4.4.0

Compare Source

This release introduces structural enhancements to the user interface and bug fixes to enhance overall functionality.

Structural Changes
  • Source file links are now placed inline rather than under separate "Defined in" headings. This change aligns with the default HTML theme, generates more compact output, and improves the readability of automatically generated Table of Contents (TOCs).
  • Extraneous "Index" headings on module landing pages have been removed, bringing the structure in line with the default HTML theme and reducing unnecessary clutter.
  • Anchor IDs are now applied to linkable symbols within table rows by default. Previously, the useHTMLAnchors option was required, but since there is no alternative way to link to these items, this behaviour is now the default.
Minor Changes
  • Expose "isDeprecated" flag to navigation model (#​747).
  • Moved source link inline and exposed to all parent symbols (#​746).
  • Remove extraneous "Index" headings.
  • Always assign HTML anchor ids to linkable symbols within table rows.
Patch Changes
  • Always display inline object for tuple types (#​745).
  • Strikeout deprecated items in reflection indexes.
  • Fix inline formatting of types when when "useCodeBlocks" is used (#​742).
  • Expose group descriptions to module indexes.
  • Expose global documents with "packages" entryPointStrategy.

v4.3.3

Compare Source

Patch Changes
  • Correctly handle anchor resolutions with table formats.
  • Fix invalid typescript syntax for type aliases inside declaration code blocks when "useCodeBlocks" is true (#​741).

v4.3.2

Compare Source

Patch Changes
  • Enable {@​link} resolution on type alias properties (#​732).
  • Remove superfluous name attribute when "useHtmlAnchors" is true..
  • Escape characters inside @link tags.
  • Fixed spacing around inline object declarations.
  • Always expose type arguments of reference types as per default theme (#​733).

v4.3.1

Compare Source

Patch Changes
  • Expose type declarations to array types.
  • Correctly wrap array of unions in parenthesis (#​719).
  • Omit inline parameter declarations when not useful (#​720).

v4.3.0

Compare Source

This release introduces support for TypeDoc 0.27 and some additional UX features and improvements in addition to some bug fixes.

Architectural Changes

Please see the full TypeDoc changelog for additional information.

There are two TypeDoc breaking changes that might effect users of this plugin:

  • TypeDoc has converted to ESM and therefore all public and local CommonJs plugins will need to be refactored to ESM.
  • TypeScript <5.0 is no longer supported.
Structural Changes
  • Parameters list views have been updated to separate params with markdown headings to improve readability when parameters have detailed explanations examples, or sub-properties. If parameters are straightforward and few in number switching to parametersFormat=table might be preferable.
  • Improved structure of curried and overloaded signatures.
  • Page headings have been simplified to simply display project title as per default theme.
New Features
  • Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of Markdown if Prettier is installed on a project.
  • Exposed "typeDeclarationVisibility" option to provide a "compact" output structure (#​703).
  • Exposed "pageTitleTemplates" option that accepts a string with placeholder or function arguments to control page titles (#​715).
Patch Changes
  • Improved structure of curried and overloaded signatures (#​714) (#​718)
  • The "hideGroupHeadings" option respects group order (#​716)
  • Handle Optional types correctly (#​719).

Configuration

📅 Schedule: Branch creation - "every weekend" in timezone UTC, Automerge - At any time (no schedule defined).

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

Rebasing: Whenever PR becomes conflicted, 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.

Copy link
Contributor Author

renovate bot commented Mar 8, 2025

⚠️ Artifact update problem

Renovate failed to update artifacts 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: docs/package-lock.json
npm warn Unknown env config "store". This will stop working in the next major version of npm.
(node:9819) ExperimentalWarning: CommonJS module /opt/containerbase/tools/npm/11.2.0/23.3.0/node_modules/npm/node_modules/debug/src/node.js is loading ES Module /opt/containerbase/tools/npm/11.2.0/23.3.0/node_modules/npm/node_modules/supports-color/index.js using require().
Support for loading ES Module in require() is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
npm error code ERESOLVE
npm error ERESOLVE unable to resolve dependency tree
npm error
npm error While resolving: eliza-docs@0.25.9
npm error Found: typedoc@0.26.11
npm error node_modules/typedoc
npm error   dev typedoc@"0.26.11" from the root project
npm error
npm error Could not resolve dependency:
npm error peer typedoc@"0.27.x" from typedoc-plugin-markdown@4.4.2
npm error node_modules/typedoc-plugin-markdown
npm error   dev typedoc-plugin-markdown@"4.4.2" 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-08T20_18_20_873Z-eresolve-report.txt
npm error A complete log of this run can be found in: /runner/cache/others/npm/_logs/2025-03-08T20_18_20_873Z-debug-0.log

File name: pnpm-lock.yaml
Scope: all 10 workspace projects
 ERR_PNPM_OUTDATED_LOCKFILE  Cannot install with "frozen-lockfile" because pnpm-lock.yaml is not up to date with <ROOT>/docs/package.json

Note that in CI environments this setting is true by default. If you still need to run install in such cases, use "pnpm install --no-frozen-lockfile"

    Failure reason:
    specifiers in the lockfile ({"@docusaurus/core":"3.7.0","@docusaurus/plugin-content-blog":"3.7.0","@docusaurus/plugin-content-docs":"3.7.0","@docusaurus/plugin-ideal-image":"^3.0.0","@docusaurus/preset-classic":"3.7.0","@docusaurus/theme-common":"3.7.0","@docusaurus/theme-mermaid":"3.7.0","@mdx-js/react":"3.0.1","clsx":"^2.1.1","docusaurus-lunr-search":"3.5.0","dotenv":"^16.4.7","lodash":"^4.17.21","lunr":"2.3.9","prism-react-renderer":"2.3.1","react":"18.3.1","react-dom":"18.3.1","react-router-dom":"6.22.1","@docusaurus/module-type-aliases":"3.7.0","@docusaurus/types":"3.7.0","docusaurus-plugin-typedoc":"1.0.5","typedoc":"0.26.11","typedoc-plugin-markdown":"4.2.10"}) don't match specs in package.json ({"@docusaurus/module-type-aliases":"3.7.0","@docusaurus/types":"3.7.0","docusaurus-plugin-typedoc":"1.0.5","typedoc":"0.26.11","typedoc-plugin-markdown":"4.4.2","@docusaurus/core":"3.7.0","@docusaurus/plugin-content-blog":"3.7.0","@docusaurus/plugin-content-docs":"3.7.0","@docusaurus/plugin-ideal-image":"^3.0.0","@docusaurus/preset-classic":"3.7.0","@docusaurus/theme-common":"3.7.0","@docusaurus/theme-mermaid":"3.7.0","clsx":"^2.1.1","@mdx-js/react":"3.0.1","docusaurus-lunr-search":"3.5.0","dotenv":"^16.4.7","lodash":"^4.17.21","lunr":"2.3.9","prism-react-renderer":"2.3.1","react":"18.3.1","react-dom":"18.3.1","react-router-dom":"6.22.1"})

Copy link

graphite-app bot commented Mar 8, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • merge-queue-hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

Copy link
Contributor

coderabbitai bot commented Mar 8, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. 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.

@lalalune lalalune closed this Mar 8, 2025
@lalalune lalalune deleted the renovate/typedoc-plugin-markdown-4.x branch March 9, 2025 03:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant