Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: added more description about connecting UI with right mode. #7119

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bandhan-majumder
Copy link

@bandhan-majumder bandhan-majumder commented Dec 23, 2024

Added more description for connecting UI with right mode to avoid confusion.

Description

While reading the guide about Vitest UI, most of us try to run it with vitest run and the UI never connects. It is made for watch mode. I have added a warning about this usage and also mentioned the area where information about HTML reported is given for run mode.

Fixes

It's an old issue. I am not creating a new issue for the same. Instead, referencing the previous one which asks for a documentation update to avoid confusion.

Details: #2897

Snapshot

image

Please don't delete this checklist! Before submitting the PR, please make sure you do the following:

  • It's really useful if your PR references an issue where it is discussed ahead of time. If the feature is substantial or introduces breaking changes without a discussion, PR might be closed.
  • Ideally, include a test that fails without this PR but passes with it.
  • Please, don't make changes to pnpm-lock.yaml unless you introduce a new test example.

Tests

  • Run the tests with pnpm test:ci.

Documentation

  • If you introduce new functionality, document it. You can run documentation with pnpm run docs command.

Changesets

  • Changes in changelog are generated from PR name. Please, make sure that it explains your changes in an understandable manner. Please, prefix changeset messages with feat:, fix:, perf:, docs:, or chore:.

Added more description for connecting UI with right mode to avoid confusion.
Copy link

netlify bot commented Dec 23, 2024

Deploy Preview for vitest-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 6fc9cb9
🔍 Latest deploy log https://app.netlify.com/sites/vitest-dev/deploys/6768f3b61f084d00086684fc
😎 Deploy Preview https://deploy-preview-7119--vitest-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant