This repository has been archived by the owner on Aug 15, 2022. It is now read-only.
chore(deps): update all non-major dependencies #45
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
^17.0.0
->^17.0.3
^17.0.0
->^17.0.3
^16.11.26
->^16.11.48
^5.17.0
->^5.33.0
^5.17.0
->^5.33.0
v4.2.5
->v4.4.0
v3.0.2
->v3.0.7
^8.12.0
->^8.22.0
^12.3.7
->^12.5.0
^2.6.2
->^2.7.1
^5.12.3
->^5.12.9
^0.22.13
->^0.23.10
^4.6.3
->^4.7.4
3.2.0
->3.2.2
Release Notes
typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)
v5.33.0
Compare Source
Bug Fixes
Features
typescript-eslint/typescript-eslint (@typescript-eslint/parser)
v5.33.0
Compare Source
Note: Version bump only for package @typescript-eslint/parser
JamesIves/github-pages-deploy-action
v4.4.0
Compare Source
What's Changed
New Contributors
Sponsors ❤️
Full Changelog: JamesIves/github-pages-deploy-action@v4...v4.4.0
v4.3.4
Compare Source
Minor Changes
branch
parameter is no longer required. It now defaults togh-pages
.New Contributors
Sponsors ❤️
Full Changelog: JamesIves/github-pages-deploy-action@v4...v4.3.4
v4.3.3
Compare Source
Changes
v4.3.2
Compare Source
Changes
v4.3.1
Compare Source
Changes
safe.directory
global directory.v4.3.0
Compare Source
Changes
force
. If set tofalse
the action will no longer force push, instead attempting 3 times to resolve rejected commits when making parallel/subsequent deployments. In a future versionfalse
will be set as the default. Massive thanks to @rossjrw for this feature addition.14
to16
.Minor Changes
actions/cache
v3.0.7
Compare Source
What's Changed
v3.0.6
Compare Source
What's Changed
New Contributors
Full Changelog: actions/cache@v3...v3.0.6
v3.0.5
Compare Source
Removed error handling by consuming actions/cache 3.0 toolkit, Now cache server error handling will be done by toolkit.
v3.0.4
Compare Source
In this release, we have fixed the tar creation error while trying to create it with path as
~/
home folder onubuntu-latest
.v3.0.3
Compare Source
Fixed avoiding empty cache save when no files are available for caching. (https://github.com/actions/cache/issues/624)
eslint/eslint
v8.22.0
Compare Source
Features
2b97607
feat: Implement caching for FlatESLint (#16190) (Nicholas C. Zakas)fd5d3d3
feat: addmethodsIgnorePattern
option to object-shorthand rule (#16185) (Milos Djermanovic)Documentation
9f5a752
docs: optimize image assets (#16170) (Sam Chen)61b2948
docs: add svgo command to pre commit hook (#16178) (Amaresh S M)784096d
docs: improve search result UI (#16187) (Sam Chen)d0f4cb4
docs: use shorthand property name in example (#16180) (Kevin Elliott)Chores
10a6e0e
chore: remove deploy workflow for playground (#16186) (Milos Djermanovic)TypeStrong/TypeDoc
v0.23.10
Compare Source
Features
sort
option.prop
asprop?
, #2023.DefaultThemeRenderContext.markdown
now also accepts aCommentDisplayPart[]
for rendering, #2004.Converter.resolveLinks
method for use withConverter.parseRawComment
, #2004.Bug Fixes
typedoc/tsdoc.json
in TSDoc extends, #2015.@typedef
comments for properties, #2020.Thanks!
v0.23.9
Compare Source
Bug Fixes
If using
"entryPointStrategy": "expand"
, this change may result in new pages being added to your documentation.If this is not desired, you can use the
exclude
option to filter them out.--includeVersion
flag, #2010.v0.23.8
Compare Source
Features
*.ghe.com
and*.github.us
GitHub enterprise domains for source links, #2001.Converter.parseRawComment
for plugins to parse additional markdown files, #2004.Bug Fixes
{@​link}
containing a URL, #1980.excludeNotDocumented
will no longer remove functions/methods/accessors which are documented, #1994.sources
property on signature reflections #1996.Thanks!
v0.23.7
Compare Source
Bug Fixes
@jest/globals
in a comment will no longer be parsed as a tag #1990.v0.23.6
Compare Source
Features
--entryPointStrategy Packages
. TypeDoc will now load package-specific configurations frompackage.json
typedoc
field. This configuration allows configuring a custom display name (typedoc.displayName
) field, entry point (typedoc.entryPoint
- this is equivalent and will overridetypedocMain
), and path to a readme file to be rendered at the top of the package page (typedoc.readmeFile
), #1658.--includeVersion
option will now be respected by--entryPointStrategy Packages
. Also, for this combination, missingversion
field in the rootpackage.json
will not issue a warning.navigation
partial will now call the newsettings
,primaryNavigation
, andsecondaryNavigation
partials, #1987.Bug Fixes
Thanks!
v0.23.5
Compare Source
Features
DEBUG_SEARCH_WEIGHTS
global variable can now be set onwindow
to add search scoring information in the search results.DefaultThemeRenderContext.icons
for use/modification by themes.v0.23.4
Compare Source
Bug Fixes
--entryPointStrategy Packages
is set, #1976.search.js
generated file.Features
--exclude
option will now be respected by--entryPointStrategy Packages
and can be used to exclude package directories, #1959.IndexEvent
on theRenderer
when preparing the search index, #1953.--searchInComments
option to include comment text in the search index, #1553.Turning this option on will increase the size of your search index, potentially by an order of magnitude.
v0.23.3
Compare Source
Bug Fixes
@example
tag, #1967.intentionallyNotExported
will now properly respect qualified names, #1972.export * as NS
declarations, #1973.export const x = () => 123
function variables, #1973.get
andset
signatures of an accessor have a comment.Features
--htmlLang
option to set thelang
attribute in the generated HTML. Defaults toen
, #1951.--basePath
option to override TypeDoc's detected root directory, #1924.:getter
and:setter
meaning keywords in declaration references.v0.23.2
Compare Source
Bug Fixes
@module
comments in the entry point, #1963.<= 0
due tosearchCategoryBoosts
orsearchGroupBoosts
will be excluded from search.v0.23.1
Compare Source
Features
sort
option.prop
asprop?
, #2023.DefaultThemeRenderContext.markdown
now also accepts aCommentDisplayPart[]
for rendering, #2004.Converter.resolveLinks
method for use withConverter.parseRawComment
, #2004.Bug Fixes
typedoc/tsdoc.json
in TSDoc extends, #2015.@typedef
comments for properties, #2020.Thanks!
v0.23.0
Compare Source
Breaking Changes
{@​link}
tags in comments will now be resolved as declaration references similar to TSDoc's declaration references.For most cases, this will just work. See the documentation for details on how link resolution works.
[[ target ]]
). Use{@​link target}
instead. The{@​link}
syntax will be recognized by TypeScript 4.3 and later and used to provide better intellisense. TypeDoc version 0.24.0 will remove support for[[ target ]]
style links.Support for
[[`links`]]
with brackets + code ticks have been dropped.extends
in typedoc.json is now resolved using NodeJS module resolution, so a local path must begin with./
.DeclarationReflection
s,getSignature
is no longer a one-tuple.DeclarationReflection
s,setSignature
is no longer a one-tuple.DeclarationReflection
s,typeParameter
has been renamed totypeParameters
searchGroupBoosts
option must now be given the rendered group name rather than reflection kind names, and can be given custom group names.@inheritDoc
now follows the behavior specified by TSDoc when copying comments with a reference.gaSite
option has been removed since Google Analytics now infers the site automatically, updated Google Analytics script to latest version, #1846.hideLegend
option has been removed as the default theme no longer contains a legend.listInvalidSymbolLinks
option has been removed. Usevalidation.invalidLink
instead.true
andfalse
values have been removed from--emit
, to migrate replacetrue
with"both"
andfalse
with"docs"
(the default).validation.invalidLink
option is now on by default.reflection.decorates
,reflection.decorators
, and their corresponding interfaces have been removed as no code in TypeDoc used them.Comment
class has changed significantly to support multiple tag kinds.Converter.EVENT_CREATE_TYPE_PARAMETER
andConverter.EVENT_CREATE_DECLARATION
will now never be passed ats.Node
as their third argument.ReflectionFlag.Const
flag set.reflection.defaultValue
is no longer set for enum members. The same information is available onreflection.type
with more precision.removeReaderByName
,addDeclarations
andremoveDeclarationByName
methods onOptions
.ProjectReflection.directory
, it was unused by TypeDoc and not properly tested.ProjectReflection.files
, this was an internal cache that should not have been exposed, and shouldn't have existed in the first place, since removing it made TypeDoc faster.ReflectionGroup.kind
since groups can now be created with the@group
tag.ReflectionKind.Event
, the@event
tag is now an alias for@group Events
. Note: This changes the value ofReflectionKind.Reference
from16777216
to8388608
.Features
TypeDoc now supports the
@group
tag to group reflections in a page. If no@group
tag is specified, reflections will be grouped according to their kind, #1652.TypeDoc will now search for
typedoc.js(on)
in the.config
folder in the current working directory.Entry point strategies
Resolve
andExpand
may now specify globs, #1926.typedoc.json
now supports comments liketsconfig.json
.TypeDoc will now read the
blockTags
,inlineTags
, andmodifierTags
out oftsdoc.json
in the same directory astsconfig.json
if it exists.It is recommended to add
"extends": ["typedoc/tsdoc.json"]
, which defines TypeDoc specific tags to yourtsdoc.json
if you create one.If an exported symbol has multiple declarations, TypeDoc will now check all appropriate declarations for comments, and warn if more than one declaration contains a comment, #1855.
Improved support for JSDoc style
@example
tags. If the tag content does not include a code block, TypeDoc now follows VSCode's behavior of treating the entire block as a code block, #135.TypeDoc will now render members marked with
@deprecated
with a line through their name, #1381.Added new
commentStyle
option which can be used to control what comments TypeDoc will parse./**
//
commentsTypeDoc will now warn if part of a comment will be overwritten due to use of
@inheritDoc
instead of silently dropping part of the comment.Added support for inline
@inheritDoc
tags, #1480.It is now possible to link directly to a specific overload, #1326.
The JSON output will now include URLs to the file on the remote repository if possible.
Added a new
visibilityFilters
option which controls the available filters on a page.TypeDoc will now try to place block elements on a new line in HTML output, resulting in less overwhelming diffs when rebuilding docs, #1923.
Added
blockTags
,inlineTags
,modifierTags
to control which tags TypeDoc will allow when parsing comments.If a tag not in in one of these options is encountered, TypeDoc will produce a warning and use context clues to determine how to parse the tag.
Bug Fixes
Type Parameters
heading if there are no type parameters in some cases.implements
by other interfaces/classes.@inheritDoc
on accessors, #1927.exports.foo = ...
will now be converted as variables rather than properties.searchCategoryBoosts
are now correctly computed for all categories, #1960.excludeNotDocumented
option will no longer hide a module if it has a documentation comment, #1948.--excludeNotDocumented
from hiding properties of type literals (a
infunction fn(p: { a: string })
), #1752.cts
andmts
extensions in packages resolution mode, #1952.Thanks!
v0.22.18 (2022-06-25)
Features
@enum
style enums to also permit non-literal strings and numbers, #1956.Bug Fixes
searchGroupBoosts
was only computing the boost for the first reflection in a group, #1958.Thanks!
v0.22.17 (2022-06-01)
Features
Bug Fixes
v0.22.16 (2022-05-30)
Features
@enum
, #1918.type
set to either aLiteralType
with a string or numeric value or anIntrinsicType
with typenumber
, #1942.Using
defaultValue
onEnumMember
reflections is now deprecated, and will be broken in 0.23.Bug Fixes
enum-value-ascending
orenum-value-descending
sort strategies in mixed string/number enums.Thanks!
v0.22.15 (2022-04-10)
Features
abstract
and enums which areconst
will now be indicated in their rendered documentation, #1874.compilerOptions
, which can be used to override compiler options read fromtsconfig.json
, #1891.content.begin
,content.end
,navigation.begin
,navigation.end
Bug Fixes
undefined
, #1907.Thanks!
v0.22.14 (2022-04-07)
Bug Fixes
@enum
style enum members defined in declaration files, #1880.--validation.notDocumented
warnings for functions/methods/type aliases, #1895, #1898.removeReflection
not completely removing reflections from the project, #1898.@hidden
/@ignore
/@exclude
comments on default exports with no associated variable, #1903.makeRecursiveVisitor
will now correctly call theintersection
callback, #1910.Thanks!
v0.22.13 (2022-03-06)
Features
@param
comments for nested members that target union and intersection types, #1876.Bug Fixes
--requiredToBeDocumented
option, #1872.this
parameters in documentation for some functions, #1875.v0.22.12 (2022-02-20)
Features
--validation.notDocumented
option to warn on items that are not documented, #1817.Bug Fixes
const
variables not properly marked asconst
, #1866.Thanks!
v0.22.11 (2022-01-18)
Features
cname
option for GitHub Pages custom domain support, #1803.ReferenceType
s which reference an external symbol will now includequalifiedName
andpackage
in their serialized JSON.Bug Fixes
h1
andh2
elements being too low, #1796.addUnknownSymbolResolver
will now be correctly given the qualified name to the symbol being referenced, #1832.Thanks!
v0.22.10 (2021-11-25)
Features
Bug Fixes
default
, thedefault
export will now always be the renamed symbol, #1795.@types/node
versions, Gerrit0/typedoc-plugin-missing-exports#5.v0.22.9 (2021-11-14)
Features
It will only work if both loaded TypeDocs are v0.22.9 or later.
typedoc-theme
in their keywords.Plugins which define a custom theme should include this keyword so that they can be automatically collected and displayed at https://typedoc.org/guides/themes/.
Bug Fixes
<meta charset="utf-8" />
appears within the first 1024 bytes of generated pages, #1783.Thanks!
v0.22.8 (2021-11-07)
Features
See the documentation in custom-themes.md for details.
Bug Fixes
@category
tag incorrectly appearing on function types if used on a type alias, #1745.Thanks!
v0.22.7 (2021-10-25)
Features
githubprivate.com
domain, #1743.Bug Fixes
hideGenerator
is set, #1749.@category
tag incorrectly appearing on function types if used on a type alias, #1745.Thanks!
v0.22.6 (2021-10-17)
Features
@enum
to all variables whose property types are string literals, #1740.Bug Fixes
as const
style enums, #1727.@typeParam
on type aliases, #1733.Thanks!
v0.22.5 (2021-10-02)
Features
@param
comments for destructured parameters and rename__namedParameters
to the name specifiedin the
@param
comment if the number of@param
comments match the number of parameters, resolves #1703.intentionallyNotExported
option may now include file names/paths to limit its scope, for example, the followingwill suppress warnings from
Foo
insrc/foo.ts
not being exported, but will not suppress warnings if anotherFoo
declared in
src/utils/foo.ts
is not exported.--emit
option can now be used to more finely control what TypeDoc will emit.both
docs
none
true
both
, for backwards compatibility. Will be removed in 0.23.false
docs
, for backwards compatibility. Will be removed in 0.23.Bug Fixes
<caption>
elements from@example
tags, resolves #1679.emitDeclarationOnly
compiler option is now supported, resolves #1716..json
, resolves #1712.globalThis
namespace, could only be caused by a plugin.Thanks!
Configuration
📅 Schedule: Branch creation - "before 12pm on Sunday" (UTC), 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.
👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.
This PR has been generated by Mend Renovate. View repository job log here.