Skip to content
This repository was archived by the owner on May 17, 2025. It is now read-only.

chore(deps): update dependency typedoc-plugin-markdown to v4.6.3 #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.6.3 age adoption passing confidence

Release Notes

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

v4.6.3

Compare Source

Patch Changes
  • Correctly handle group title in pageTitleTemplates callback (#​807).
  • Format of optional type and getter/setter (#​804) - thanks @​normanzb.

v4.6.2

Compare Source

Patch Changes
  • Expose full declaration for returned union types (#​799).
  • Move isOptional flag inside backTicks (#​797) - thanks @​LekoArts.
  • Added support for TypeDoc's v0.28.2 features @group none, @category none and @disableGroups.

v4.6.1

Compare Source

Patch Changes
  • Correctly render html table when interfacePropertiesFormat=htmlTable (#​794).
  • Correctly handle overloaded function display in list and table views (#​793).
  • Expose comments and signatures to index signature members.
  • Wrap default values in back ticks on table views to be consistent with list views.
  • Append semi colons to signature in code blocks.

v4.6.0

Compare Source

This release continues the effort to further align to TypeDoc’s default theme, with improvements that make the plugin more consistent and predictable.

Architectural Changes
  • Introduced support for TypeDoc core routers. This allows output files to be generated in the same structure as the default HTML theme, while still using the plugin’s Markdown theme.
  • Exported routers to the public API, enabling customization by other plugins.
Structural Changes
  • Package readme's (when "entryPointStrategy" is "packages") are now merged with the package index page producing a single entrypoint for packages with an associated readme.
    This aligns with the default theme and improves navigation.
  • To support core routers, a "Hierarchy Summary" page has been introduced to all routers. This feature is turned off by default but can be enabled by setting "includeHierarchySummary" to "true".
  • When "includeHierarchySummary" is "true", symbols with an available hierarchy now include an associated "Hierarchy" Markdown heading with a "View Summary" link as per the default theme.
  • Class constructor headings now read "Constructor". This aligns to the TypeDoc internal reflection name and fixes issues with internal anchoring not resolving correctly.
Minor Changes
  • Implemented support for consuming TypeDoc core routers.
  • Exported routers to public api.
  • Implemented a hierarchy summary page as per default theme.
  • Updated "Constructor" titles of classes to fix internal anchor issues.
Patch Changes
  • Fix incompatibility when used with "outputs" (#​788).
  • Utilize "anchorPrefix" option to ensure unique anchors linking if required (#​764).

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).

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 items 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).

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.28.x" from [email protected]
npm ERR! node_modules/typedoc-plugin-markdown
npm ERR!   dev typedoc-plugin-markdown@"4.6.3" 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-05-17T02_41_58_198Z-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 from 7323f75 to 8555e67 Compare March 24, 2025 03:04
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.5.2 chore(deps): update dependency typedoc-plugin-markdown to v4.6.0 Mar 24, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 4 times, most recently from fba397b to 007ffee Compare March 30, 2025 22:25
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from c09f54c to 99c9c57 Compare April 2, 2025 11:29
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.6.0 chore(deps): update dependency typedoc-plugin-markdown to v4.6.1 Apr 2, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from d1697d4 to ca58c50 Compare April 9, 2025 19:02
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.6.1 chore(deps): update dependency typedoc-plugin-markdown to v4.6.2 Apr 9, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 2 times, most recently from a4ac612 to d639d51 Compare April 12, 2025 14:14
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from 6349f45 to 5bd81ab Compare April 23, 2025 12:25
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.6.2 chore(deps): update dependency typedoc-plugin-markdown to v4.6.3 Apr 23, 2025
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 6 times, most recently from 8c4c259 to ca607a3 Compare May 3, 2025 09:49
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch 3 times, most recently from 7428084 to f696850 Compare May 13, 2025 08:00
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from f696850 to 72f4c2f Compare May 16, 2025 22:44
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 72f4c2f to 3d4eaa4 Compare May 17, 2025 02:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants