chore(dx): recommend Vitest extension and document Antares-only setup#165
chore(dx): recommend Vitest extension and document Antares-only setup#165rmojica-godaddy wants to merge 2 commits intomainfrom
Conversation
|
There was a problem hiding this comment.
Pull request overview
This PR improves the contributor experience for running @godaddy/antares component tests in VS Code/Cursor by recommending the Vitest test explorer extension, documenting the suggested editor configuration, and making the Visual Vitest project easier to distinguish in the test tree.
Changes:
- Recommend the official
vitest.explorerextension at the workspace level. - Document the recommended
vitest.rootConfigandvitest.cliArgumentssettings for focusing on AntaresSSR+Browserprojects. - Rename the Visual project’s Chromium instance to
Visual (Chromium)in the shared Vitest config.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
configs/vitest.config.mts |
Adds a named Chromium instance for the Visual test project for clearer editor test tree display. |
README.md |
Adds “Vitest in VS Code or Cursor” setup documentation for the Vitest extension. |
.vscode/extensions.json |
Recommends installing vitest.explorer alongside Biome. |
📚 Storybook PreviewPreview URL: https://godaddy.github.io/antares/pr-165/ Preview will be automatically deleted when this PR is closed. |
Docs Site PreviewPreview URL: https://godaddy.github.io/antares/pr-165-site/ Preview will be automatically deleted when this PR is closed. |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
| ```json | ||
| { | ||
| "vitest.rootConfig": "packages/@godaddy/antares/vitest.config.ts", | ||
| "vitest.cliArguments": "--project=SSR --project=Browser" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
we have a /.vscode/settings.json workspace file, can we add these settings there directly?
Summary
Make it easy for engineers to run and debug
@godaddy/antarescomponent tests directly from VS Code or Cursor using the Vitest test explorer, without picking up the slower visual regression project by accident.Today contributors have to either:
nx run @godaddy/antares:testfrom the terminal, losing the inline test UI, orSSR,Browser,Visual).This PR documents the recommended setup, recommends the official Vitest extension at the workspace level, and gives the
Visualproject a distinct Chromium instance name so it’s identifiable in the editor’s test tree.Changes Made
.vscode/extensions.json— Addvitest.explorerto workspace recommendations so contributors get prompted to install the Vitest extension when they open the repo.README.md— New "Vitest in VS Code or Cursor" section under Development with the exactvitest.rootConfigandvitest.cliArgumentssnippet to point the extension at@godaddy/antaresand limit it to theSSRandBrowserprojects.configs/vitest.config.mts— Name theVisualproject's Chromium instanceVisual (Chromium)so it is distinguishable from theBrowserproject's Chromium instance in the Vitest editor UI.