Skip to content

Conversation

@renovate
Copy link
Contributor

@renovate renovate bot commented Sep 14, 2023

Mend Renovate

This PR contains the following updates:

Package Change Age Adoption Passing Confidence
typedoc (source) ^0.25.0 -> ^0.25.1 age adoption passing confidence

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.25.1

Compare Source

Features
  • Added stripYamlFrontmatter config option to remove YAML frontmatter from README.md, #​2381.
  • Added --excludeCategories config option to remove reflections present in any excluded category, #​1407.
  • If no tsconfig.json file is present, TypeDoc will now attempt to compile without setting any compiler options, #​2304.
  • Navigation is now written to a JS file and built dynamically, which significantly decreases document generation time
    with large projects and also provides large space benefits. Themes may now override DefaultTheme.buildNavigation
    to customize the displayed navigation tree, #​2287.
    Note: This change renders navigation.fullTree obsolete. If you set it, TypeDoc will warn that it is being ignored.
    It will be removed in v0.26.
  • The search index is now compressed before writing, which reduces most search index sizes by ~5-10x.
  • TypeDoc will now attempt to cache icons when DefaultThemeRenderContext.icons is overwritten by a custom theme.
    Note: To perform this optimization, TypeDoc relies on DefaultThemeRenderContext.iconCache being rendered within
    each page. TypeDoc does it in the defaultLayout template.
  • Cache URL derivation during generation, #​2386.
Bug Fixes
  • @property now works as expected if used to override a method's documentation.
  • Deprecated functions/methods are now correctly rendered with a struck-out name.
  • --watch mode works again, #​2378.
  • Improved support for optional names within JSDoc types, #​2384.
  • Fixed duplicate rendering of reflection flags on signature parameters, #​2385.
  • TypeDoc now handles the intrinsic keyword if TS intrinsic types are included in documentation.
  • --exclude is now respected when expanding globs in entry points, #​2376.
Thanks!

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@codecov-commenter
Copy link

Codecov Report

Patch and project coverage have no change.

Comparison is base (5a9a063) 100.00% compared to head (6f11bc9) 100.00%.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #862   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           45        45           
  Lines          681       681           
  Branches       133       133           
=========================================
  Hits           681       681           

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

@renovate renovate bot force-pushed the renovate/typedoc-0.x branch from 6f11bc9 to 19e4605 Compare September 14, 2023 09:37
@Vinzius Vinzius added this pull request to the merge queue Sep 14, 2023
Merged via the queue into main with commit b479c69 Sep 14, 2023
@Vinzius Vinzius deleted the renovate/typedoc-0.x branch September 14, 2023 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants