docs: document pretty-format and its usage across Vitest + add unit tests#10052
Merged
sheremet-va merged 17 commits intovitest-dev:mainfrom Apr 4, 2026
Merged
docs: document pretty-format and its usage across Vitest + add unit tests#10052sheremet-va merged 17 commits intovitest-dev:mainfrom
sheremet-va merged 17 commits intovitest-dev:mainfrom
Conversation
Co-authored-by: Codex <[email protected]>
✅ Deploy Preview for vitest-dev ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
Co-authored-by: Codex <[email protected]>
Co-authored-by: Codex <[email protected]>
Co-authored-by: Codex <[email protected]>
Co-authored-by: Codex <[email protected]>
Co-authored-by: Codex <[email protected]>
hi-ogawa
changed the title
sheremet-va
requested changes
Apr 3, 2026
packages/pretty-format/README.md
Outdated
|
|
||
| [GitHub](https://github.com/vitest-dev/vitest/tree/main/packages/pretty-format) | [Documentation](https://vitest.dev/) | ||
|
|
||
| ## Usage |
Member
There was a problem hiding this comment.
I'd like to keep readme to a minimum to reduce the size in node_modules. Let's follow the same logic we did for the mocker package (define usage in a separate .md file)
Collaborator
Author
There was a problem hiding this comment.
I don't mind moving this but that reasoning means you don't want excessive jsdoc in code too. What's the boundary?
(for example, should jsdoc also minimized and better to just link to vitest.dev?)
Member
There was a problem hiding this comment.
What's the boundary?
The boundary is README. Jsdoc is at least visible in the code editors
sheremet-va
approved these changes
Apr 4, 2026
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
@vitest/pretty-format#10050Test cases are copied from #9609
Please don't delete this checklist! Before submitting the PR, please make sure you do the following:
pnpm-lock.yamlunless you introduce a new test example.Tests
pnpm test:ci.Documentation
pnpm run docscommand.Changesets
feat:,fix:,perf:,docs:, orchore:.