You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Vitest 3 is here! There are a few breaking changes, but we expect the migration to be smooth. This release page lists all changes made to the project during the beta. For the migration guide, please refer to the documentation.
This introduced some breaking changes (https://github.com/vitest-dev/vitest/issues/6992). We will enable support at a later time. In the meantime, you can still use pnpm.overrides or yarn resolutions to override the vite version in the vitest package - the APIs are compatible.
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.
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](https://redirect.github.com/TypeStrong/TypeDoc/iss
Configuration
📅 Schedule: Branch creation - "before 3am on Monday" (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.
If you want to rebase/retry this PR, check this box
Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.
♻ Renovate will retry this branch, including artifacts, only when one of the following happens:
any of the package files in this branch needs updating, or
the branch becomes conflicted, or
you click the rebase/retry checkbox if found above, or
you rename this PR's title to start with "rebase!" to trigger it manually
The artifact failure details are included below:
File name: package-lock.json
(node:1040) ExperimentalWarning: CommonJS module /opt/containerbase/tools/npm/11.0.0/23.3.0/node_modules/npm/node_modules/debug/src/node.js is loading ES Module /opt/containerbase/tools/npm/11.0.0/23.3.0/node_modules/npm/node_modules/supports-color/index.js using require().
Support for loading ES Module in require() is an experimental feature and might change at any time
(Use `node --trace-warnings ...` to show where the warning was created)
npm error code ERESOLVE
npm error ERESOLVE could not resolve
npm error
npm error While resolving: @sveltejs/[email protected]
npm error Found: [email protected]
npm error node_modules/vite
npm error dev vite@"6.0.11" from the root project
npm error vite@"^5.0.0 || ^6.0.0" from [email protected]
npm error node_modules/vitest
npm error dev vitest@"3.0.3" from the root project
npm error peer vitest@"3.0.3" from @vitest/[email protected]
npm error node_modules/@vitest/coverage-v8
npm error dev @vitest/coverage-v8@"3.0.3" from the root project
npm error 1 more (@vitest/ui)
npm error 1 more (vite-tsconfig-paths)
npm error
npm error Could not resolve dependency:
npm error peer vite@"^5.0.3" from @sveltejs/[email protected]
npm error node_modules/@sveltejs/kit
npm error peer @sveltejs/kit@"^2.0.0" from @sveltejs/[email protected]
npm error node_modules/@sveltejs/adapter-static
npm error dev @sveltejs/adapter-static@"3.0.1" from documentation-website@undefined
npm error website
npm error documentation-website@undefined
npm error node_modules/documentation-website
npm error dev @sveltejs/kit@"2.5.9" from documentation-website@undefined
npm error website
npm error documentation-website@undefined
npm error node_modules/documentation-website
npm error workspace website from the root project
npm error
npm error Conflicting peer dependency: [email protected]
npm error node_modules/vite
npm error peer vite@"^5.0.3" from @sveltejs/[email protected]
npm error node_modules/@sveltejs/kit
npm error peer @sveltejs/kit@"^2.0.0" from @sveltejs/[email protected]
npm error node_modules/@sveltejs/adapter-static
npm error dev @sveltejs/adapter-static@"3.0.1" from documentation-website@undefined
npm error website
npm error documentation-website@undefined
npm error node_modules/documentation-website
npm error dev @sveltejs/kit@"2.5.9" from documentation-website@undefined
npm error website
npm error documentation-website@undefined
npm error node_modules/documentation-website
npm error workspace website from the root project
npm error
npm error Fix the upstream dependency conflict, or retry
npm error this command with --force or --legacy-peer-deps
npm error to accept an incorrect (and potentially broken) dependency resolution.
npm error
npm error
npm error For a full report see:
npm error /tmp/renovate/cache/others/npm/_logs/2025-01-21T18_49_12_526Z-eresolve-report.txt
npm error A complete log of this run can be found in: /tmp/renovate/cache/others/npm/_logs/2025-01-21T18_49_12_526Z-debug-0.log
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
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:
2.27.10
->2.27.11
2.1.5
->3.0.3
2.1.5
->3.0.3
0.26.11
->0.27.6
5.6.3
->5.7.3
5.4.11
->6.0.11
5.1.3
->5.1.4
2.1.5
->3.0.3
Release Notes
changesets/changesets (@changesets/cli)
v2.27.11
Compare Source
Patch Changes
f0270f6
]:vitest-dev/vitest (@vitest/coverage-v8)
v3.0.3
Compare Source
🐞 Bug Fixes
🏎 Performance
View changes on GitHub
v3.0.2
Compare Source
🐞 Bug Fixes
expect().resolves/rejects
chain typings - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7273 (fa415)View changes on GitHub
v3.0.1
Compare Source
🐞 Bug Fixes
View changes on GitHub
v3.0.0
Compare Source
Vitest 3 is here! There are a few breaking changes, but we expect the migration to be smooth. This release page lists all changes made to the project during the beta. For the migration guide, please refer to the documentation.
🚨 Breaking Changes
spy.mockReset
changes - by @Lordfirespeed in https://github.com/vitest-dev/vitest/issues/6426 (db7a8)describe(..., { shuffle: boolean })
and inherit from parent suite - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/6670 (aa1da)retry
andrepeats
- by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/6817 (e8ce9)🚀 Features
diff
options and supportprintBasicPrototype
- by @hi-ogawa, @sheremet-va and Michał Grzegorzewski in https://github.com/vitest-dev/vitest/issues/6740 (39186)ctx.skip()
dynamically - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/6805 (697c3)vitest/node
entry point and statically on Vitest - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7029 (be8d4)diff.printBasicPrototype: false
by default - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7043 (2b5c5)describe.for
- by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7253 (0ad28)actionTimeout
as playwright provider options - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/6984 (e2c29)userEvent.copy, cut, paste
- by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/6769 (843a6)--project=!pattern
- by @haines in https://github.com/vitest-dev/vitest/issues/6924 (ebfe9)thresholds
to support maximum uncovered items - by @jonahkagan in https://github.com/vitest-dev/vitest/issues/7061 (bde98)toHaveBeenCalledExactlyOnceWith
expect matcher - by @jacoberdman2147 and @sheremet-va in https://github.com/vitest-dev/vitest/issues/6894 (ff662)toHaveBeenCalledAfter
andtoHaveBeenCalledBefore
utility - by @Barbapapazes and @sheremet-va in https://github.com/vitest-dev/vitest/issues/6056 (85e6f)toSatisfy
asymmetric matcher - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7022 (f691a)toBeOneOf
matcher - by @zirkelc and @hi-ogawa in https://github.com/vitest-dev/vitest/issues/6974 (3d742)summary
option forverbose
anddefault
reporters - by @AriPerkkio in https://github.com/vitest-dev/vitest/issues/6893 (511b7)provide
- by @sheremet-va in https://github.com/vitest-dev/vitest/issues/6813 (85c64)config
toresolveSnapshotPath
- by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/6800 (746d8)coverageMap
in json report - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/6606 (9c8f7)onTestsRerun
method to global setup context - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/6803 (e26e0)🐞 Bug Fixes
cacheDir
when optimizer is enabled - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/6910 (0b08b)finally
in case there is an error to avoid it getting stuck - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/6951 (02194)Custom
type internally - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7032 (7957f)cancelCurrentRun
awaitsrunningPromise
- by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7168 (1dbf5)getMockImplementation
to return "once" implementation - by @chaptergy in https://github.com/vitest-dev/vitest/issues/7033 (39125)capturePrintError
logger duplicate event handlers - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7197 (e89c3)vitest/reporters
entrypoint - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7241 (aec0b)forks
pool - by @AriPerkkio in https://github.com/vitest-dev/vitest/issues/7090 (8cab9)VitestRunner
type fromvitest/runners
- by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7240 (9b218)vitest list
- by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7257 (1c2b2)log-update
- by @AriPerkkio in https://github.com/vitest-dev/vitest/issues/7019 (6d23f)vi.mock
is present - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/6810 (8d179)entries
in the browser mode - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7167 (423d6)console.time
with fake timers - by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7207 (903f3)isolate: false
is used - by @AriPerkkio in https://github.com/vitest-dev/vitest/issues/6957 (426ce)dot
reporter withoutlog-update
- by @AriPerkkio in https://github.com/vitest-dev/vitest/issues/6943 (be969)--hideSkippedTests
in base reporter - by @AriPerkkio in https://github.com/vitest-dev/vitest/issues/6988 (721a5)retry
andrepeats
counts - by @AriPerkkio and @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7004 (3496a)describe.todo
as'todo'
- by @AriPerkkio in https://github.com/vitest-dev/vitest/issues/7171 (1d458)toMatchFileSnapshot
- by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7156 (a437b)toMatchSnapshot("...")
- by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7126 (ac9ba)@ts-expect-error
- by @hi-ogawa in https://github.com/vitest-dev/vitest/issues/7125 (27d34)extends: true
correctly inherits all root config properties - by @sheremet-va in https://github.com/vitest-dev/vitest/issues/7232 (798c0)View changes on GitHub
v2.1.8
Compare Source
🐞 Bug Fixes
View changes on GitHub
v2.1.7
Compare Source
🐞 Bug Fixes
pnpm.overrides
or yarn resolutions to override thevite
version in thevitest
package - the APIs are compatible.View changes on GitHub
v2.1.6
Compare Source
🚀 Features
View changes on GitHub
TypeStrong/TypeDoc (typedoc)
v0.27.6
Compare Source
Features
ignoredHighlightLanguages
option to specify languages which will beallowed in code blocks but not highlighted, #2819.
Bug Fixes
@include
and@includeCode
now work in the readme file, #2814.same symbol over type literal properties within function parameters.
v0.27.5
Compare Source
Bug Fixes
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.
rendered document and the parent property/page will be linked to instead,
#2808. These warnings can be disabled with the
validation.rewrittenLink
option.
https://
links under thehostedBaseUrl
option's URL will nolonger be treated as external, #2809.
Thanks!
v0.27.4
Compare Source
Features
Converter.EVENT_CREATE_PROJECT
event which fires when a project is created by the converter, #2800.Bug Fixes
@include
and@includeCode
now work for comments on the entry point for projects with a single entry point, #2800.@summary
now works to describe functions within modules, #2803.v0.27.3
Compare Source
Features
Bug Fixes
highlightLanguages
option now permits Shiki aliases to be specified rather than just the language ID, #2798.Thanks!
v0.27.2
Compare Source
Bug Fixes
v0.27.1
Compare Source
Bug Fixes
@categoryDescription
and@groupDescription
on module pages, #2787.v0.27.0
Compare Source
Breaking Changes
result in a different file name structure, #2714.
have changed. They can be partially restored to the previous format by
setting
--sluggerConfiguration.lowercase false
. This change was made tomore closely match the default behavior of GitHub's markdown rendering and
VSCode's autocomplete when creating a relative link to an external markdown
file.
hideParameterTypesInTitle
option, this was originally added asa 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.
kindSortOrder
to put references last.sort
order to usealphabetical-ignoring-documents
instead of
alphabetical
.suppressCommentWarningsInDeclarationFiles
totrue
(e.g.
X
, notnew X
)@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
package.json
exports if theyare not provided manually, #1937.
#anchor
links toreference a heading within them.
@param
comments with nested object types, #2555.@param
comments which reference a typealias/interface. Important properties on the referenced type can now be
highlighted with
@param options.foo
, which will result in the additionalnote 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.
outputs
option which is an array of outputs. This can be usedto render the documentation multiple times with different rendering options
or output types, [#2597](https://redirect.github.com/TypeStrong/TypeDoc/iss
Configuration
📅 Schedule: Branch creation - "before 3am on Monday" (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 was generated by Mend Renovate. View the repository job log.