search

streetsidesoftware / cspell

A Spell Checker for Code!
https://cspell.org
MIT License
1.17k stars 84 forks source link

chore: bump typedoc from 0.25.13 to 0.26.2 #5813

Closed dependabot[bot] closed 1 week ago

dependabot[bot] commented 1 week ago

Bumps typedoc from 0.25.13 to 0.26.2.

Release notes

Sourced from typedoc's releases.

v0.26.2

Features

  • Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from parsing comments in declaration files, #2611.
  • Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, #2084, #2545.

Bug Fixes

  • The text non-highlighted language no longer causes warnings when rendering, #2610.
  • If a comment on a method is inherited from a parent class, and the child class does not use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

v0.26.1

Features

  • Improved Korean translation coverage, #2602.

Bug Fixes

  • Added @author to the default list of recognized tags, #2603.
  • Anchor links are no longer incorrectly checked for relative paths, #2604.
  • Fixed an issue where line numbers reported in error messages could be incorrect, #2605.
  • Fixed relative link detection for markdown links containing code in their label, #2606.
  • Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, #2607.
  • TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, #2609.
  • Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.
  • Fixed an issue where modifier tags were not applied to top level modules in packages mode.
  • Fixed an issue where excluded tags were not removed from top level modules in packages mode.
  • .jsonc configuration files are now properly read as JSONC, rather than being passed to require.

Thanks!

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.

... (truncated)

Changelog

Sourced from typedoc's changelog.

v0.26.2 (2024-06-24)

Features

  • Added a --suppressCommentWarningsInDeclarationFiles option to disable warnings from parsing comments in declaration files, #2611.
  • Improved comment discovery to more closely match TypeScript's discovery when getting comments for members of interfaces/classes, #2084, #2545.

Bug Fixes

  • The text non-highlighted language no longer causes warnings when rendering, #2610.
  • If a comment on a method is inherited from a parent class, and the child class does not use an @param tag from the parent, TypeDoc will no longer warn about the @param tag.

v0.26.1 (2024-06-22)

Features

  • Improved Korean translation coverage, #2602.

Bug Fixes

  • Added @author to the default list of recognized tags, #2603.
  • Anchor links are no longer incorrectly checked for relative paths, #2604.
  • Fixed an issue where line numbers reported in error messages could be incorrect, #2605.
  • Fixed relative link detection for markdown links containing code in their label, #2606.
  • Fixed an issue with packages mode where TypeDoc would use (much) more memory than required, #2607.
  • TypeDoc will no longer crash when asked to render highlighted code for an unsupported language, #2609.
  • Fixed an issue where relatively-linked files would not be copied to the output directory in packages mode.
  • Fixed an issue where modifier tags were not applied to top level modules in packages mode.
  • Fixed an issue where excluded tags were not removed from top level modules in packages mode.
  • .jsonc configuration files are now properly read as JSONC, rather than being passed to require.

Thanks!

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.

... (truncated)

Commits


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 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)
github-actions[bot] commented 1 week ago

Performance Report

