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.3.1 #578

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Dec 5, 2023

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc-plugin-markdown (source) 4.0.0-next.25 -> 4.3.1 age adoption passing confidence

Release Notes

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

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
  • Fix missing index descriptions for signatures (#​618)

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)

v4.0.3

Compare Source

Patch Changes
  • Remove superfluous quotes from prop names (#​619)
  • Fix display of index descriptions in tables (#​618)

v4.0.2

Compare Source

Patch Changes
  • Fix symbol url anchors when "flattenOutputFiles" is "true" (#​616)
  • Normalize line breaks and tags within table columns (#​615)
  • Remove superfluous spaces and symbol on external links (#​614)
  • Escape all angle brackets with "santizeComments" (#​612)
  • Correctly handle quoted symbol names (#​611)
  • Correctly handle excludeScopesInPaths in windows (#​610)

v4.0.1

Compare Source

Patch Changes
  • Remove superfluous newlines from table column descriptions (#​591).
  • Handle multiple @example tags on same reflection.
  • Fix missing extended by definitions.
  • Escape Symbols with signatures correctly.

v4.0.0

Compare Source

v4 is a major release that includes a number of bug fixes, new features and UI improvements.

Architectural Changes
  • Handlebars as a dependency has been removed.
  • Updated customization model with the ability to set hooks, events and custom theming.
  • Exposed navigation structure.
New Features
  • Updated output file structure.
  • Improved and cleaner UI.
  • A set of updated and additional new options with comprehensive documentation.
  • Exported option types and JSON schema.
Structural Changes
  • Each module member is now output to its own file by default. See option --outputFileStrategy. To achieve the same output as v3 (whereby only Classes, Enums and Interfaces have their own file), set the option membersWithOwnFile option.
  • Parameters are output as a list by default. To achieve the same output as v3 (where parameters are output as a table), use option --parametersFormat=table.
Breaking Changes
  • Because the file structure has changed you may need to update any cross references to files in your documentation.
  • Setting theme to "markdown" is no longer required and should be removed.
  • The option indexTitle has been removed. Please use the "title.indexPage" key with option --textContentMappings.
  • The option allReflectionsHaveOwnDocument has been removed (this behaviour is now the default). Please see option outputFileStrategy](/docs/options#outputfilestrategy).
  • The option entryDocument has been renamed to entryFileName to better reflect its purpose.
  • The option namedAnchors has been renamed to useHTMLAnchors to better reflect its purpose.
  • The option hideInPageTOC has been removed. In-page TOC are no longer included by default. You can include in-page TOCs by using typedoc-plugin-remark and the remark-toc plugin.
  • The option objectLiteralTypeDeclarationStyle has been removed. Please use option --typeDeclarationFormat=list.
Bug Fixes
  • Duplication in callback/callable/function properties. (#​581).
  • @​experimental / @​internal annotations. (#​556)
  • Fix events output and strike-through deprecated items. (#​534)
  • Class static functions are no longer marked. (#​533)
  • @​example block not rendered with Headline (#​501)
  • Support for categories (#​499)
  • Correctly resolve package readme urls from member pages. (#​483)
  • Add the ability to add a separate frontmatter for readme file. (#​469)
  • Items in tables are not linkable. (#​463)
  • Custom i18n texts. (#​458)
  • How to improve the formatting for types?. (#​456)
  • How to change title format. (#​450)
  • Export Docusaurus plugin options type. (#​440)
  • How to export interface as a table. (#​403)
  • Broken Link caused by Typescript class being defined in an index file. (#​402)
  • Markdown plugin inserts unnecessary escape characters. (#​398)
  • Potential bug with optional function argument. (#​396)
  • Respect monorepo readmeFile configuration (#​383)
  • Embed all objects under a Module/Namespace onto single page. (#​338)
  • Extra spaces when merging lines in a table. (#​331)
  • Does not support namespace (or module) and interface with same name. (#​300)
  • Integration with VitePress? (#​287)
  • Typedoc comments with text wrapped in < and > breaks Docusaurus Markdown parser. (#​276)
  • Navigation support? (#​262)
  • Sidebar Category Support? (#​213)
  • Properties as Table like function properties. (#​109)
  • Provide a link/excerpt/screenshot to a demo/example rendered output (#​102)

v4.0.0-next.60

Compare Source

v4.0.0-next.59

Compare Source

v4.0.0-next.58

Compare Source

v4.0.0-next.57

Compare Source

v4.0.0-next.56

Compare Source

v4.0.0-next.55

Compare Source

v4.0.0-next.54

Compare Source

v4.0.0-next.53

Compare Source

v4.0.0-next.52

Compare Source

v4.0.0-next.51

Compare Source

v4.0.0-next.50

Compare Source

v4.0.0-next.49

Compare Source

v4.0.0-next.48

Compare Source

v4.0.0-next.47

Compare Source

v4.0.0-next.46

Compare Source

v4.0.0-next.45

Compare Source

v4.0.0-next.44

Compare Source

v4.0.0-next.43

Compare Source

v4.0.0-next.42

Compare Source

v4.0.0-next.41

Compare Source

v4.0.0-next.40

Compare Source

v4.0.0-next.39

Compare Source

v4.0.0-next.38

Compare Source

v4.0.0-next.37

Compare Source

v4.0.0-next.36

Compare Source

v4.0.0-next.35

Compare Source

v4.0.0-next.34

Compare Source

v4.0.0-next.33

Compare Source

v4.0.0-next.32

Compare Source

v4.0.0-next.31

Compare Source

v4.0.0-next.30

Compare Source

v4.0.0-next.29

Compare Source

v4.0.0-next.28

Compare Source

v4.0.0-next.27

Compare Source

v4.0.0-next.26

Compare Source


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

@renovate renovate bot added the dependencies Pull requests that update a dependency file label Dec 5, 2023
Copy link

changeset-bot bot commented Dec 5, 2023

⚠️ No Changeset found

Latest commit: 8fafdb8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link

vercel bot commented Dec 5, 2023

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

Name Status Preview Comments Updated (UTC)
nhtsa-api-wrapper ❌ Failed (Inspect) Dec 2, 2024 0:46am

Copy link

codecov bot commented Dec 5, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.92%. Comparing base (34ccde4) to head (2494c83).

Current head 2494c83 differs from pull request most recent head af08978

Please upload reports for the commit af08978 to get more accurate results.

Additional details and impacted files
@@           Coverage Diff           @@
##             next     #578   +/-   ##
=======================================
  Coverage   99.92%   99.92%           
=======================================
  Files          42       42           
  Lines        8459     8459           
  Branches      416      416           
=======================================
  Hits         8453     8453           
  Misses          6        6           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from f501889 to eb8758f Compare December 16, 2023 01:07
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.36 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.37 Dec 16, 2023
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from eb8758f to ded9096 Compare December 18, 2023 00:45
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.37 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.38 Dec 18, 2023
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from ded9096 to d5a3451 Compare January 5, 2024 22:22
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.38 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.39 Jan 5, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from d5a3451 to fbae660 Compare January 12, 2024 20:28
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.39 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.40 Jan 12, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from fbae660 to b3188d7 Compare January 18, 2024 14:25
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.40 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.41 Jan 18, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from b3188d7 to 0f4da91 Compare January 18, 2024 17:40
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.41 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.42 Jan 18, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 0f4da91 to 4f23085 Compare January 19, 2024 00:25
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.42 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.43 Jan 19, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 4f23085 to 55d3609 Compare January 30, 2024 12:01
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.43 chore(deps): update dependency typedoc-plugin-markdown to v4.0.0-next.44 Jan 30, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 55d3609 to 6f99da1 Compare January 30, 2024 22:39
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.2 chore(deps): update dependency typedoc-plugin-markdown to v4.2.3 Jul 24, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from e8c8306 to 84385ce Compare August 13, 2024 19:41
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.3 chore(deps): update dependency typedoc-plugin-markdown to v4.2.4 Aug 13, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 84385ce to 03e20a9 Compare August 16, 2024 00:39
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.4 chore(deps): update dependency typedoc-plugin-markdown to v4.2.5 Aug 16, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 03e20a9 to 9647f61 Compare August 25, 2024 09:42
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.5 chore(deps): update dependency typedoc-plugin-markdown to v4.2.6 Aug 25, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 9647f61 to b43edfd Compare September 5, 2024 22:21
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.6 chore(deps): update dependency typedoc-plugin-markdown to v4.2.7 Sep 5, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from b43edfd to 27acfe6 Compare September 23, 2024 01:49
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.7 chore(deps): update dependency typedoc-plugin-markdown to v4.2.8 Sep 23, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 27acfe6 to 44147c3 Compare October 1, 2024 22:30
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.8 chore(deps): update dependency typedoc-plugin-markdown to v4.2.9 Oct 1, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 44147c3 to 4c95882 Compare November 2, 2024 00:22
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.9 chore(deps): update dependency typedoc-plugin-markdown to v4.2.10 Nov 2, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from 4c95882 to eced088 Compare November 27, 2024 13:43
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.2.10 chore(deps): update dependency typedoc-plugin-markdown to v4.3.0 Nov 27, 2024
@renovate renovate bot force-pushed the renovate/typedoc-plugin-markdown-4.x branch from eced088 to 8fafdb8 Compare December 2, 2024 00:46
@renovate renovate bot changed the title chore(deps): update dependency typedoc-plugin-markdown to v4.3.0 chore(deps): update dependency typedoc-plugin-markdown to v4.3.1 Dec 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants