feat(ui): add action to explorer item to show the test/suite line in the source code tab by userquin · Pull Request #5948 · vitest-dev/vitest

userquin · 2024-06-20T23:10:22Z

Description

Closes #5931

This PR includes:

new action in the explorer item to go to the test/suite line in the source code tab: will navigate to the tab if the ViewEditor is not the code tab or the active file is not the selected
enable includeTaskLocation if running in browser mode (not headless) or ui mode: will preserve user option - @sheremet-va review config.ts module 🙏
docs: update config/index.md to include previous entry
when the user disables includeTaskLocation, the explorer item will show a tooltip similar for coverage without html reporter (check image below): we can just disable the button...
refactor codemirror logic: moved codemirrror shallow ref from the ViewEditor to a global shallow ref inside codemirror composable, removed exposed codemirror from the ViewEditor and updated all usages with the global one
added navigateTo to navigator.ts composable to allow change the view mode: navigator sfc and explorer item using it, without view mode and with it respectively
added disabled run test/suite for future usage: we'll need to change the logic to allow run individual tests/suites.

You can see this PR in action in this video.

Disabled includeTaskLocation

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:.

…the source code tab

…-links

userquin · 2024-06-20T23:22:09Z

When running test/core with Vitest UI I get this error that should be fixed (or maybe not):

packages/vitest/src/node/config.ts

docs/config/index.md

Co-authored-by: Anjorin Damilare <damilareanjorin1@gmail.com>

…-links

userquin · 2024-06-26T10:49:57Z

Added code tab and source files to the gz file when running pnpm vitest --reporter=html: last commit also enables includeTaskLocation when using html reporter.

NOTE: codemirror in readOnly mode when running vitest with --reporter=html and so we can copy/paste enabling focusing and scrolling from explorer item sfc

packages/ui/client/components/views/ViewEditor.vue

packages/ui/node/reporter.ts

userquin · 2024-06-26T20:47:18Z

Dont merge yet, I'll change the explorer ítem ui again (missing tooltip when html reporter).

wll8 · 2024-06-27T01:43:31Z

@userquin Is codemirrorRef guaranteed to be initialized after 256 milliseconds?

// we need to await, CodeMirrow will take some time to initialize
await new Promise(r => setTimeout(r, 256))

packages/ui/client/composables/codemirror.ts

userquin · 2024-06-27T08:05:49Z

It is about waiting for route change and 100ms in the onMounted, maybe I can try using another approach to load it.

userquin · 2024-06-27T10:16:53Z

packages/ui/client/auto-imports.d.ts

userquin · 2024-06-27T12:20:00Z

@userquin Is codemirrorRef guaranteed to be initialized after 256 milliseconds?

// we need to await, CodeMirrow will take some time to initialize
await new Promise(r => setTimeout(r, 256))

packages/ui/client/composables/codemirror.ts

Now the logic will focus the line based on the new line router param, forcing the new watcher to trigger in ViewEditor once the new code loaded

maxpatiiuk · 2024-10-03T17:33:30Z

packages/ui/client/components/explorer/ExplorerItem.vue

        title="Run current test"
        icon="i-carbon:play-filled-alt"
        text-green5
+        :disabled="type !== 'file'"


added disabled run test/suite for future usage: we'll need to change the logic to allow run individual tests/suites.

Sorry if I am late, but could you please clarify why the ability to run individual test was disabled?

Is is something that is coming in the future? Is there a feature request for that or should I open one?

Thanks!

This was never supported. It is possible to support - feel free to create an issue or a PR

userquin added 3 commits June 21, 2024 00:54

feat(ui): add action to explorer item to show the test/suite line in …

c095794

…the source code tab

chore(docs): update includeTaskLocation

1ca2e4f

Merge branch 'refs/heads/main' into userquin/feat-add-show-test-suite…

69c1ccd

…-links

userquin marked this pull request as ready for review June 20, 2024 23:20

sheremet-va mentioned this pull request Jun 22, 2024

The html reporter allows viewing the current use case code #5931

Closed

4 tasks

sheremet-va reviewed Jun 22, 2024

View reviewed changes

packages/vitest/src/node/config.ts Show resolved Hide resolved

dammy001 reviewed Jun 24, 2024

View reviewed changes

docs/config/index.md Outdated Show resolved Hide resolved

userquin and others added 3 commits June 24, 2024 10:27

chore: apply suggestion

67fe171

Co-authored-by: Anjorin Damilare <damilareanjorin1@gmail.com>

Merge branch 'refs/heads/main' into userquin/feat-add-show-test-suite…

dc34f60

…-links

chore: enable code tab for static html reporter

d2ed94e

sheremet-va requested changes Jun 26, 2024

View reviewed changes

packages/ui/client/components/views/ViewEditor.vue Outdated Show resolved Hide resolved

packages/ui/node/reporter.ts Outdated Show resolved Hide resolved

userquin added 2 commits June 26, 2024 14:12

chore: apply suggestions

24e6f07

chore: update failing snapshots

4a0257e

sheremet-va previously approved these changes Jun 26, 2024

View reviewed changes

userquin added 2 commits June 27, 2024 12:26

chore: change explorer item layout

7b271f2

chore: add line number to router params

04ae6b5

userquin dismissed sheremet-va’s stale review via 04ae6b5 June 27, 2024 12:01

userquin commented Jun 27, 2024

View reviewed changes

packages/ui/client/auto-imports.d.ts Outdated Show resolved Hide resolved

chore: remove registerInitializeListener from auto imports dts

8e437b5

userquin requested a review from sheremet-va June 27, 2024 12:29

sheremet-va approved these changes Jun 27, 2024

View reviewed changes

userquin merged commit 7ec298e into main Jun 27, 2024

userquin deleted the userquin/feat-add-show-test-suite-links branch June 27, 2024 12:47

maxpatiiuk reviewed Oct 3, 2024

View reviewed changes

renovate bot mentioned this pull request Oct 3, 2024

chore(deps): update dependency vitest to v2 - autoclosed fisker/vite-plugin-image-minify#10

Closed

1 task

maxpatiiuk mentioned this pull request Oct 4, 2024

[UI] Allow running individual tests/suites #6638

Closed

4 tasks

renovate bot mentioned this pull request Oct 17, 2024

chore(deps): update dependency vitest to v2 Poltergeist/alles-standard#24

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ui): add action to explorer item to show the test/suite line in the source code tab#5948

feat(ui): add action to explorer item to show the test/suite line in the source code tab#5948
userquin merged 11 commits intomainfrom
userquin/feat-add-show-test-suite-links

userquin commented Jun 20, 2024 •

edited by sheremet-va

Loading

Uh oh!

userquin commented Jun 20, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

userquin commented Jun 26, 2024 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

userquin commented Jun 26, 2024

Uh oh!

wll8 commented Jun 27, 2024

Uh oh!

userquin commented Jun 27, 2024

Uh oh!

userquin commented Jun 27, 2024

Uh oh!

Uh oh!

userquin commented Jun 27, 2024 •

edited

Loading

Uh oh!

maxpatiiuk Oct 3, 2024

Uh oh!

sheremet-va Oct 3, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

userquin commented Jun 20, 2024 • edited by sheremet-va Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

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

Tests

Documentation

Changesets

Uh oh!

userquin commented Jun 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

userquin commented Jun 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

userquin commented Jun 26, 2024

Uh oh!

wll8 commented Jun 27, 2024

Uh oh!

userquin commented Jun 27, 2024

Uh oh!

userquin commented Jun 27, 2024

Uh oh!

Uh oh!

userquin commented Jun 27, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

maxpatiiuk Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

sheremet-va Oct 3, 2024

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

userquin commented Jun 20, 2024 •

edited by sheremet-va

Loading

userquin commented Jun 20, 2024 •

edited

Loading

userquin commented Jun 26, 2024 •

edited

Loading

userquin commented Jun 27, 2024 •

edited

Loading