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 #340

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 22, 2024

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 4.0.3 -> 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.

TypeDoc 0.27 Support

Please see for 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.
UX 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.
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).

v4.2.10

Compare Source

Patch Changes
  • Enhanced the formatting and structure of accessor output (#​711)

v4.2.9

Compare Source

Patch Changes
  • Expose @return block tags on declarations (#​694)
  • Add parentheses on function names in type declaration table views (#​696)

v4.2.8

Compare Source

Patch Changes
  • Fix missing slash when public path is prefixed with http (#​688)

v4.2.7

Compare Source

Patch Changes
  • Correctly handle top level custom groups in navigation (#​685)
  • Fix missing index descriptions for some signatures (#​670)
  • Add '?' for optional type declarations in tables

v4.2.6

Compare Source

Patch Changes
  • Expose missing entrypoints to navigation (#​663)
  • Fix missing function descriptions in indexes

v4.2.5

Compare Source

Patch Changes
  • Expose comment for arrow functions in type declarations (#​670)
  • Tables generated with the "htmlTable" key will include <thead> and <tbody> elements to fix MDX compatibility issues (#​671)
  • Expose missing descriptions with accessor keyword (#​664)

v4.2.4

Compare Source

Patch Changes
  • Expose comments to reflections with the accessor keyword (#​664)
  • Omit constructors from category groups (#​661)
  • Update categories structure in navigation to match interface model

v4.2.3

Compare Source

Patch Changes
  • Fix missing return comments for const functions (#​656)

v4.2.2

Compare Source

Patch Changes
  • Correctly resolve comment summary for const functions (#​656)
  • Fix anchor links containing generics (#​655)

v4.2.1

Compare Source

Patch Changes
  • Enhanced the formatting and structure of accessor output (#​711)

v4.2.0

Compare Source

Minor Changes
  • Exposed "modulesFileName" option (#​647)
  • Write .nojekyll file if TypeDocs "githubPages" option is true (#​650)
  • Exposed "blockTagsPreserveOrder" option to configure ordering of comment block tags (#​627).
  • Exposed "useHTMLEncodedBrackets" option for alternative angle bracket escaping(#​564).

v4.1.2

Compare Source

Patch Changes
  • Support TypeDoc 0.26 relative links implementation (#​645).

v4.1.1

Compare Source

Patch Changes
  • Normalize window paths when "publicPath" is set (#​639)

v4.1.0

Compare Source

New Features
  • Theme support for TypeDoc’s 0.26 localization model.
  • Theme support for TypeDoc’s 0.26 documents implementation.
  • Exposed a new key "htmlTable" to formatting options enabling block elements to render as intended inside table cells. Affects all existing formatting options. Fixes (#​618).
  • Added new formatting options --classPropertiesFormat, --interfacePropertiesFormat and --propertyMembersFormat to further control formatting of different declaration structures.
  • Supports the ability to control what table columns are rendered with the --tableColumnSettings option.
Patch Changes
  • Handle duplicate files when tagged in same group (#​625)
  • Fix issues with tables and block tags (#​618)

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.

Copy link
Contributor Author

renovate bot commented Jun 22, 2024

⚠️ 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 ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: [email protected]
npm ERR! Found: [email protected]
npm ERR! node_modules/typedoc
npm ERR!   dev typedoc@"0.25.13" from the root project
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer typedoc@"0.27.x" from [email protected]
npm ERR! node_modules/typedoc-plugin-markdown
npm ERR!   dev typedoc-plugin-markdown@"4.4.2" from the root project
npm ERR! 
npm ERR! Fix the upstream dependency conflict, or retry
npm ERR! this command with --force, or --legacy-peer-deps
npm ERR! to accept an incorrect (and potentially broken) dependency resolution.
npm ERR! 
npm ERR! See /runner/cache/others/npm/eresolve-report.txt for a full report.

npm ERR! A complete log of this run can be found in:
npm ERR!     /runner/cache/others/npm/_logs/2025-03-10T11_39_32_610Z-debug-0.log

@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 10 times, most recently from 6e0bbbf to 986db8f Compare June 29, 2024 01:20
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 986db8f to 758d718 Compare June 30, 2024 21:37
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.1.0 chore(deps): update dependency typedoc-plugin-markdown to v4.1.1 Jun 30, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 9 times, most recently from 16f5c4a to bf3e1e5 Compare July 5, 2024 14:30
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.1.1 chore(deps): update dependency typedoc-plugin-markdown to v4.1.2 Jul 5, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 7 times, most recently from 6b01d5a to 1364fcf Compare July 10, 2024 23:08
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from fc784db to 8818908 Compare January 5, 2025 05:47
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from 138515a to 770c455 Compare January 13, 2025 07:08
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 4 times, most recently from 9f93a55 to 93af9ff Compare January 27, 2025 08:09
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from 358f9cf to 7c97f8a Compare February 1, 2025 10:32
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from fc969c3 to 67508e4 Compare February 11, 2025 03:55
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.4.1 chore(deps): update dependency typedoc-plugin-markdown to v4.4.2 Feb 11, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 6 times, most recently from 451be35 to 43c180a Compare February 22, 2025 06:02
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 5 times, most recently from 3055b68 to 3ab2586 Compare March 4, 2025 05:24
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from 375409b to 7cb53f7 Compare March 8, 2025 14:09
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 7cb53f7 to 7907df5 Compare March 10, 2025 11:39
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.

0 participants