pulumi-appsync-modules
pulumi-appsync-modules copied to clipboard
chore(deps): update dependency typedoc to ^0.25.0
This PR contains the following updates:
Package | Change | Age | Adoption | Passing | Confidence |
---|---|---|---|---|---|
typedoc (source) | ^0.20.36 -> ^0.25.0 |
Release Notes
TypeStrong/TypeDoc (typedoc)
v0.25.12
Bug Fixes
- Updated page font to work around issues with Mac rendering, #2518
Thanks!
v0.25.11
Bug Fixes
- Fixed an issue introduced with 0.25.10 which causes the page index to initially render empty, #2514.
- "On This Page" section is now smarter when handling page headings which do not follow the normal
h1>h2>h3
process, #2515.
v0.25.10
Bug Fixes
- Constructed references to enum types will be properly linked with
@interface
, #2508. - Comments on property-methods will no longer be duplicated in generated documentation, #2509.
- Reduced rendered docs size by writing icons to a referenced SVG asset, #2505. For TypeDoc's docs, this reduced the rendered documentation size by ~30%.
- The HTML docs now attempt to reduce repaints caused by dynamically loading the navigation, #2491.
- When navigating to a link that contains an anchor, the page will now be properly highlighted in the page navigation.
v0.25.9
Features
- Literal numeric unions will now be sorted during conversion, #2502.
Bug Fixes
- Module readmes will now be included in JSON output, #2500.
- Fixed crash when
--excludeNotDocumented
was used and the project contained a reference to a removed signature, #2496. - Fixed crash when converting an infinitely recursive type via a new
--maxTypeConversionDepth
option, #2507. - Type links in "Parameters" and "Type Parameters" sections of the page will now be correctly colored.
Thanks!
v0.25.8
v0.25.7
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
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
v0.25.4
Features
- Added support for TypeScript 5.3, #2446.
- TypeDoc will now render interfaces as code at the top of the page describing interfaces, #2449.
This can be controlled through the new
DefaultThemeRenderContext.reflectionPreview
helper. - Improved type rendering to highlight keywords differently than symbols.
Bug Fixes
- Fixed automatic declaration file resolution on Windows, #2416.
- Fixed default option values on options declared by plugins in packages mode, #2433.
-
gitRevision
will now be replaced insourceLinkTemplate
, #2434. - Improved handling of function-modules created with
Object.assign
, #2436. - TypeDoc will no longer warn about duplicate comments with warnings which point to a single comment, #2437
- Fixed an infinite loop when
skipLibCheck
is used to ignore some compiler errors, #2438. -
@example
tag titles will now be rendered in the example heading, #2440. - Correctly handle transient symbols in
@namespace
-created namespaces, #2444. - TypeDoc no longer displays the "Hierarchy" section if there is no inheritance hierarchy to display.
- Direct links to individual signatures no longer results in the signature being partially scrolled off the screen.
Thanks!
v0.25.3
Features
- Added
--sourceLinkExternal
option to render source code links as external, #2415. - TypeDoc no longer requires the
declarationMap
option to be set to true to handle cross-package links in packages mode, #2416. - Added
external-last
option for the--sort
option, #2418.
Bug Fixes
- TypeDoc now attempts to correct local anchor links in readme files which are broken by its deconfliction logic, #2413.
- TypeDoc now finds comments on index signatures again, #2414.
- TypeDoc now does a better job of detecting properties when destructured function arguments are used.
- Quotes will now be properly escaped in HTML attribute values.
Thanks!
v0.25.2
Features
- Added
navigationLeaves
option to remove branches from the navigation tree, #2382. - Added
sortEntryPoints
option (defaults to true) to allow disabling entry point sorting, #2393. - Improved support for multi-word searches, #2400.
Bug Fixes
- Fixed conversion of
@template
constraints on JSDoc defined type parameters, #2389. - Invalid link validation is now correctly suppressed before all projects have been converted in packages mode, #2403.
- Fixed tsconfig handling for projects using a solution-style tsconfig, #2406.
- Fixed broken settings icons caused by icon caching introduced in 0.25.1, #2408.
- Corrected module comment handling on declaration files containing a single
declare module "foo"
, #2401.
Thanks!
v0.25.1
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 rendersnavigation.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 onDefaultThemeRenderContext.iconCache
being rendered within each page. TypeDoc does it in thedefaultLayout
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!
v0.25.0
Breaking Changes
- Bump minimum Node version to 16.
- Removed
legacy-packages
option for--entryPointStrategy
. - Changed default value of
--categorizeByGroup
tofalse
. - Specifying a link as the
gitRemote
is no longer supported. - An
Application
instance must now be retrieved viaApplication.bootstrap
orApplication.bootstrapWithPlugins
, #2268. - Removed
ReflectionKind.ObjectLiteral
that was never used by TypeDoc. - Removed deprecated members
DefaultThemeRenderContext.comment
andDefaultThemeRenderContext.attemptExternalResolution
.
Features
- Added support for TypeScript 5.2, #2373.
- TypeDoc config files now support options default-exported from an ESM config file, #2268.
- TypeDoc config files may now export a promise containing configuration, #2268.
- Added
--preserveLinkText
option (defaults to true) which determines whether the reflection name or full link text is included in the output when no override is specified, #2355. - Added a no-results placeholder when no search results are available, #2347.
- Implemented several miscellaneous performance improvements to generate docs faster, this took the time to generate TypeDoc's site from ~5.6 seconds to ~5.4 seconds.
- Added
--disableGit
option to prevent TypeDoc from using Git to try to determine if sources can be linked, #2326. - Added support for tags
@showGroups
,@hideGroups
,@showCategories
,@hideCategories
to configure the navigation pane on a per-reflection basis, #2329. - With
--jsDocCompatibility.defaultTags
set,@defaultValue
is now implicitly a code block if the text contains no code, #2370.
Bug Fixes
- Fixed link discovery if nested (
Foo#bar
) links were used and--useTsLinkResolution
is enabled in some cases, #2360. - Links with invalid declaration references will no longer silently link to the wrong page in some cases, #2360.
- Fixed duplicate definitions in type hierarchy when using packages mode, #2327.
-
@inheritDoc
was not properly resolved across packages in packages mode, #2331. - Added warning for attempted
@interface
use on union types, #2352. - Fixed misleading type annotation on
Theme.getUrls
, #2318. - Fixed duplicate namespace in documentation if
@namespace
is used on a variable with an associated namespace, #2364. - Fixed
@namespace
property discovery if merged with a type and the type was declared first #2364. - Tables in markdown are now styled, #2366.
- Sidebar links no longer open in a new tab, #2353.
- Headers now include some padding before rendering text, #2316.
- Symbol locations for signatures on
reflection.sources
now considers the node's name like non-signature location discovery does.
Thanks!
v0.24.8 (2023-06-04)
Features
- Added support for TypeScript 5.1, #2296.
- Added
navigation.fullTree
to control rendering the full navigation tree on each page, #2287. This option will likely be replaced in 0.25 with dynamic loading of the full tree. - TypeDoc's
--pretty
option now also controls whether generated HTML contains line breaks, #2287. - Optimized icon caching to reduce file size in generated HTML documentation, #2287.
- Render property description of "roughly top level" object types, #2276.
- Added
MarkdownEvent.INCLUDE
for plugins, #2284.
Bug Fixes
- When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type, and any other block tags in the order they are defined in the comment, #2285.
- Comments are no longer removed from classes/interfaces containing call signatures, #2290.
Thanks!
v0.24.7 (2023-05-08)
Features
- TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.
Bug Fixes
- Category children are now sorted according to the
sort
option, #2272. - Inline tags no longer require a space after the tag name to be parsed as a tag, #2273.
- Fixed module/namespace links in navigation when viewed in Safari, #2275.
v0.24.6 (2023-04-24)
Features
- Improved error messaging if a provided entry point could not be converted into a documented module reflection, #2242.
- API: Added support for
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259. - Extended
jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags andignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.
Bug Fixes
-
--useTsLinkResolution
is no longer ignored within block tags, #2260. - The current namespace will also be expanded in the navigation on page load, #2260.
- Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
- Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.
Thanks!
v0.24.5 (2023-04-22)
Features
- Categories and groups can now be shown in the navigation, added
--navigation.includeCategories
and--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option also effects this behavior. IfcategorizeByGroup
is set (the default) andnavigation.includeGroups
is not set, the value ofnavigation.includeCategories
will be effectively ignored since categories will be created only within groups, #1532. - Added support for discovering a "module" comment on global files, #2165.
- Added copy code to clipboard button, #2153.
- Function
@returns
blocks will now be rendered with the return type, #2180. - Added
--groupOrder
option to specify the sort order of groups, #2251.
Bug Fixes
- Type parameter constraints now respect the
--hideParameterTypesInTitle
option, #2226. - Even more contrast fixes, #2248.
- Fix semantic highlighting for predicate type's parameter references, #2249.
- Fixed broken links to heading titles.
- Fixed inconsistent styling between type parameter lists and parameter lists.
- TypeDoc will now warn if more than one
@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.
Thanks!
v0.24.4 (2023-04-16)
Bug Fixes
- Fixed broken semantic coloring, #2247.
- Increased contrast for parameter titles in dark mode to meet WCAG AA contrast requirements, #2244.
- Underline color of index links now matches the text color, #2245.
- Increased contract for active menu item text in dark mode.
v0.24.3 (2023-04-16)
Bug Fixes
v0.24.2 (2023-04-15)
Features
- Added semantic link coloring for reflection names & links, #2227.
Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
complicated signatures as such, TypeDoc now only renders parameter names in the signature title
and includes the type in the parameter details as usual. This can be controlled with the new
--hideParameterTypesInTitle
option. - Conditional types will now render their branches on the next line for easier comprehension.
Bug Fixes
- Fixed
&
showing as&
and HTML text showing up in page contents navigation, #2224. - Increased padding between sections when one navigation column is displayed, #2225.
- Correct padding for navigation elements with a displayed icon, #2229.
- Fixed
source-order
sort strategy failing to compare reflections within a file. - Added
enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237. - Updated highlight colors for semantic links to meet WCAG AA contrast requirements, #2228.
- Type parameters are now highlighted consistently, #2230.
- Fixed semantic coloring in type and function signatures, #2227.
- Fixed issue where removing a reflection indirectly containing an object/function type would only partially remove the reflection, #2231.
- Fixed "Implementation of X.y" links if a mixture of methods and property-methods are used, #2233.
- "Implementation of" text to symbol-properties not contained in the documentation will now use the resolved name instead of a
__@​
symbol name, #2234. - Fix expansion of globs if a single entry point is provided, #2235.
- Validation will no longer be skipped for sub packages when running with
--entryPointStrategy packages
. - Fixed broken theme toggle if the page contained a member named "theme".
Thanks!
v0.24.1 (2023-04-09)
Bug Fixes
- Improve detection for legacy JSDoc
@example
tags, #2222. - The page footer will now appear at the bottom of the page even if the page is short, #2223.
v0.24.8
Features
- Added support for TypeScript 5.1, #2296.
- Added
navigation.fullTree
to control rendering the full navigation tree on each page, #2287. This option will likely be replaced in 0.25 with dynamic loading of the full tree. - TypeDoc's
--pretty
option now also controls whether generated HTML contains line breaks, #2287. - Optimized icon caching to reduce file size in generated HTML documentation, #2287.
- Render property description of "roughly top level" object types, #2276.
- Added
MarkdownEvent.INCLUDE
for plugins, #2284.
Bug Fixes
- When rendering functions/methods, TypeDoc will now render the comment summary above the parameters/return type, and any other block tags in the order they are defined in the comment, #2285.
- Comments are no longer removed from classes/interfaces containing call signatures, #2290.
Thanks!
v0.24.7
Features
- TypeDoc will now allow conversion without any entry points to support "readme only" packages, #2264.
Bug Fixes
- Category children are now sorted according to the
sort
option, #2272. - Inline tags no longer require a space after the tag name to be parsed as a tag, #2273.
- Fixed module/namespace links in navigation when viewed in Safari, #2275.
v0.24.6
Features
- Improved error messaging if a provided entry point could not be converted into a documented module reflection, #2242.
- API: Added support for
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259. - Extended
jsDocCompatibility
option withinheritDocTag
to ignore fully lowercaseinheritDoc
tags andignoreUnescapedBraces
to disable warnings about unescaped{
and}
characters in comments.
Bug Fixes
-
--useTsLinkResolution
is no longer ignored within block tags, #2260. - The current namespace will also be expanded in the navigation on page load, #2260.
- Fixed flicker of navigation pane when reloading a page caused by updating expansion state after the page was loaded.
- Fixed an infinite loop if more than one entry point was provided, and all entry points were the same.
Thanks!
v0.24.5
Features
- Categories and groups can now be shown in the navigation, added
--navigation.includeCategories
and--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option also effects this behavior. IfcategorizeByGroup
is set (the default) andnavigation.includeGroups
is not set, the value ofnavigation.includeCategories
will be effectively ignored since categories will be created only within groups, #1532. - Added support for discovering a "module" comment on global files, #2165.
- Added copy code to clipboard button, #2153.
- Function
@returns
blocks will now be rendered with the return type, #2180. - Added
--groupOrder
option to specify the sort order of groups, #2251.
Bug Fixes
- Type parameter constraints now respect the
--hideParameterTypesInTitle
option, #2226. - Even more contrast fixes, #2248.
- Fix semantic highlighting for predicate type's parameter references, #2249.
- Fixed broken links to heading titles.
- Fixed inconsistent styling between type parameter lists and parameter lists.
- TypeDoc will now warn if more than one
@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.
Thanks!
v0.24.4
Bug Fixes
- Fixed broken semantic coloring, #2247.
- Increased contrast for parameter titles in dark mode to meet WCAG AA contrast requirements, #2244.
- Underline color of index links now matches the text color, #2245.
- Increased contract for active menu item text in dark mode.
v0.24.3
Bug Fixes
v0.24.2
Features
- Added semantic link coloring for reflection names & links, #2227.
Note: This resulted in function signatures becoming too busy for easy scanning with even slightly
complicated signatures as such, TypeDoc now only renders parameter names in the signature title
and includes the type in the parameter details as usual. This can be controlled with the new
--hideParameterTypesInTitle
option. - Conditional types will now render their branches on the next line for easier comprehension.
Bug Fixes
- Fixed
&
showing as&
and HTML text showing up in page contents navigation, #2224. - Increased padding between sections when one navigation column is displayed, #2225.
- Correct padding for navigation elements with a displayed icon, #2229.
- Fixed
source-order
sort strategy failing to compare reflections within a file. - Added
enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237. - Updated highlight colors for semantic links to meet WCAG AA contrast requirements, #2228.
- Type parameters are now highlighted consistently, #2230.
- Fixed semantic coloring in type and function signatures, #2227.
- Fixed issue where removing a reflection indirectly containing an object/function type would only partially remove the reflection, #2231.
- Fixed "Implementation of X.y" links if a mixture of methods and property-methods are used, #2233.
- "Implementation of" text to symbol-properties not contained in the documentation will now use the resolved name instead of a
__@​
symbol name, #2234. - Fix expansion of globs if a single entry point is provided, #2235.
- Validation will no longer be skipped for sub packages when running with
--entryPointStrategy packages
. - Fixed broken theme toggle if the page contained a member named "theme".
Thanks!
v0.24.1
Bug Fixes
- Improve detection for legacy JSDoc
@example
tags, #2222. - The page footer will now appear at the bottom of the page even if the page is short, #2223.
v0.24.0
Breaking Changes
-
@link
,@linkcode
and@linkplain
tags will now be resolved with TypeScript's link resolution by default. TheuseTsLinkResolution
option can be used to turn this behavior off, but be aware that doing so will mean your links will be resolved differently by editor tooling and TypeDoc. - TypeDoc will no longer automatically load plugins from
node_modules
. Specify the--plugin
option to indicate which modules should be loaded. - The
packages
entry point strategy will now run TypeDoc in each provided package directory and then merge the results together. The previouspackages
strategy has been preserved underlegacy-packages
and will be removed in 0.25. If the new strategy does not work for your use case, please open an issue. - Removed
--logger
option, to disable all logging, set thelogLevel
option tonone
. - Dropped support for legacy
[[link]]
s, removed deprecatedReflection.findReflectionByName
. - Added
@overload
to default ignored tags.
API Breaking Changes
- The
label
property onReflection
has moved toComment
. - The default value of the
out
option has been changed from""
to"./docs"
, #2195. - Renamed
DeclarationReflection#version
toDeclarationReflection#projectVersion
to match property onProjectReflection
. - Removed unused
Reflection#originalName
. - Removed
Reflection#kindString
, useReflectionKind.singularString(reflection.kind)
orReflectionKind.pluralString(reflection.kind)
instead. - The
named-tuple-member
andtemplate-literal
type kind have been replaced withnamedTupleMember
andtemplateLiteral
, #2100. - Properties related to rendering are no longer stored on
Reflection
, includingurl
,anchor
,hasOwnDocument
, andcssClasses
. -
Application.bootstrap
will no longer load plugins. If you want to load plugins, useApplication.bootstrapWithPlugins
instead, #1635. - The options passed to
Application.bootstrap
will now be applied both before and after reading options files, which may cause a change in configuration if using a custom script to run TypeDoc that includes some options, but other options are set in config files. - Moved
sources
property previously declared on baseReflection
class toDeclarationReflection
andSignatureReflection
. - Moved
relevanceBoost
fromContainerReflection
toDeclarationReflection
since setting it on the parent class has no effect. - Removed internal
ReferenceType.getSymbol
, reference types no longer reference thets.Symbol
to enable generation from serialized JSON. -
OptionsReader.priority
has been renamed toOptionsReader.order
to more accurately reflect how it works. -
ReferenceType
s which point to type parameters will now always be intentionally broken since they were never linked and should not be warned about when validating exports. -
ReferenceType
s now longer include anid
property for their target. They now instead include atarget
property. - Removed
Renderer.addExternalSymbolResolver
, useConverter.addExternalSymbolResolver
instead. - Removed
CallbackLogger
. - Removed
SerializeEventData
from serialization events. - A
PageEvent
is now required forgetRenderContext
. If caching the context object,page
must be updated whengetRenderContext
is called. -
PageEvent
no longer includes thetemplate
property. TheTheme.render
method is now expected to take the template to render the page with as its second argument. - Removed
secondaryNavigation
member onDefaultThemeRenderContext
. - Renamed
navigation
tosidebar
onDefaultThemeRenderContext
andnavigation.begin
/navigation.end
hooks tosidebar.begin
/sidebar.end
.
Features
- Added
--useTsLinkResolution
option (on by default) which tells TypeDoc to use TypeScript's@link
resolution. - Added
--jsDocCompatibility
option (on by default) which controls TypeDoc's automatic detection of code blocks in@example
and@default
tags. - Reworked default theme navigation to add support for a page table of contents, #1478, #2189.
- Added support for
@interface
on type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519 - Added support for
@namespace
on variable declarations to tell TypeDoc to convert the variable as a namespace, #2055. - Added support for
@prop
/@property
to specify documentation for a child property of a symbol, intended for use with@interface
. - TypeDoc will now produce more informative error messages for options which cannot be set from the cli, #2022.
- TypeDoc will now attempt to guess what option you may have meant if given an invalid option name.
- Plugins may now return a
Promise<void>
from theirload
function, #185. - TypeDoc now supports plugins written with ESM, #1635.
- Added
Renderer.preRenderAsyncJobs
andRenderer.postRenderAsyncJobs
, which may be used by plugins to perform async processing for rendering, #185. Note: Conversion is still intentionally a synchronous process to ensure stability of converted projects between runs. - TypeDoc options may now be set under the
typedocOptions
key inpackage.json
, #2112. - Added
--cacheBust
option to tell TypeDoc to include include the generation time in files, #2124. - Added
--excludeReferences
option to tell TypeDoc to omit re-exports of a symbol already included from the documentation. - Introduced new render hooks
pageSidebar.begin
andpageSidebar.end
.
Bug Fixes
- TypeDoc will now ignore package.json files not containing a
name
field, #2190. - Fixed
@inheritDoc
on signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature. - Interfaces/classes created via extending a module will no longer contain variables/functions where the member should have been converted as properties/methods, #2150.
- TypeDoc will now ignore a leading
v
in versions, #2212. - Category titles now render with the same format in the page index and heading title, #2196.
- Fixed crash when using
typeof
on a reference with type arguments, #2220. - Fixed broken anchor links generated to signatures nested within objects.
Thanks!
v0.23.28 (2023-03-19)
Features
- Added support for TypeScript 5.0, #2201.
-
const
type parameters. - JSDoc
@overload
tag. - JSDoc
@satisfies
tag.
-
v0.23.27 (2023-03-16)
Features
- Added
--treatValidationWarningsAsErrors
to treat only validation warnings as errors without treating all warnings as errors, #2199.
Bug Fixes
- Fixed a bug where optional properties were not appropriately marked as optional, #2200.
- Fixed shifted navigation pane on devices 1024px wide, #2191.
- Add missing
@private
and@protected
tags totypedoc/tsdoc.json
, #2187.
Thanks!
v0.23.26 (2023-02-26)
Features
- Added
Application.EVENT_VALIDATE_PROJECT
event for plugins which implement custom validation, #2183. - Plugins may now return an object from external symbol resolvers, #2066.
- Expose
Comment.displayPartsToMarkdown
on for themes overwriting thecomment
helper, #2115.
Bug Fixes
- Fix crash when converting
export default undefined
, #2175. - Fix error in console when clicking on headings in the readme, #2170.
- TypeDoc will now ignore parameters of callback parameters when validating that all parameters have documentation, #2154.
Thanks!
v0.23.25 (2023-02-11)
Breaking Changes
- Upgraded Shiki, if your highlight theme was set to
material-<theme>
, the value will need to be changed tomaterial-theme-<theme>
, see the Shiki release notes.
Features
- Added new
excludeNotDocumentedKinds
variable to control which reflection types can be removed by theexcludeNotDocumented
option, #2162. - Added
typedoc.jsonc
,typedoc.config.js
,typedoc.config.cjs
,typedoc.cjs
to the list of files which TypeDoc will automatically use as configuration files.
Bug Fixes
- Entry points under
node_modules
will no longer be ignored, #2151. - Corrected behavior of
excludeNotDocumented
on arrow function-variables, #2156. - Added
package.json
to exports declaration.
Thanks!
v0.23.24 (2023-01-07)
Bug Fixes
- Fixed an issue where signature comments were preferred over property comments for indirectly created function-properties, #2135.
- Fixed symlink handling when expanding entry points, #2130.
Thanks!
v0.23.23 (2022-12-18)
Features
- Added
ts.Signature
to emittedEVENT_CREATE_SIGNATURE
event, #2002.
Bug Fixes
- Links to members hidden by filter settings now temporarily override the filter, #2092.
- If
src/
andsrc/x
are specified as entry points,src/
will no longer be ignored, #2121.
v0.23.22 (2022-12-11)
Features
- Add support for defining the kind sort order, #2109.
Bug Fixes
v0.23.21 (2022-11-14)
Features
- Added support for a catch-all wildcard in
externalSymbolLinkMappings
, #2102. - Added support for TypeScript 4.9.
Thanks!
v0.23.20 (2022-11-03)
Bug Fixes
- Fixed comment discovery for
@inheritDoc
if inheriting from a function type alias, #2087.
v0.23.19 (2022-10-28)
Bug Fixes
- Fixed title link if
titleLink
option was not specified, #2085.
Thanks!
v0.23.18 (2022-10-23)
Features
Bug Fixes
- Constructor parameter-properties will now use the
@param
comment for the parameter if available, #1261. - Fixed display of object types containing methods, #1788.
- Fixed conversion of intrinsic string mapping types when converting without a type node, #2079.
v0.23.17 (2022-10-18)
Features
- Added
titleLink
,navigationLinks
andsidebarLinks
options to add additional links to the rendered output, #1830. - Added
sourceLinkTemplate
option to allow more flexible specification of remote urls. Deprecated now redundantgitRevision
detection starting withhttps?://
introduced in v0.23.16, #2068.
Thanks!
v0.23.16 (2022-10-10)
Features
- Object types will now be pretty printed, #1793.
- Added support for specifying the tsconfig.json file in packages mode with
{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}
in package.json, #2061. - In packages mode, readme files will now be automatically included if present, #2065.
- Added support for specifying the base file url for links to source code, #2068.
Bug Fixes
- Private parameter properties will no longer be ignored, #2064.
Thanks!
v0.23.15 (2022-09-18)
Features
- TypeDoc will now treat
@typedef {import("foo").Bar<Z>} Baz
type declarations which forward type parameters to the imported symbol as re-exports of that symbol, #2044.
Bug Fixes
- TypeDoc will now prefer comments on variable declarations over signature comments, #2042.
- Fixed double rendering of "Type Parameters" header, #2054.
- Fixed double rendering of "Hierarchy" header, #2053.
- Removed unused
widgets.png
and[email protected]
files from generated assets folder.
v0.23.14 (2022-09-03)
Features
- Added support for defining one-off external link mappings with
externalSymbolLinkMappings
see the documentation for usage examples and caveats, #2030. - External link resolvers defined with
addUnknownSymbolResolver
will now be checked when resolving@link
tags, #2030. Note: To support this, resolution will now happen during conversion, and as such,Renderer.addUnknownSymbolResolver
has been soft deprecated in favor ofConverter.addUnknownSymbolResolver
. Plugins should update to use the method onConverter
.DefaultThemeRenderContext.attemptExternalResolution
has also been deprecated since it will repeat work done during conversion, useReferenceType.externalUrl
instead. - Added
Converter.addUnknownSymbolResolver
for use by plugins supporting external links.
Bug Fixes
- Fixed conversion of object literal types containing construct signatures, #2036.
- Fixed centering of title bar on wide displays, actually this time, #2046.
v0.23.13 (2022-09-01)
Bug Fixes
- Fixed packages mode bug introduced in 0.23.12, #2043.
v0.23.12 (2022-08-31)
Features
- Added a new
ParameterType.Object
for declaring object options which will be shallowly merged when read from user configuration. - Added a new
Application.EVENT_BOOTSTRAP_END
event emitted whenApplication.bootstrap
is called.
Bug Fixes
- TypeDoc will now work properly in packages mode when converting packages outside the current working directory, #2043.
- Fixed deprecation warning for
isIdentifierOrPrivateIdentifier
. - Fixed centering of title bar on wide displays, #2046.
Thanks!
v0.23.11 (2022-08-26)
Features
- Added support for TypeScript 4.8.
- Introduced a
skipErrorChecking
option which instructs TypeDoc to not ask TypeScript for compiler errors before attempting to generate documentation. Turning this on may improve generation speed, but could also cause a crash if your code contains compiler errors. - Added support for JS entry points when using packages mode, #2037.
Bug Fixes
- Fixed crash when converting abstract mixin class, #2011.
- Readme files within monorepos now have
@link
tags resolved, #2029. - Correctly resolve unqualified links to class members within parameters, #2031.
- TypeDoc will now consider other reflections with the same name as parents when resolving links, #2033.
- The "Hierarchy" and "Type Parameters" helpers on
DefaultThemeRenderContext
now contain all the HTML for their sections of the page, #2038.
Thanks!
v0.23.10 (2022-07-31)
Features
- Added support for detecting comments directly before parameters as the parameter comment, #2019.
- Added support for using the comment directly before a constructor parameter that declares a property as the property comment, #2019.
- Improved schema generation to give better autocomplete for the
sort
option. - Optional properties are now visually distinguished in the index/sidebar by rendering
prop
asprop?
, #2023. -
DefaultThemeRenderContext.markdown
now also accepts aCommentDisplayPart[]
for rendering, #2004. - Expose
Converter.resolveLinks
method for use withConverter.parseRawComment
, #2004.
Bug Fixes
- Fixed schema URL for TSDoc preventing the use of
typedoc/tsdoc.json
in TSDoc extends, #2015. - Improved detection of package names in repositories using pnpm, #2017.
- Fixed missing JSDoc style
@typedef
comments for properties, #2020.
Thanks!
v0.23.9 (2022-07-24)
Bug Fixes
- TypeDoc will no longer skip entry points which have no exports, #2007.
If using
"entryPointStrategy": "expand"
, this change may result in new pages being added to your documentation. If this is not desired, you can use theexclude
option to filter them out. - Fixed missing comments on callable variable-functions constructed indirectly, [#2008](https:
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.