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

Bump typedoc and typedoc-plugin-markdown #1222

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Dec 6, 2024

Bumps typedoc and typedoc-plugin-markdown. These dependencies needed to be updated together.
Updates typedoc from 0.25.13 to 0.27.3

Release notes

Sourced from typedoc's releases.

v0.27.3

Features

  • Added support for PNG favicons, #2790.
  • Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

  • Add special handling for import types with type errors discarded with ts-expect-error, #2792.
  • Fixed low contrast in default colors for properties/accessors in light mode, #2795.
  • The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

v0.27.2

Bug Fixes

  • Fix crash with TypeScript 5.5.x, #2789.

v0.27.1

Bug Fixes

  • Include classes which inherit from another package in class hierarchy in packages mode, #2467.
  • Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
  • Fixed automatic discovery of entry points in packages mode.
  • Reverted accidental style change for hierarchy page introduced in 0.27.0
  • The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

  • Convert to ESM to enable easier use of ESM-only dependencies.
  • Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
  • Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
  • Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
  • Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.3 (2024-12-04)

Features

  • Added support for PNG favicons, #2790.
  • Improved support for hosting TypeDoc with strict Content Security Policy rules, #2794.

Bug Fixes

  • Add special handling for import types with type errors discarded with ts-expect-error, #2792.
  • Fixed low contrast in default colors for properties/accessors in light mode, #2795.
  • The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #2798.

Thanks!

v0.27.2 (2024-11-29)

Bug Fixes

  • Fix crash with TypeScript 5.5.x, #2789.

v0.27.1 (2024-11-28)

Bug Fixes

  • Include classes which inherit from another package in class hierarchy in packages mode, #2467.
  • Fixed handling of @categoryDescription and @groupDescription on module pages, #2787.
  • Fixed automatic discovery of entry points in packages mode.
  • Reverted accidental style change for hierarchy page introduced in 0.27.0
  • The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0 (2024-11-27)

Breaking Changes

  • Convert to ESM to enable easier use of ESM-only dependencies.
  • Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
  • Relaxed requirements for file names and generated url fragments. This may result in a different file name structure, #2714.
  • Anchors to document headings and reflections within a HTML generated pages have changed. They can be partially restored to the previous format by setting --sluggerConfiguration.lowercase false. This change was made to more closely match the default behavior of GitHub's markdown rendering and VSCode's autocomplete when creating a relative link to an external markdown file.
  • Removed the hideParameterTypesInTitle option, this was originally added as a workaround for many signatures overflowing the available horizontal space

... (truncated)

Commits
  • f421460 Update changelog for release
  • bd2ee57 Bump version to 0.27.3
  • 18d3cb1 Update changelog for PNG favicon
  • 2741645 Support language aliases in highlightLanguages
  • 2b84c16 Update changelog
  • d8b85da Fix low contract on properties/accessors in light mode
  • 9471039 Merge pull request #2797 from mikalai-snap/ms/2794-replace-fetch
  • 8ca7290 Replaced fetch() with direct data access
  • 906e988 Fix 404 issues on site
  • e472283 Merge pull request #2791 from mistic100/favicon-png
  • Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.0.3 to 4.3.1

Release notes

Sourced from typedoc-plugin-markdown's releases.

[email protected]

Patch Changes

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

[email protected]

Minor Changes

  • Implemented typedoc 0.27 compatibility support.
  • 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).
  • Exposed formatting with prettier options "formatWithPrettier" and "prettierConfigFile" that enables additional formatting of output if Prettier is installed on a project.

Patch Changes

  • Improved structure of curried and overloaded signatures (#714) (#718)
  • The "hideGroupHeadings" option respects group order (#716)
  • Handle Optional types correctly (#719).

[email protected]

Patch Changes

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

[email protected]

Patch Changes

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

[email protected]

Patch Changes

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

[email protected]

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

[email protected]

Patch Changes

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

... (truncated)

Changelog

Sourced from typedoc-plugin-markdown's changelog.

4.3.1 (2024-12-01)

Patch Changes

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

4.3.0 (2024-11-27)

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

4.2.10 (2024-11-01)

Patch Changes

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

4.2.9 (2024-10-01)

Patch Changes

  • Expose @return block tags on declarations (#694)

... (truncated)

Commits
  • 6a3cfd4 Version Packages
  • 49730a4 chore(core): expose type declarations to array types
  • d9539c4 fix(core): omit inline parameter declarations when not useful
  • b00bcc4 fix(core): correctly wrap array of unions in parenthesis
  • 3e256f6 chore(core): update ci
  • 9d4bc2b chore(docs): updated changelog
  • 19c21a3 Version Packages
  • fbfd19b chore(all): final output tweaks
  • 5e95bba chore(core): updated docs
  • e2a3467 feat(core): exposed formatting with prettier options
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [typedoc](https://github.com/TypeStrong/TypeDoc) and [typedoc-plugin-markdown](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/typedoc-plugin-markdown). These dependencies needed to be updated together.

Updates `typedoc` from 0.25.13 to 0.27.3
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.13...v0.27.3)

Updates `typedoc-plugin-markdown` from 4.0.3 to 4.3.1
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/typedoc-plugin-markdown/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/[email protected]/packages/typedoc-plugin-markdown)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
  update-type: version-update:semver-minor
- dependency-name: typedoc-plugin-markdown
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
@dependabot dependabot bot added the dependencies Pull requests that update a dependency file label Dec 6, 2024
@ahocevar
Copy link
Member

ahocevar commented Dec 6, 2024

@dependabot rebase

Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 6, 2024

Looks like this PR is already up-to-date with main! If you'd still like to recreate it from scratch, overwriting any edits, you can request @dependabot recreate.

@ahocevar
Copy link
Member

ahocevar commented Dec 6, 2024

@dependabot skip this minor version

Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 6, 2024

This option is only available on single-dependency pull requests, as the versions in multi-dependency pull requests may differ.

If you'd like to ignore all updates for these dependencies just reply @dependabot ignore these dependencies.

@ahocevar
Copy link
Member

ahocevar commented Dec 6, 2024

@dependabot ignore these dependency versions

@dependabot dependabot bot closed this Dec 6, 2024
Copy link
Contributor Author

dependabot bot commented on behalf of github Dec 6, 2024

OK, I won't notify you about any of these dependencies again, unless you re-open this PR.

@dependabot dependabot bot deleted the dependabot/npm_and_yarn/multi-7095bf9767 branch December 6, 2024 21:46
@ahocevar ahocevar restored the dependabot/npm_and_yarn/multi-7095bf9767 branch December 6, 2024 21:46
@ahocevar ahocevar reopened this Dec 6, 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.

1 participant