Releases: balena-io-modules/mocha-pod
Releases · balena-io-modules/mocha-pod
v2.0.10
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 thehostedBaseUrl
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 usealphabetical-ignoring-documents
- Changed default of
suppressCommentWarningsInDeclarationFiles
totrue
- 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 theexcludeTags
- 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 oftext
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
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
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 s...
v2.0.9
v2.0.8
v2.0.7
Update dependency typedoc to ^0.26.0
Notable changes
- If
hostedBaseUrl
is set to the root page on a website, TypeDoc will now includeWebSite
structured data, #2760. - 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.
- Fixed missing space on page headers, #2748.
- 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.
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.
- @lriggle-strib
- @mrfigg
- @XeroAlpha
- 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. - 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.- @Corso02
- Support TypeScript 5.6, #2699.
- Added
customJs
option to include a script tag in generated HTML output, #2650. - Added
markdownLinkExternal
option to treathttp[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. - 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
andalphabetical-ignoring-documents
sort options now uselocaleCompare
to sort, #2684. - Fixed incorrect placement of parameter default values in some signatures with a
this
parameter, #2698. - @Aryakoste
- @waynemwashuma
- Use of the
@extends
block tag no longer produces warnings, #2659. - Added new
navigation.compactFolders
option to prevent TypeDoc from compacting folders, similar to the VSCode option. #2667. - 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.
- TypeDoc now exposes array option defaults under
OptionDefaults
, #2640. - 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.
- @bladerunner2020
- 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.
- @bukowa
- @garrett-hopper
- "On This Page" navigation now includes the page groups in collapsible sections, #2616.
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.
- Added a
--suppressCommentWarningsInDeclarationFiles
option to disable warnings from - Improved comment discovery to more closely match TypeScript's discovery when getting comments
- 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
- Drop support for Node 16.
- Moved from
marked
tomarkdown-it
for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code. - 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.
- Changed default of
--excludePrivate
totrue
. - Renamed
--sitemapBaseUrl
to--hostedBaseUrl
to reflect that it can be used for more than just the sitemap. - Removed deprecated
navigation.fullTree
option. - Removed
--media
option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site. - Removed
--includes
option, use the@document
tag instead. - Removed
--stripYamlFrontmatter
option, TypeDoc will always do this now. - Renamed the
--htmlLang
option to--lang
. - Removed the
--gaId
option for Google Analytics integration and corr...
v2.0.6
Update dependency better-lock to v3
Notable changes
List of commits
61ed53c (Update dependency better-lock to v3, 2024-06-19)