docs(getting started): Add default test name tip #4832
Merged
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
I'm new to Vite, vitest, and JS in general.
Because I had to follow multiple tutorials, my test name was wrong, and it took me multiple hours to realize.
Coming from multiple other programing languages that works differently, and even having written some small test runners, I expected the include regex to look inside the file rather than only the file name.
I think this small tip in documentation can help neophytes to avoid that basic mistake that they can encounter for multiple reasons.
Only discution to be had is the format of the tip. I think this can be done in the PR directly as it is very small.
Documentation, no tests impacted
pnpm-lock.yaml
unless you introduce a new test example.None
Tests
pnpm test:ci
.None
Documentation
pnpm run docs
command.None
Changesets
feat:
,fix:
,perf:
,docs:
, orchore:
.I hope I followed everything to make this PR viable :)
Have a wonderful day !