Repository Elapsed Min/Avg/Max SD SD Graph
AdaDoom3/AdaDoom3 12.67 11.9 / 12.3 / 13.8 0.33 ┣━━┻━━╋━━●━━┫
alexiosc/megistos 31.08 29.5 / 31.1 / 33.0 0.81 ┣━━┻━━●━━┻━━┫
apollographql/apollo-server 6.70 6.4 / 6.7 / 7.0 0.16 ┣━┻━●╋━━┻━┫
aspnetboilerplate/aspnetboilerplate 24.08 23.3 / 24.8 / 26.9 0.79 ┣━━●━━╋━━┻━━┫
aws-amplify/docs 37.63 35.3 / 37.7 / 61.0 3.99 ┣━━━┻━━●━━┻━━━┫
Azure/azure-rest-api-specs 32.35 30.1 / 32.1 / 34.3 1.00 ┣━━┻━━╋●━┻━━┫
bitjson/typescript-starter 0.85 0.8 / 0.9 / 1.0 0.05 ┣━━┻●╋━┻━━┫
caddyserver/caddy 11.40 11.2 / 11.8 / 12.5 0.31 ┣━●┻━━╋━━┻━━┫
canada-ca/open-source-logiciel-libre 0.98 0.9 / 1.0 / 1.1 0.03 ┣━━┻●╋━┻━━┫
chef/chef 21.39 19.8 / 20.7 / 22.2 0.64 ┣━━┻━━╋━━●━━┫
django/django 52.61 50.2 / 53.0 / 56.7 1.21 ┣━━━┻━●╋━━┻━━━┫
eslint/eslint 31.28 29.7 / 31.7 / 34.4 0.95 ┣━━┻━●╋━━┻━━┫
exonum/exonum 11.74 11.3 / 11.8 / 14.1 0.47 ┣━━┻━━●━━┻━━┫
gitbucket/gitbucket 6.77 6.7 / 7.0 / 7.4 0.22 ┣━●━━╋━━┻━┫
googleapis/google-cloud-cpp 411.61 378.1 / 395.8 / 423.5 10.94 ┣━━━┻━━━╋━━━┻━●━┫
graphql/express-graphql 0.97 0.9 / 0.9 / 1.0 0.03 ┣━━┻━╋━┻●━┫
graphql/graphql-js 6.05 5.7 / 6.0 / 6.6 0.19 ┣━┻━━●━━┻━┫
graphql/graphql-relay-js 0.90 0.9 / 0.9 / 1.1 0.05 ┣━━●━╋━┻━━┫
graphql/graphql-spec 1.93 1.8 / 1.9 / 2.0 0.05 ┣━━┻━╋━●━━┫
iluwatar/java-design-patterns 33.54 31.4 / 33.5 / 36.2 1.09 ┣━━┻━━●━━┻━━┫
ktaranov/sqlserver-kit 23.41 22.1 / 23.3 / 25.3 0.63 ┣━━┻━━●━━┻━━┫
liriliri/licia 7.85 7.5 / 8.0 / 8.7 0.29 ┣━━┻━●╋━━┻━━┫
MartinThoma/LaTeX-examples 14.04 13.4 / 14.1 / 15.2 0.40 ┣━━┻━━●━━┻━━┫
mdx-js/mdx 4.28 3.7 / 3.9 / 4.1 0.11 ┣━┻━━╋━━┻━┫ ●
microsoft/TypeScript-Website 17.90 17.4 / 18.6 / 20.6 0.90 ┣━━┻●━╋━━┻━━┫
MicrosoftDocs/PowerShell-Docs 91.61 85.7 / 89.8 / 98.0 2.42 ┣━━┻━━━╋━━●┻━━┫
neovim/nvim-lspconfig 10.05 8.8 / 9.2 / 10.6 0.32 ┣━━┻━━╋━━┻━━┫ ●
pagekit/pagekit 7.61 7.3 / 7.7 / 8.3 0.21 ┣━━┻━●╋━━┻━━┫
php/php-src 114.16 110.9 / 116.3 / 139.3 4.92 ┣━━┻━●━╋━━━┻━━┫
plasticrake/tplink-smarthome-api 1.49 1.5 / 1.5 / 1.7 0.06 ┣━━●━╋━┻━━┫
prettier/prettier 13.56 12.8 / 13.5 / 14.2 0.34 ┣━━┻━━╋●━┻━━┫
pycontribs/jira 2.58 2.5 / 2.7 / 3.1 0.10 ┣━●━━╋━━┻━┫
RustPython/RustPython 14.31 13.9 / 14.5 / 15.9 0.42 ┣━━┻●━╋━━┻━━┫
shoelace-style/shoelace 7.43 7.1 / 7.4 / 8.5 0.30 ┣━━┻━━●━━┻━━┫
SoftwareBrothers/admin-bro 4.70 4.5 / 4.7 / 5.0 0.14 ┣━┻━━●━━┻━┫
sveltejs/svelte 38.60 36.5 / 37.9 / 39.5 0.81 ┣━━┻━━╋━━●━━┫
TheAlgorithms/Python 16.73 16.4 / 17.1 / 18.9 0.52 ┣━━┻●━╋━━┻━━┫
twbs/bootstrap 3.78 3.6 / 3.7 / 4.0 0.11 ┣━┻━━╋●━┻━┫
typescript-cheatsheets/react 2.05 2.0 / 2.1 / 2.3 0.07 ┣━●┻━╋━┻━━┫
typescript-eslint/typescript-eslint 6.61 6.4 / 6.7 / 7.5 0.28 ┣━━┻━●╋━━┻━━┫
w3c/aria-practices 10.82 9.2 / 9.7 / 10.5 0.30 ┣━━┻━━╋━━┻━━┫ ●
w3c/specberus 2.96 2.8 / 3.0 / 3.3 0.09 ┣━┻━━●━━┻━┫
webdeveric/webpack-assets-manifest 0.82 0.8 / 0.8 / 1.0 0.04 ┣━━┻●╋━┻━━┫
webpack/webpack 11.97 11.8 / 12.3 / 13.0 0.32 ┣━━●━━╋━━┻━━┫
wireapp/wire-desktop 1.31 1.2 / 1.4 / 1.6 0.07 ┣━━┻●╋━┻━━┫
wireapp/wire-webapp 21.28 20.6 / 21.6 / 22.7 0.54 ┣━━┻●━╋━━┻━━┫
Repository Elapsed Rel Trend Count
AdaDoom3/AdaDoom3 12.67 2.81% ▃▂▃▃▂▄▆▄▄▅▄▃▄▃▂█▅▅▅▅ 35
alexiosc/megistos 31.08 -0.11% ▄▄ ▂▃▆▅▅▁▃▃▅▃▅▂▁▃▄▇▄ 35
apollographql/apollo-server 6.70 -0.72% ▄▆▃▃▇▅▄▃▃▆▅▃▆▂▂▄▃▃▃▃ 35
aspnetboilerplate/aspnetboilerplate 24.08 -2.88% ▃▂▄▃▄▆▃▄▇▆▃▄▃▄▃▂▃█▄▂ 37
aws-amplify/docs 37.63 -0.12% ▃▃▃▃▃▄▄▄█▃▄▄▃▄▃▃▃▃▃▄ 37
Azure/azure-rest-api-specs 32.35 0.84% ▅▂▅▆▅▄▄▃▂▅▂▃▄▇▁▃▄▃▄▄ 37
bitjson/typescript-starter 0.85 -2.93% ▄▃▄▄▃▄▂▃▄▃▃█▃▃▃▃▃▄▃▃ 35
caddyserver/caddy 11.40 -3.56% ▆▄▄▃▄▃▆▃▄▅▄▂▃▆▄▅▅▇▅▂ 37
canada-ca/open-source-logiciel-libre 0.98 -1.51% ▂▅▂▃ ▄▃▅▅▄▅▃▂▂▃▅▃▂▅▃ 35
chef/chef 21.39 3.19% ▂▃▄▆▃▃▄▆▃▄▆▂▄▂▇▄▇▆▅▅ 37
django/django 52.61 -0.77% ▄▃▇▆▃▄▅▃▂▄▅▅▄▄▃▃▄▅█▃ 37
eslint/eslint 31.28 -1.38% ▄▄▃▆▄▄▇▃▃▃▄▃▄▃▃▃█▂▂▃ 37
exonum/exonum 11.74 -0.67% ▄▅▃▂▂▃▃▃▅▃▃▅▃▃▃▅▅█▄▃ 35
gitbucket/gitbucket 6.77 -3.38% ▂▂▇▃▅▄▄▂▄▆▃▂▆▁▃▅▂▆▆▂ 37
googleapis/google-cloud-cpp 411.61 3.98% ▂▄▂▄▅▅▇▂▄▇▄▄▃▂▃▅▄█▂▆ 37
graphql/express-graphql 0.97 4.35% ▂▄▂▃▂▄▆▄▄▃▄▆▄▅▄▂▅▄▂▆ 35
graphql/graphql-js 6.05 0.29% ▄▄▂▂▂▃▃▃▄▄▂▃▅▃▆█▄▄▅▄ 37
graphql/graphql-relay-js 0.90 -4.56% ▃▃▂▂▂▃▅█▄▃▄▃▂▄▃▃██▄▂ 35
graphql/graphql-spec 1.93 1.76% ▄▄▅▃▅▅▂▇▂▃▆▃▃▃▂▂▄▆▂▅ 36
iluwatar/java-design-patterns 33.54 0.13% ▄▄▄▂▆▃▅▆▄▄▇▃▂▃▄▄▇▃▄▄ 37
ktaranov/sqlserver-kit 23.41 0.37% ▁▄▄▅▄▄▇▃▃▄▄▃▁▄▃▄▅▄▅▄ 35
liriliri/licia 7.85 -1.73% ▆█▄▃▆▇▅▂▄▁▅▃▂▄▄▃▄▄▅▃ 37
MartinThoma/LaTeX-examples 14.04 -0.41% ▂▄▆▄▆▅▂▅▅▅▄▃▂▃▆▃▄▃▆▃ 35
mdx-js/mdx 4.28 11.21% ▄▅▃▄▅▂▂▆▂▆▂▆▆▃▃▄▄▆▃█ 36
microsoft/TypeScript-Website 17.90 -3.70% ▃▃▂▃▃▂▂▂▃▃▅▂▃▂▃▅▃▂▃▂ 37
MicrosoftDocs/PowerShell-Docs 91.61 2.02% ▃▁▇▂▄▃▅▃▆▄▅▃▂▂▄▄▅█▆▅ 37
neovim/nvim-lspconfig 10.05 9.44% ▃▄▃▄▃▂▃▃▃▃▂▄▄▂▅▅▅█▆█ 37
pagekit/pagekit 7.61 -0.97% ▂▄▄▂▄▂▃▅▁▅▅▂▂▄▅▃▃▅▄▃ 35
php/php-src 114.16 -1.84% ▂▃▅▄▄▄▄▃▂▂▃▂▃▅▃▅▅▄▄▃ 37
plasticrake/tplink-smarthome-api 1.49 -3.44% ▅▄▂▇▄▄▄▄▃▅▃▃▃▃▂▂█▄▂▂ 35
prettier/prettier 13.56 0.78% ▅▃▃▅▂▅▃▅▅▇▂▄▃▃▂▆▆▃▆▄ 37
pycontribs/jira 2.58 -4.00% ▄▃▂▃▃▄▃█▂▃▅▅▄▂▅▃▇▃▃▂ 35
RustPython/RustPython 14.31 -1.49% ▂▂▅▅▃▃▃▆▂▆▄▃▂▅▂▅▅▄▂▃ 37
shoelace-style/shoelace 7.43 -0.12% ▃▂▃▂▂▃▃▂▃▃▅▄▃▄▃▂▆▄▂▄ 37
SoftwareBrothers/admin-bro 4.70 0.53% ▃▅▃▃▇▃▅▃▆▂▁▇▄▃▃▄▅▃▂▄ 35
sveltejs/svelte 38.60 1.89% ▃▅▄▃▇▄▃▄▂▅▃▃▂▄▂▁▂▄▆▅ 37
TheAlgorithms/Python 16.73 -2.31% ▂▅▄▄▅▇▃▃▅▆▃▅▄▂▂▅█▆▄▂ 37
twbs/bootstrap 3.78 1.51% ▃▆▁▁▇▄▅▄▅▂▃▆▂▂▃▄▃▂▄▅ 36
typescript-cheatsheets/react 2.05 -4.12% ▇▄▅▄▃▂▄▃▅▇▅▃▃▃▂▃▄█▄▂ 36
typescript-eslint/typescript-eslint 6.61 -1.89% ▄▄▃▂▃▂▃▂▂▄▃▄▆▄▃▄█▃▄▃ 37
w3c/aria-practices 10.82 11.50% ▃▄▂▂▃▃▅▅▄▂▃▃▃▅▂▂▆▅▄█ 35
w3c/specberus 2.96 -0.14% ▂▂▄▄▂▃▆▃▃▇▃█▃▅▄▅▂▃▂▄ 37
webdeveric/webpack-assets-manifest 0.82 -2.39% ▃▄▃▃▃▃▃▄▅▃▄▂▅▅▂▃▄▃▄▃ 35
webpack/webpack 11.97 -2.64% ▃▂▆▂▃▄▆▄▅▆▂▅▄▁▃▄▅▇▃▂ 37
wireapp/wire-desktop 1.31 -2.70% ▃▃▄▃▄▃▄▃▄▃▃▃▅▃▃ ▄▅▃▃ 37
wireapp/wire-webapp 21.28 -1.55% ▆▃▁▃▄▄▅▄▆▇▄▃▃▃▂▃▂▇▅▃ 37

Note: