search

nextcloud-libraries / nextcloud-dialogs

Nextcloud dialog helpers https://npmjs.org/@nextcloud/dialogs
https://nextcloud-libraries.github.io/nextcloud-dialogs/
GNU Affero General Public License v3.0
19 stars 9 forks source link

chore(deps-dev): Bump typedoc from 0.25.13 to 0.26.0 #1367

Closed dependabot[bot] closed 2 months ago

dependabot[bot] commented 2 months ago

Bumps typedoc from 0.25.13 to 0.26.0.

Release notes

Sourced from typedoc's releases.

v0.26.0

Breaking Changes

  • Drop support for Node 16.
  • Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. This means that any projects setting markedOptions needs to be updated to use markdownItOptions. Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
  • Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes. As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary, TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
  • Changed default of --excludePrivate to true.
  • Renamed --sitemapBaseUrl to --hostedBaseUrl to reflect that it can be used for more than just the sitemap.
  • Removed deprecated navigation.fullTree option.
  • Removed --media option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.
  • Removed --includes option, use the @document tag instead.
  • Removed --stripYamlFrontmatter option, TypeDoc will always do this now.
  • Renamed the --htmlLang option to --lang.
  • Removed the --gaId option for Google Analytics integration and corresponding analytics theme member, #2600.
  • All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13. This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties. As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will not be inherited by signatures of that function, #2521.
  • API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where Converter.EVENT_CREATE_DECLARATION was emitted for ProjectReflection in some circumstances.
  • API: MapOptionDeclaration.mapError has been removed.
  • API: Deprecated BindOption decorator has been removed.
  • API: DeclarationReflection.indexSignature has been renamed to DeclarationReflection.indexSignatures. Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
  • API: JSONOutput.SignatureReflection.typeParameter has been renamed to typeParameters to match the JS API.
  • API: DefaultThemeRenderContext.iconsCache has been removed as it is no longer needed.
  • API: DefaultThemeRenderContext.hook must now be passed context if required by the hook.

Features

  • Added support for TypeScript 5.5.
  • Added new --projectDocuments option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.
  • TypeDoc now has the architecture in place to support localization. No languages besides English are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
  • Added support for a packageOptions object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages, #2523.
  • --hostedBaseUrl will now be used to generate a <link rel="canonical"> element in the project root page, #2550.
  • Added support for documenting individual elements of a union type, #2585. Note: This feature is only available on type aliases directly containing unions.
  • TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.
  • New option, --customFooterHtml to add custom HTML to the generated page footer, #2559.
  • TypeDoc will now copy modifier tags to children if specified in the --cascadedModifierTags option, #2056.
  • TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both @alpha and @beta), #2056.
  • Groups and categories can now be collapsed in the page body, #2330.
  • Added support for JSDoc @hideconstructor tag.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.26.0 (2024-06-22)

Breaking Changes

  • Drop support for Node 16.
  • Moved from marked to markdown-it for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. This means that any projects setting markedOptions needs to be updated to use markdownItOptions. Unlike marked@4, markdown-it pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader option.
  • Updated Shiki from 0.14 to 1.x. This should mostly be a transparent update which adds another 23 supported languages and 13 supported themes. As Shiki adds additional languages, the time it takes to load the highlighter increases linearly. To avoid rendering taking longer than necessary, TypeDoc now only loads a few common languages. Additional languages can be loaded by setting the --highlightLanguages option.
  • Changed default of --excludePrivate to true.
  • Renamed --sitemapBaseUrl to --hostedBaseUrl to reflect that it can be used for more than just the sitemap.
  • Removed deprecated navigation.fullTree option.
  • Removed --media option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.
  • Removed --includes option, use the @document tag instead.
  • Removed --stripYamlFrontmatter option, TypeDoc will always do this now.
  • Renamed the --htmlLang option to --lang.
  • Removed the --gaId option for Google Analytics integration and corresponding analytics theme member, #2600.
  • All function-likes may now have comments directly attached to them. This is a change from previous versions of TypeDoc where functions comments were always moved down to the signature level. This mostly worked, but caused problems with type aliases, so was partially changed in 0.25.13. This change was extended to apply not only to type aliases, but also other function-likes declared with variables and callable properties. As a part of this change, comments on the implementation signature of overloaded functions will now be added to the function reflection, and will not be inherited by signatures of that function, #2521.
  • API: TypeDoc now uses a typed event emitter to provide improved type safety, this found a bug where Converter.EVENT_CREATE_DECLARATION was emitted for ProjectReflection in some circumstances.
  • API: MapOptionDeclaration.mapError has been removed.
  • API: Deprecated BindOption decorator has been removed.
  • API: DeclarationReflection.indexSignature has been renamed to DeclarationReflection.indexSignatures. Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.
  • API: JSONOutput.SignatureReflection.typeParameter has been renamed to typeParameters to match the JS API.
  • API: DefaultThemeRenderContext.iconsCache has been removed as it is no longer needed.
  • API: DefaultThemeRenderContext.hook must now be passed context if required by the hook.

Features

  • Added support for TypeScript 5.5.
  • Added new --projectDocuments option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.
  • TypeDoc now has the architecture in place to support localization. No languages besides English are currently shipped in the package, but it is now possible to add support for additional languages, #2475.
  • Added support for a packageOptions object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages, #2523.
  • --hostedBaseUrl will now be used to generate a <link rel="canonical"> element in the project root page, #2550.
  • Added support for documenting individual elements of a union type, #2585. Note: This feature is only available on type aliases directly containing unions.
  • TypeDoc will now log the number of errors/warnings errors encountered, if any, after a run, #2581.
  • New option, --customFooterHtml to add custom HTML to the generated page footer, #2559.
  • TypeDoc will now copy modifier tags to children if specified in the --cascadedModifierTags option, #2056.
  • TypeDoc will now warn if mutually exclusive modifier tags are specified for a comment (e.g. both @alpha and @beta), #2056.
  • Groups and categories can now be collapsed in the page body, #2330.
  • Added support for JSDoc @hideconstructor tag.

... (truncated)

Commits
  • 222ed1b Update changelog for release
  • 0b5a179 Bump version to 0.26.0
  • a61cdcb Recognize @defaultValue as text in more situations
  • 1b55285 Remove --gaId option
  • 2dde2e9 Slightly more docs cleanup
  • 6e6b3b6 Typed event emitters
  • e35608f add theme_loading key
  • 931ca15 Merge remote-tracking branch 'origin/master' into beta
  • 055e8e0 Add missing changelog entry
  • 38b0cbf Default html parsing to true for markdown
  • Additional commits viewable in compare view


Dependabot compatibility score

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 will merge this PR once it's up-to-date and CI passes on it, as requested by @nextcloud-command.

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 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)
dependabot[bot] commented 2 months ago

One of your CI runs failed on this pull request, so Dependabot won't merge it.

Dependabot will still automatically merge this pull request if you amend it and your tests pass.