This repository has been archived by the owner on Jan 19, 2024. It is now read-only.
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:
29.5.0
->29.5.1
18.15.11
->18.16.0
5.57.1
->5.59.0
5.57.1
->5.59.0
0.17.15
->0.17.18
8.37.0
->8.39.0
13.2.0
->13.2.1
2.8.7
->2.8.8
^4.0.0
->^5.0.0
^0.23.8
->^0.24.0
5.0.3
->5.0.4
Release Notes
typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)
v5.59.0
Compare Source
Bug Fixes
Features
v5.58.0
Compare Source
Bug Fixes
Features
5.57.1 (2023-04-03)
Bug Fixes
typescript-eslint/typescript-eslint (@typescript-eslint/parser)
v5.59.0
Compare Source
Note: Version bump only for package @typescript-eslint/parser
v5.58.0
Compare Source
Bug Fixes
5.57.1 (2023-04-03)
Note: Version bump only for package @typescript-eslint/parser
evanw/esbuild
v0.17.18
Compare Source
Fix non-default JSON import error with
export {} from
(#3070)This release fixes a bug where esbuild incorrectly identified statements of the form
export { default as x } from "y" assert { type: "json" }
as a non-default import. The bug did not affect code of the formimport { default as x } from ...
(only code that used theexport
keyword).Fix a crash with an invalid subpath import (#3067)
Previously esbuild could crash when attempting to generate a friendly error message for an invalid subpath import (i.e. an import starting with
#
). This happened because esbuild originally only supported theexports
field and the code for that error message was not updated when esbuild later added support for theimports
field. This crash has been fixed.v0.17.17
Compare Source
Fix CSS nesting transform for top-level
&
(#3052)Previously esbuild could crash with a stack overflow when lowering CSS nesting rules with a top-level
&
, such as in the code below. This happened because esbuild's CSS nesting transform didn't handle top-level&
, causing esbuild to inline the top-level selector into itself. This release handles top-level&
by replacing it with the:scope
pseudo-class:Support
exports
inpackage.json
forextends
intsconfig.json
(#3058)TypeScript 5.0 added the ability to use
extends
intsconfig.json
to reference a path in a package whosepackage.json
file contains anexports
map that points to the correct location. This doesn't automatically work in esbuild becausetsconfig.json
affects esbuild's path resolution, so esbuild's normal path resolution logic doesn't apply.This release adds support for doing this by adding some additional code that attempts to resolve the
extends
path using theexports
field. The behavior should be similar enough to esbuild's main path resolution logic to work as expected.Note that esbuild always treats this
extends
import as arequire()
import since that's what TypeScript appears to do. Specifically therequire
condition will be active and theimport
condition will be inactive.Fix watch mode with
NODE_PATH
(#3062)Node has a rarely-used feature where you can extend the set of directories that node searches for packages using the
NODE_PATH
environment variable. While esbuild supports this too, previously a bug prevented esbuild's watch mode from picking up changes to imported files that were contained directly in aNODE_PATH
directory. You're supposed to useNODE_PATH
for packages, but some people abuse this feature by putting files in that directory instead (e.g.node_modules/some-file.js
instead ofnode_modules/some-pkg/some-file.js
). The watch mode bug happens when you do this because esbuild first tries to readsome-file.js
as a directory and then as a file. Watch mode was incorrectly waiting forsome-file.js
to become a valid directory. This release fixes this edge case bug by changing watch mode to watchsome-file.js
as a file when this happens.v0.17.16
Compare Source
Fix CSS nesting transform for triple-nested rules that start with a combinator (#3046)
This release fixes a bug with esbuild where triple-nested CSS rules that start with a combinator were not transformed correctly for older browsers. Here's an example of such a case before and after this bug fix:
Support
--inject
with a file loaded using thecopy
loader (#3041)This release now allows you to use
--inject
with a file that is loaded using thecopy
loader. Thecopy
loader copies the imported file to the output directory verbatim and rewrites the path in theimport
statement to point to the copied output file. When used with--inject
, this means the injected file will be copied to the output directory as-is and a bareimport
statement for that file will be inserted in any non-copy output files that esbuild generates.Note that since esbuild doesn't parse the contents of copied files, esbuild will not expose any of the export names as usable imports when you do this (in the way that esbuild's
--inject
feature is typically used). However, any side-effects that the injected file has will still occur.eslint/eslint
v8.39.0
Compare Source
Features
3f7af9f
feat: ImplementSourceCode#markVariableAsUsed()
(#17086) (Nicholas C. Zakas)Documentation
6987dc5
docs: Fix formatting in Custom Rules docs (#17097) (Milos Djermanovic)4ee92e5
docs: Update README (GitHub Actions Bot)d8e9887
docs: Custom Rules cleanup/expansion (#16906) (Ben Perlmutter)1fea279
docs: Clarify how to add to tsc agenda (#17084) (Nicholas C. Zakas)970ef1c
docs: Update triage board location (Nicholas C. Zakas)6d8bffd
docs: Update README (GitHub Actions Bot)Chores
60a6f26
chore: upgrade @eslint/js@8.39.0 (#17102) (Milos Djermanovic)d5ba5c0
chore: package.json update for @eslint/js release (ESLint Jenkins)f57eff2
ci: run tests on Node.js v20 (#17093) (Nitin Kumar)9d1b8fc
perf: Binary search in token storeutils.search
(#17066) (Francesco Trotta)07a4435
chore: Add request for minimal repro to bug report (#17081) (Nicholas C. Zakas)eac4943
refactor: remove unnecessary use ofSourceCode#getAncestors
in rules (#17075) (Milos Djermanovic)0a7b60a
chore: update description ofSourceCode#getDeclaredVariables
(#17072) (Milos Djermanovic)6e2df71
chore: remove unnecessary references to the LICENSE file (#17071) (Milos Djermanovic)v8.38.0
Compare Source
Features
a1d561d
feat: Move getDeclaredVariables and getAncestors to SourceCode (#17059) (Nicholas C. Zakas)Bug Fixes
1c1ece2
fix: do not report onRegExp(...args)
inrequire-unicode-regexp
(#17037) (Francesco Trotta)Documentation
7162d34
docs: Mention new config system is complete (#17068) (Nicholas C. Zakas)0fd6bb2
docs: Update README (GitHub Actions Bot)c83531c
docs: Update/remove external links, eg. point toeslint-community
(#17061) (Pelle Wessman)a3aa6f5
docs: Clarifyno-div-regex
rule docs (#17051) (Francesco Trotta)b0f11cf
docs: Update README (GitHub Actions Bot)da8d52a
docs: Update the second object instance for the "no-new" rule (#17020) (Ahmadou Waly NDIAYE)518130a
docs: switch language based on current path (#16687) (Percy Ma)24206c4
docs: Update README (GitHub Actions Bot)Chores
59ed060
chore: upgrade @eslint/js@8.38.0 (#17069) (Milos Djermanovic)88c0898
chore: package.json update for @eslint/js release (ESLint Jenkins)cf682d2
refactor: simplify new-parens rule schema (#17060) (MHO)0dde022
ci: bump actions/add-to-project from 0.4.1 to 0.5.0 (#17055) (dependabot[bot])okonet/lint-staged
v13.2.1
Compare Source
Bug Fixes
prettier/prettier
v2.8.8
Compare Source
This version is a republished version of v2.8.7.
A bad version was accidentally published and it can't be unpublished, apologies for the churn.
isaacs/rimraf
v5.0.0
Compare Source
TypeStrong/TypeDoc
v0.24.6
Compare Source
Features
g
,circle
,ellipse
,polygon
, andpolyline
svg elements, #2259.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.Thanks!
v0.24.5
Compare Source
Features
--navigation.includeCategories
and
--navigation.includeGroups
to control this behavior. The--categorizeByGroup
option alsoeffects this behavior. If
categorizeByGroup
is set (the default) andnavigation.includeGroups
isnot set, the value of
navigation.includeCategories
will be effectively ignored since categorieswill be created only within groups, #1532.
@returns
blocks will now be rendered with the return type, #2180.--groupOrder
option to specify the sort order of groups, #2251.Bug Fixes
--hideParameterTypesInTitle
option, #2226.@returns
block is is present in a function, and ignore the duplicate blocks as specified by TSDoc.Thanks!
v0.24.4
Compare Source
Bug Fixes
v0.24.3
Compare Source
Bug Fixes
v0.24.2
Compare Source
Features
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.Bug Fixes
&
showing as&
and HTML text showing up in page contents navigation, #2224.source-order
sort strategy failing to compare reflections within a file.enum-member-source-order
specialization of thesource-order
sort strategy which only compares enum members, #2237.__@​
symbol name, #2234.--entryPointStrategy packages
.Thanks!
v0.24.1
Compare Source
Bug Fixes
@example
tags, #2222.v0.24.0
Compare Source
Breaking Changes
@link
,@linkcode
and@linkplain
tags will now be resolved with TypeScript's link resolution by default. TheuseTsLinkResolution
optioncan 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.
node_modules
. Specify the--plugin
option to indicate which modules should be loaded.packages
entry point strategy will now run TypeDoc in each provided package directory and then merge the results together.The previous
packages
strategy has been preserved underlegacy-packages
and will be removed in 0.25. If the new strategy does not workfor your use case, please open an issue.
--logger
option, to disable all logging, set thelogLevel
option tonone
.[[link]]
s, removed deprecatedReflection.findReflectionByName
.@overload
to default ignored tags.API Breaking Changes
label
property onReflection
has moved toComment
.out
option has been changed from""
to"./docs"
, #2195.DeclarationReflection#version
toDeclarationReflection#projectVersion
to match property onProjectReflection
.Reflection#originalName
.Reflection#kindString
, useReflectionKind.singularString(reflection.kind)
orReflectionKind.pluralString(reflection.kind)
instead.named-tuple-member
andtemplate-literal
type kind have been replaced withnamedTupleMember
andtemplateLiteral
, #2100.Reflection
, includingurl
,anchor
,hasOwnDocument
, andcssClasses
.Application.bootstrap
will no longer load plugins. If you want to load plugins, useApplication.bootstrapWithPlugins
instead, #1635.Application.bootstrap
will now be applied both before and after reading options files, which may cause a change in configurationif using a custom script to run TypeDoc that includes some options, but other options are set in config files.
sources
property previously declared on baseReflection
class toDeclarationReflection
andSignatureReflection
.relevanceBoost
fromContainerReflection
toDeclarationReflection
since setting it on the parent class has no effect.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.Renderer.addExternalSymbolResolver
, useConverter.addExternalSymbolResolver
instead.CallbackLogger
.SerializeEventData
from serialization events.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.secondaryNavigation
member onDefaultThemeRenderContext
.navigation
tosidebar
onDefaultThemeRenderContext
andnavigation.begin
/navigation.end
hooks tosidebar.begin
/sidebar.end
.Features
--useTsLinkResolution
option (on by default) which tells TypeDoc to use TypeScript's@link
resolution.--jsDocCompatibility
option (on by default) which controls TypeDoc's automatic detection of code blocks in@example
and@default
tags.@interface
on type aliases to tell TypeDoc to convert the fully resolved type as an interface, #1519@namespace
on variable declarations to tell TypeDoc to convert the variable as a namespace, #2055.@prop
/@property
to specify documentation for a child property of a symbol, intended for use with@interface
.Promise<void>
from theirload
function, #185.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.
typedocOptions
key inpackage.json
, #2112.--cacheBust
option to tell TypeDoc to include include the generation time in files, #2124.--excludeReferences
option to tell TypeDoc to omit re-exports of a symbol already included from the documentation.pageSidebar.begin
andpageSidebar.end
.Bug Fixes
name
field, #2190.@inheritDoc
on signatures (functions, methods, constructors, getters, setters) being unable to inherit from a non-signature.v
in versions, #2212.typeof
on a reference with type arguments, #2220.Thanks!
v0.23.28 (2023-03-19)
Features
const
type parameters.@overload
tag.@satisfies
tag.v0.23.27 (2023-03-16)
Features
--treatValidationWarningsAsErrors
to treat only validation warnings as errors without treating all warnings as errors, #2199.Bug Fixes
@private
and@protected
tags totypedoc/tsdoc.json
, #2187.Thanks!
v0.23.26 (2023-02-26)
Features
Application.EVENT_VALIDATE_PROJECT
event for plugins which implement custom validation, #2183.Comment.displayPartsToMarkdown
on for themes overwriting thecomment
helper, #2115.Bug Fixes
export default undefined
, #2175.Thanks!
v0.23.25 (2023-02-11)
Breaking Changes
material-<theme>
, the value will need to be changed tomaterial-theme-<theme>
, see the Shiki release notes.Features
excludeNotDocumentedKinds
variable to control which reflection types can be removedby the
excludeNotDocumented
option, #2162.typedoc.jsonc
,typedoc.config.js
,typedoc.config.cjs
,typedoc.cjs
to the list of fileswhich TypeDoc will automatically use as configuration files.
Bug Fixes
node_modules
will no longer be ignored, #2151.excludeNotDocumented
on arrow function-variables, #2156.package.json
to exports declaration.Thanks!
v0.23.24 (2023-01-07)
Bug Fixes
Thanks!
v0.23.23 (2022-12-18)
Features
ts.Signature
to emittedEVENT_CREATE_SIGNATURE
event, #2002.Bug Fixes
src/
andsrc/x
are specified as entry points,src/
will no longer be ignored, #2121.v0.23.22 (2022-12-11)
Features
Bug Fixes
@link
tags within lists, #2103.v0.23.21 (2022-11-14)
Features
externalSymbolLinkMappings
, #2102.Thanks!
v0.23.20 (2022-11-03)
Bug Fixes
@inheritDoc
if inheriting from a function type alias, #2087.v0.23.19 (2022-10-28)
Bug Fixes
titleLink
option was not specified, #2085.Thanks!
v0.23.18 (2022-10-23)
Features
Bug Fixes
@param
comment for the parameter if available, #1261.v0.23.17 (2022-10-18)
Features
titleLink
,navigationLinks
andsidebarLinks
options to add additional links to the rendered output, #1830.sourceLinkTemplate
option to allow more flexible specification of remote urls.Deprecated now redundant
gitRevision
detection starting withhttps?://
introduced in v0.23.16, #2068.Thanks!
v0.23.16 (2022-10-10)
Features
{ "typedoc": { "tsconfig": "tsconfig.lib.json" }}
in package.json, #2061.Bug Fixes
Thanks!
v0.23.15 (2022-09-18)
Features
@typedef {import("foo").Bar<Z>} Baz
type declarations which forward type parameters to the importedsymbol as re-exports of that symbol, #2044.
Bug Fixes
widgets.png
andwidgets@2x.png
files from generated assets folder.v0.23.14 (2022-09-03)
Features
externalSymbolLinkMappings
seethe documentation for usage examples and caveats, #2030.
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 beensoft deprecated in favor of
Converter.addUnknownSymbolResolver
. Plugins should update to use the method onConverter
.DefaultThemeRenderContext.attemptExternalResolution
has also been deprecated since it will repeat work done during conversion,use
ReferenceType.externalUrl
instead.Converter.addUnknownSymbolResolver
for use by plugins supporting external links.Bug Fixes
v0.23.13 (2022-09-01)
Bug Fixes
v0.23.12 (2022-08-31)
Features
ParameterType.Object
for declaring object options which will be shallowly merged when read from user configuration.Application.EVENT_BOOTSTRAP_END
event emitted whenApplication.bootstrap
is called.Bug Fixes
isIdentifierOrPrivateIdentifier
.Thanks!
v0.23.11 (2022-08-26)
Features
skipErrorChecking
option which instructs TypeDoc to not ask TypeScript for compiler errorsbefore attempting to generate documentation. Turning this on may improve generation speed, but could also
cause a crash if your code contains compiler errors.
Bug Fixes
@link
tags resolved, #2029.DefaultThemeRenderContext
now contain all the HTML for their sections of the page, #2038.Thanks!
v0.23.10 (2022-07-31)
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 (2022-07-24)
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 (2022-07-17)
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 (2022-07-09)
Bug Fixes
@jest/globals
in a comment will no longer be parsed as a tag #1990.v0.23.6 (2022-07-08)
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 combinatiConfiguration
📅 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.
👻 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.