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): update typedoc requirement from ^0.25.7 to ^0.25.8 #47430

Merged
merged 3 commits into from
Feb 12, 2024

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Feb 12, 2024

Updates the requirements on typedoc to permit the latest version.

Release notes

Sourced from typedoc's releases.

v0.25.8

Features

  • Added a new --sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
  • Added support for the @class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479. Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
  • Added support for @groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
  • API: Exposed Context.getNodeComment for plugin use, #2498.

Bug Fixes

  • Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
  • A class which implements itself will no longer cause a crash when rendering HTML, #2495.
  • Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
  • The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
  • Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
  • API: Context.programs will no longer contain duplicates, #2498.
Changelog

Sourced from typedoc's changelog.

v0.25.8 (2024-02-09)

Features

  • Added a new --sitemapBaseUrl option. When specified, TypeDoc will generate a sitemap.xml in your output folder that describes the site, #2480.
  • Added support for the @class tag. When added to a comment on a variable or function, TypeDoc will convert the member as a class, #2479. Note: This should only be used on symbols which actually represent a class, but are not declared as a class for some reason.
  • Added support for @groupDescription and @categoryDescription to provide a description of groups and categories, #2494.
  • API: Exposed Context.getNodeComment for plugin use, #2498.

Bug Fixes

  • Fixed an issue where a namespace would not be created for merged function-namespaces which are declared as variables, #2478.
  • A class which implements itself will no longer cause a crash when rendering HTML, #2495.
  • Variable functions which have construct signatures will no longer be converted as functions, ignoring the construct signatures.
  • The class hierarchy page will now include classes whose base class is not included in the documentation, #2486.
  • Fixed an issue where, if the index section was collapsed when loading the page, all content within it would be hidden until expanded, and a member visibility checkbox was changed.
  • API: Context.programs will no longer contain duplicates, #2498.

v0.25.7 (2024-01-08)

Bug Fixes

  • Fixed an issue where a namespace would not be created for merged function-namespaces only containing types, #2476.
  • Fixed an infinite loop when converting a union type which directly contained another union type which refers to itself, #2469.

v0.25.6 (2024-01-01)

Bug Fixes

  • Fixed infinite loop caused by a fix for some complicated union/intersection types, #2468.
  • Improved infinite loop detection in type converter to reduce false positives.

v0.25.5 (2024-01-01)

Features

  • Added a new hierarchy.html page to HTML output which displays the full inheritance hierarchy for classes included in the documentation, #182.
  • Added a --navigation.includeFolders (default: true) option to create nested navigation for projects which include many entry points, #2388.
  • Type parameters on functions/classes can will now link to the "Type Parameters" section, #2322. Type parameters have also been changed to have a distinct color from type aliases when rendering, which can be changed with custom CSS.
  • TypeDoc now provides warnings if a signature comment is directly specified on a signature and contains @param tags which do not apply, #2368.
  • Extended reflection preview view for interfaces to include type parameters, #2455.
  • Added special cases for converting methods which are documented as returning this or accepting this as a parameter, #2458. Note: This will only happen if a method is declared as method(): this, it will not happen if the method implicitly returns this as the compiler strips that information when creating types for a class instance.
  • Improved handling of functions with properties. Previous TypeDoc versions would always create a separate namespace for properties, now, TypeDoc will create a separate namespace if the function is declaration merged with a namespace. If the properties are added via Object.assign or via property assignment on the function TypeDoc will now instead add the properties to the function's page, #2461.

... (truncated)

Commits

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 the requirements on [typedoc](https://github.com/TypeStrong/TypeDoc) to permit the latest version.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.7...v0.25.8)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
...

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

stackblitz bot commented Feb 12, 2024

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link
Contributor

github-actions bot commented Feb 12, 2024

Preview is ready

Copy link
Contributor

github-actions bot commented Feb 12, 2024

👁 Visual Regression Report for PR #47430 Passed ✅

🎯 Target branch: master (f57ec7f)
📖 View Full Report ↗︎

🎊 Congrats! No visual-regression diff found.

Copy link
Contributor

github-actions bot commented Feb 12, 2024

size-limit report 📦

Path Size
./dist/antd.min.js 333.54 KB
./dist/antd-with-locales.min.js 379.27 KB

Copy link

codesandbox-ci bot commented Feb 12, 2024

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit a0ffa7a:

Sandbox Source
antd reproduction template (forked) Configuration

Signed-off-by: lijianan <574980606@qq.com>
Copy link

codecov bot commented Feb 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f57ec7f) 100.00% compared to head (a0ffa7a) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##            master    #47430   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files          734       734           
  Lines        12593     12593           
  Branches      3298      3298           
=========================================
  Hits         12593     12593           

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

@li-jia-nan li-jia-nan merged commit a886fff into master Feb 12, 2024
108 checks passed
@li-jia-nan li-jia-nan deleted the dependabot/npm_and_yarn/typedoc-tw-0.25.8 branch February 12, 2024 15:06
tanzhenyun pushed a commit to DraculaPrince/mark15 that referenced this pull request Mar 29, 2024
…nt-design#47430)

* chore(deps-dev): update typedoc requirement from ^0.25.7 to ^0.25.8

Updates the requirements on [typedoc](https://github.com/TypeStrong/TypeDoc) to permit the latest version.
- [Release notes](https://github.com/TypeStrong/TypeDoc/releases)
- [Changelog](https://github.com/TypeStrong/typedoc/blob/master/CHANGELOG.md)
- [Commits](TypeStrong/typedoc@v0.25.7...v0.25.8)

---
updated-dependencies:
- dependency-name: typedoc
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>

* Update package.json

Signed-off-by: lijianan <574980606@qq.com>

---------

Signed-off-by: dependabot[bot] <support@github.com>
Signed-off-by: lijianan <574980606@qq.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: lijianan <574980606@qq.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies javascript Pull requests that update Javascript code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant