Skip to content

v2.0.10

Choose a tag to compare

View all tags
@flowzone-app flowzone-app released this 05 Feb 13:02
· 25 commits to master since this release
v2.0.10
95fe29c
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Update dependency typedoc to ^0.27.0

Notable changes

  • Added ignoredHighlightLanguages option to specify languages which will be
  • @include and @includeCode now work in the readme file, #​2814.
  • TypeDoc will now avoid making references to references, #​2811.
  • Fixed output specific option specification, #​2818.
  • Improved type reference conversion to avoid including defaulted type arguments, #​2820.
  • Fixed parsing of declaration references which include a module and a local reference, #​2810.
  • Improved link resolution logic to prioritize type alias properties with the
  • Possibly Breaking: TypeDoc will no longer render anchors within the page for
  • TypeDoc will now warn if a property which does not have a URL within the
  • Fix restoration of groups/categories including documents, #​2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no
  • @​SacDeNoeuds
  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #​2800.
  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #​2796.
  • @include and @includeCode now work for comments on the entry point for projects with a single entry point, #​2800.
  • Cascaded modifier tags will no longer be copied into type literals, #​2802.
  • @summary now works to describe functions within modules, #​2803.
  • Corrected navigation showing module link as current when not on module page, #​2805.
  • Added support for PNG favicons, #​2790.
  • Improved support for hosting TypeDoc with strict Content Security Policy rules, #​2794.
  • Add special handling for import types with type errors discarded with ts-expect-error, #​2792.
  • Fixed low contrast in default colors for properties/accessors in light mode, #​2795.
  • The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #​2798.
  • @​mikalai-snap
  • @​mistic100
  • Fix crash with TypeScript 5.5.x, #​2789.
  • 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.
  • 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
  • Anchors to document headings and reflections within a HTML generated pages
  • Removed the hideParameterTypesInTitle option, this was originally added as
  • Changed the default kindSortOrder to put references last.
  • Changed the default sort order to use alphabetical-ignoring-documents
  • Changed default of suppressCommentWarningsInDeclarationFiles to true
  • API: Constructor signatures now use the parent class name as their name
  • API: @group, @category, @groupDescription and @categoryDescription
  • Add support for TypeScript 5.7
  • TypeDoc will now discover entry points from package.json exports if they
  • Relative links to markdown files may now include #anchor links to
  • Improved support for @param comments with nested object types, #​2555.
  • Improved support for @param comments which reference a type
  • Added a new outputs option which is an array of outputs. This can be used
  • Added support for rendering alerts (or callouts) in markdown.
  • Add support for an @expand tag which can be placed on type aliases and
  • Add support for an @inline tag which can be placed on type aliases and
  • Introduced a new @useDeclaredType tag for type aliases which can sometimes
  • Added a new @mergeModuleWith tag which can be used to tell TypeDoc to
  • Added new @include and @includeCode inline tags to include files within
  • Add notRenderedTags option. This option is similar to the excludeTags
  • Added groupReferencesByType option.
  • Added navigation.excludeReferences option
  • Added useFirstParagraphOfCommentAsSummary option to configure how TypeDoc
  • 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
  • API: Introduced a new app.outputs object for defining new output strategies.
  • API: TypeDoc's CSS is now wrapped in @layer typedoc, #​2782.
  • TypeDoc now properly flags readonly index signatures.
  • TypeDoc will now use the first signature's comment for later signatures in
  • 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
  • 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
  • Added yaml to the highlight languages supported by default.
  • TypeDoc now recognizes txt as an alias of text to indicate a code block
  • Items which are hidden with @ignore or @hidden but still referenced by
  • If a project only has one module within it, TypeDoc will now consider that
  • The arrows to indicate whether or not a section is open now work when
  • Group/category search boosts are now applied when writing the search index
  • @​Huxpro
  • @​mrfigg
  • @​tgreyuk
  • @​XeroAlpha
TypeStrong/TypeDoc (typedoc)

v0.27.6

Compare Source

Features
  • Added ignoredHighlightLanguages option to specify languages which will be
    allowed in code blocks but not highlighted, #​2819.
Bug Fixes
  • @include and @includeCode now work in the readme file, #​2814.
  • TypeDoc will now avoid making references to references, #​2811.
  • Fixed output specific option specification, #​2818.
  • Improved type reference conversion to avoid including defaulted type arguments, #​2820.
  • Fixed parsing of declaration references which include a module and a local reference, #​2810.
  • Improved link resolution logic to prioritize type alias properties with the
    same symbol over type literal properties within function parameters.

v0.27.5

Compare Source

Bug Fixes
  • Possibly Breaking: TypeDoc will no longer render anchors within the page for
    deeply nested properties. This only affects links to properties of
    properties of types, which did not have a clickable link exposed so are
    unlikely to have been linked to. Furthermore, these links were not always
    created by TypeDoc, only being created if all parent properties contained
    comments, #​2808.
  • TypeDoc will now warn if a property which does not have a URL within the
    rendered document and the parent property/page will be linked to instead,
    #​2808. These warnings can be disabled with the validation.rewrittenLink
    option.
  • Fix restoration of groups/categories including documents, #​2801.
  • Fixed missed relative paths within markdown link references in documents.
  • Improved handling of incomplete inline code blocks within markdown.
  • Direct https:// links under the hostedBaseUrl option's URL will no
    longer be treated as external, #​2809.
Thanks!

v0.27.4

Compare Source

Features
  • API: Introduced new Converter.EVENT_CREATE_PROJECT event which fires when a project is created by the converter, #​2800.
Bug Fixes
  • Switch from gzip to deflate for compressing assets to make output consistent across different operating systems, #​2796.
  • @include and @includeCode now work for comments on the entry point for projects with a single entry point, #​2800.
  • Cascaded modifier tags will no longer be copied into type literals, #​2802.
  • @summary now works to describe functions within modules, #​2803.
  • Corrected navigation showing module link as current when not on module page, #​2805.

v0.27.3

Compare Source

Features
  • Added support for PNG favicons, #​2790.
  • Improved support for hosting TypeDoc with strict Content Security Policy rules, #​2794.
Bug Fixes
  • Add special handling for import types with type errors discarded with ts-expect-error, #​2792.
  • Fixed low contrast in default colors for properties/accessors in light mode, #​2795.
  • The highlightLanguages option now permits Shiki aliases to be specified rather than just the language ID, #​2798.
Thanks!

v0.27.2

Compare Source

Bug Fixes
  • Fix crash with TypeScript 5.5.x, #​2789.

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.
  • Added new @include and @includeCode inline tags to include files within
    comments/documents.
  • 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!

List of commits

08b2463 (Update dependency typedoc to ^0.27.0, 2025-01-27)

Assets 3
Loading