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-dev): bump the docusaurus group across 1 directory with 3 updates #2126

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

Conversation

dependabot[bot]
Copy link
Contributor

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

Bumps the docusaurus group with 1 update in the /docs directory: docusaurus-plugin-typedoc.

Updates docusaurus-plugin-typedoc from 1.0.5 to 1.1.1

Changelog

Sourced from docusaurus-plugin-typedoc's changelog.

1.1.1 (2024-12-03)

Patch Changes

  • Allow additional plugins to be loaded via the "plugin" key.

1.1.0 (2024-11-27)

Minor Changes

  • typedoc@0.27 / typedoc-plugin-markdown@4.3 support
Commits
  • d7ea67e Version Packages
  • 5ba16e7 fix(docusaurus): allow additional typedoc plugins to load
  • 292b7be chore(docs): updated changelog dates
  • 6f80d78 Version Packages
  • 4d466c9 chore(all): prepare sub-packages
  • 19c21a3 Version Packages
  • fbfd19b chore(all): final output tweaks
  • 5e95bba chore(core): updated docs
  • a667e80 chore(all): updated typedoc
  • 78f246b chore(all): convert to esm / TypeDoc 0.27 fixes
  • Additional commits viewable in compare view

Updates typedoc from 0.26.11 to 0.27.5

Release notes

Sourced from typedoc's releases.

v0.27.5

Bug Fixes

  • Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, #2808.
  • TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
  • @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
  • Cascaded modifier tags will no longer be copied into type literals, #2802.
  • @summary now works to describe functions within modules, #2803.
  • Corrected navigation showing module link as current when not on module page, #2805.

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.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.27.5 (2024-12-14)

Bug Fixes

  • Possibly Breaking: TypeDoc will no longer render anchors within the page for deeply nested properties. This only affects links to properties of properties of types, which did not have a clickable link exposed so are unlikely to have been linked to. Furthermore, these links were not always created by TypeDoc, only being created if all parent properties contained comments, #2808.
  • TypeDoc will now warn if a property which does not have a URL within the rendered document and the parent property/page will be linked to instead, #2808. These warnings can be disabled with the validation.rewrittenLink option.
  • Fix restoration of groups/categories including documents, #2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no longer be treated as external, #2809.

Thanks!

v0.27.4 (2024-12-09)

Features

  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #2800.

Bug Fixes

  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #2796.
  • @include and @includeCode now work for comments on the entry point for projects with a single entry point, #2800.
  • Cascaded modifier tags will no longer be copied into type literals, #2802.
  • @summary now works to describe functions within modules, #2803.
  • Corrected navigation showing module link as current when not on module page, #2805.

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.

... (truncated)

Commits
  • 80e23a8 Update changelog for release
  • 9ffaf1d Bump version to 0.27.5
  • d9ec2dd Treat links under hostedBaseUrl as internal
  • 8acc237 Correct mismatched check between renderingIsUseful and applyAnchorUrl
  • 9eb1e05 Produce warnings if links cannot be resolved
  • e4f991d Update bug report template to ask reporters to disable plugins
  • b45d5ea Fix multiple issues with markdown parsing
  • ddc64e5 Update docs, changelog
  • 9d8737e Update JSX extension docs
  • 993c0f5 expose html global jsx attributes to enable extending them for custom element...
  • Additional commits viewable in compare view

Updates typedoc-plugin-markdown from 4.2.10 to 4.3.2

Release notes

Sourced from typedoc-plugin-markdown's releases.

typedoc-plugin-markdown@4.3.2

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

typedoc-plugin-markdown@4.3.1

Patch Changes

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

typedoc-plugin-markdown@4.3.0

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

Sourced from typedoc-plugin-markdown's changelog.

4.3.2 (2024-12-08)

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

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).
Commits
  • bfb1c60 Version Packages
  • 43df8b1 chore(docs): updated typedoc option paths
  • f39b42b fix(core): always expose type arguments of reference types as per default theme
  • 27caafc chore(docs): updated packages
  • ffaa2cd fix(core): enable @link resolution on type alias properties
  • 05197cc fix(core): fixed spacing around inline object declarations
  • 65ddaff fix(core): escape chars inside @link tags
  • 11b5000 chore(all): updated packages
  • b2db92c chore(docs): updated docs
  • 2619301 chore(docs): updated docs
  • 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 <dependency name> major version will close this group update PR and stop Dependabot creating any more for the specific dependency's major version (unless you unignore this specific dependency's major version or upgrade to it yourself)
  • @dependabot ignore <dependency name> minor version will close this group update PR and stop Dependabot creating any more for the specific dependency's minor version (unless you unignore this specific dependency's minor version or upgrade to it yourself)
  • @dependabot ignore <dependency name> will close this group update PR and stop Dependabot creating any more for the specific dependency (unless you unignore this specific dependency or upgrade to it yourself)
  • @dependabot unignore <dependency name> will remove all of the ignore conditions of the specified dependency
  • @dependabot unignore <dependency name> <ignore condition> will remove the ignore condition of the specified dependency and ignore conditions

…updates

Bumps the docusaurus group with 1 update in the /docs directory: [docusaurus-plugin-typedoc](https://github.com/typedoc2md/typedoc-plugin-markdown/tree/HEAD/packages/docusaurus-plugin-typedoc).


Updates `docusaurus-plugin-typedoc` from 1.0.5 to 1.1.1
- [Release notes](https://github.com/typedoc2md/typedoc-plugin-markdown/releases)
- [Changelog](https://github.com/typedoc2md/typedoc-plugin-markdown/blob/main/packages/docusaurus-plugin-typedoc/CHANGELOG.md)
- [Commits](https://github.com/typedoc2md/typedoc-plugin-markdown/commits/docusaurus-plugin-typedoc@1.1.1/packages/docusaurus-plugin-typedoc)

Updates `typedoc` from 0.26.11 to 0.27.5
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.26.11...v0.27.5)

Updates `typedoc-plugin-markdown` from 4.2.10 to 4.3.2
- [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/typedoc-plugin-markdown@4.3.2/packages/typedoc-plugin-markdown)

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

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file javascript Pull requests that update Javascript code labels Dec 16, 2024
Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.89%. Comparing base (306b0aa) to head (ed9eb8a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2126   +/-   ##
=======================================
  Coverage   91.89%   91.89%           
=======================================
  Files          38       38           
  Lines       10320    10320           
  Branches      649      649           
=======================================
  Hits         9484     9484           
  Misses        824      824           
  Partials       12       12           
Flag Coverage Δ
cli-hooks 95.24% <ø> (ø)
cli-test 94.48% <ø> (ø)
oauth 77.39% <ø> (ø)
socket-mode 61.82% <ø> (ø)
web-api 96.88% <ø> (ø)
webhook 96.65% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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 javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants