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): update dependency typedoc to ^0.27.0 #657

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

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Nov 27, 2024

This PR contains the following updates:

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

Release Notes

TypeStrong/TypeDoc (typedoc)

v0.27.1

Compare Source

Bug Fixes
  • Include classes which inherit from another package in class hierarchy in packages mode, #​2467.
  • Fixed handling of @categoryDescription and @groupDescription on module pages, #​2787.
  • Fixed automatic discovery of entry points in packages mode.
  • Reverted accidental style change for hierarchy page introduced in 0.27.0
  • The hierarchy Expand/Collapse link will now only appear if the hierarchies are different.

v0.27.0

Compare Source

Breaking Changes
  • Convert to ESM to enable easier use of ESM-only dependencies.
  • Drop support for TypeScript <5.0, no longer supported by DefinitelyTyped
  • Relaxed requirements for file names and generated url fragments. This may
    result in a different file name structure, #​2714.
  • Anchors to document headings and reflections within a HTML generated pages
    have changed. They can be partially restored to the previous format by
    setting --sluggerConfiguration.lowercase false. This change was made to
    more closely match the default behavior of GitHub's markdown rendering and
    VSCode's autocomplete when creating a relative link to an external markdown
    file.
  • Removed the hideParameterTypesInTitle option, this was originally added as
    a workaround for many signatures overflowing the available horizontal space
    in rendered pages. TypeDoc now has logic to wrap types/signatures smartly,
    so this option is no longer necessary.
  • Changed the default kindSortOrder to put references last.
  • Changed the default sort order to use alphabetical-ignoring-documents
    instead of alphabetical.
  • Changed default of suppressCommentWarningsInDeclarationFiles to true
  • API: Constructor signatures now use the parent class name as their name
    (e.g. X, not new X)
  • API: @group, @category, @groupDescription and @categoryDescription
    will no longer be removed from the reflections they are present on. They are
    skipped during rendering with the notRenderedTags option.
Features
  • Add support for TypeScript 5.7
  • TypeDoc will now discover entry points from package.json exports if they
    are not provided manually, #​1937.
  • Relative links to markdown files may now include #anchor links to
    reference a heading within them.
  • Improved support for @param comments with nested object types, #​2555.
  • Improved support for @param comments which reference a type
    alias/interface. Important properties on the referenced type can now be
    highlighted with @param options.foo, which will result in the additional
    note being included under the documentation for that parameter, #​2147. Note:
    This feature is limited to references. It is not supported on other types of
    types.
  • Added a new outputs option which is an array of outputs. This can be used
    to render the documentation multiple times with different rendering options
    or output types, #​2597.
  • Added support for rendering alerts (or callouts) in markdown.
  • Add support for an @expand tag which can be placed on type aliases and
    interfaces. When a type with @expand is referenced and TypeDoc has a place
    to include additional details about the type, the properties of the type
    will be included in the page where @expand is found. Note that use of this
    tag can significantly increase the size of your generated documentation if
    it is applied to commonly used types as it will result in inlining the
    comments for those types everywhere they are referenced, #​2303.
  • Add support for an @inline tag which can be placed on type aliases and
    interfaces. When a type with @inline is referenced, TypeDoc will resolve
    the referenced type and convert the type as if it was included directly
    within the referencing type. Note that use of this tag can significantly
    increase the size of your generated documentation if it is applied to
    commonly used types as it will result in inlining the comments for those
    types everywhere they are referenced, #​2303.
  • Introduced a new @useDeclaredType tag for type aliases which can sometimes
    improve their documentation, #​2654..
  • Added a new @mergeModuleWith tag which can be used to tell TypeDoc to
    place a module/namespace's children under a different module/namespace and
    remove the real parent, #​2281.
  • Add notRenderedTags option. This option is similar to the excludeTags
    option, but while excludeTags will result in the tag being completely
    removed from the documentation, notRenderedTags only prevents it from
    being included when rendering.
  • Added groupReferencesByType option.
  • Added navigation.excludeReferences option
  • Added useFirstParagraphOfCommentAsSummary option to configure how TypeDoc
    handles comments for module members without the @summary tag.
  • Introduced favicon option to specify a .ico or .svg favicon to reference.
  • Sections within the page and in the "On This Page" navigation are now tied
    together and will expand/collapse together, #​2335.
  • API: Introduced a new app.outputs object for defining new output strategies.
  • API: TypeDoc's CSS is now wrapped in @layer typedoc, #​2782.
Bug Fixes
  • TypeDoc now properly flags readonly index signatures.
  • TypeDoc will now use the first signature's comment for later signatures in
    overloads if present, #​2718.
  • Fixed handling of @enum if the type was declared before the variable, #​2719.
  • Fixed empty top level modules page in packages mode, #​2753.
  • TypeDoc can now link to type alias properties, #​2524.
  • TypeDoc will now document the merged symbol type when considering globals
    declared inside declare global, #​2774
  • TypeDoc now converts declare module "foo" as a module rather than a namespace, #​2778.
  • Import types in type aliases now use module member references if present, #​2779.
  • Fixed an issue where properties were not properly marked optional in some
    cases. This primarily affected destructured parameters.
  • Added yaml to the highlight languages supported by default.
  • TypeDoc now recognizes txt as an alias of text to indicate a code block
    should not be highlighted.
  • Items which are hidden with @ignore or @hidden but still referenced by
    other types will no longer produce warnings about not being exported.
  • If a project only has one module within it, TypeDoc will now consider that
    module when resolving @link tags.
  • The arrows to indicate whether or not a section is open now work when
    JavaScript is disabled.
  • Group/category search boosts are now applied when writing the search index
    rather than when converting. This prevents issues where boosts used by just
    one package were incorrectly reported as unused when running with
    entryPointStrategy set to packages.
Thanks!

v0.26.11

Compare Source

Features
  • If hostedBaseUrl is set to the root page on a website, TypeDoc will now include WebSite structured data, #​2760.
Bug Fixes
  • Fix support for ESM config files with Node 23, #​2752.
  • Fix type errors when using "module": "ESNext" and importing TypeDoc, #​2747.
  • Inherited comments on overloaded methods now consider the overload position when inheriting a comment, #​2755.

v0.26.10

Compare Source

Bug Fixes
  • Fixed missing space on page headers, #​2748.

v0.26.9

Compare Source

Features
  • Added headings option to control optional headings, #​2729.
  • Updated Chinese translations, #​2739.
  • Added a folder icon to page navigation elements which are not links, #​2741.
Bug Fixes
  • externalSymbolLinkMappings now uses the TypeScript reported link target if available, #​2725.
  • TypeDoc will no longer omit the modules page if a project contains only modules/documents, #​2730.
  • Fixed missing breadcrumbs on project page, #​2728.
  • TypeDoc will no longer render an empty readme page if no readme was found.
Thanks!

v0.26.8

Compare Source

Features
  • Updated Chinese translations, #​2706.
  • Exported constants no longer render the type and default value if they are the same, #​2717.
  • The HTML output now wraps tag blocks with <div> tags and includes the tag name in a class name, #​2723.
Bug Fixes
  • Correctly handle external link resolver link text when referencing an external symbol, #​2700.
  • Big integer literals are now supported as default values, #​2721.
  • Corrected handling of @link tags present in comments at the start of source files.
  • The index will now display when a module only contains documents, #​2722.
  • ReflectionSymbolId.pos no longer references the position before any doc comments for a symbol.
    This could cause typedoc-plugin-dt-links to produce links which didn't go to the expected location in a file.
Thanks!

v0.26.7

Compare Source

Features
  • Support TypeScript 5.6, #​2699.
  • Added customJs option to include a script tag in generated HTML output, #​2650.
  • Added markdownLinkExternal option to treat http[s]:// links in markdown documents and comments as external to be opened in a new tab, #​2679.
  • Added navigation.excludeReferences option to prevent re-exports from appearing in the left hand navigation, #​2685.
  • Added support for the @abstract tag, #​2692.
Bug Fixes
  • Fixed an issue where links in packages mode would be resolved incorrectly, #​2680.
  • @link tags to symbols which are not included in the documentation will produce invalid link warnings again, #​2681.
  • Fixed handling of @param tags on comments attached to function callback parameters, #​2683.
  • The alphabetical and alphabetical-ignoring-documents sort options now use localeCompare to sort, #​2684.
  • Fixed incorrect placement of parameter default values in some signatures with a this parameter, #​2698.
Thanks!

v0.26.6

Compare Source

Features
  • Use of the @extends block tag no longer produces warnings, #​2659.
    This tag should only be used in JavaScript projects to specify the type parameters used when extending a parent class. It will not be rendered.
  • Added new navigation.compactFolders option to prevent TypeDoc from compacting folders, similar to the VSCode option. #​2667.
Bug Fixes
  • The suppressCommentWarningsInDeclarationFiles option now correctly ignores warnings in .d.cts and .d.mts files, #​2647.
  • Restored re-exports in the page navigation menu, #​2671.
  • JSON serialized projects will no longer contain reflection IDs for other projects created in the same run. Gerrit0/typedoc-plugin-zod#6.
  • In packages mode the reflection ID counter will no longer be reset when converting projects. This previously could result in links to files not working as expected.

v0.26.5

Compare Source

Features
  • TypeDoc now exposes array option defaults under OptionDefaults, #​2640.
Bug Fixes
  • Constructor parameters which share a name with a property on a parent class will no longer inherit the comment on the parent class, #​2636.
  • Packages mode will now attempt to use the comment declared in the comment class for inherited members, #​2622.
  • TypeDoc no longer crashes when @document includes an empty file, #​2638.
  • API: Event listeners added later with the same priority will be called later, #​2643.
Thanks!

v0.26.4

Compare Source

Bug Fixes
  • The page navigation sidebar no longer incorrectly includes re-exports if the same member is exported with multiple names #​2625.
  • Page navigation now ensures the current page is visible when the page is first loaded, #​2626.
  • If a relative linked image is referenced multiple times, TypeDoc will no longer sometimes produce invalid links to the image #​2627.
  • @link tags will now be validated in referenced markdown documents, #​2629.
  • @link tags are now resolved in project documents, #​2629.
  • HTML/JSON output generated by TypeDoc now contains a trailing newline, #​2632.
  • TypeDoc now correctly handles markdown documents with CRLF line endings, #​2628.
  • @hidden is now properly applied when placed in a function implementation comment, #​2634.
  • Comments on re-exports are now rendered.
Thanks!

v0.26.3

Compare Source

Features
  • "On This Page" navigation now includes the page groups in collapsible sections, #​2616.
Bug Fixes
  • mailto: links are no longer incorrectly recognized as relative paths, #​2613.
  • Added @since to the default list of recognized tags, #​2614.
  • Relative paths to directories will no longer cause the directory to be copied into the media directory, #​2617.

v0.26.2

Compare Source

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

Compare Source

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!

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 was generated by Mend Renovate. View the repository job log.

@renovate renovate bot added the Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR label Nov 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Maintenance Any dependency, housekeeping, and clean up Issue or PR
Projects
Status: 👀 In review
Development

Successfully merging this pull request may close these issues.

0 participants