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: add initial docs for runtime tests #24658

Merged
merged 6 commits into from
Dec 19, 2023
Merged

docs: add initial docs for runtime tests #24658

merged 6 commits into from
Dec 19, 2023

Conversation

danielroe
Copy link
Member

πŸ”— Linked issue

resolves #22577

❓ Type of change

  • πŸ“– Documentation (updates to the documentation or readme)
  • 🐞 Bug fix (a non-breaking change that fixes an issue)
  • πŸ‘Œ Enhancement (improving an existing functionality like performance)
  • ✨ New feature (a non-breaking change that adds functionality)
  • 🧹 Chore (updates to the build process or auxiliary tools and libraries)
  • ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

πŸ“š Description

This adds initial documentation for @nuxt/test-utils based on the work we've done merging in nuxt-vitest and refactoring the approach.

πŸ“ Checklist

  • I have linked an issue or discussion.
  • I have updated the documentation accordingly.

@danielroe danielroe self-assigned this Dec 9, 2023
Copy link

stackblitz bot commented Dec 9, 2023

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link
Contributor

nuxt-studio bot commented Dec 9, 2023

βœ… Live Preview ready!

Name Edit Preview Latest Commit
Nuxt Docs Edit on Studio β†—οΈŽ View Live Preview ba94851

@github-actions github-actions bot added the 3.x label Dec 9, 2023
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
docs/1.getting-started/11.testing.md Outdated Show resolved Hide resolved
export default defineVitestConfig({
// any custom Vitest config you require
})
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you also add the script that can be used in package.json?
Would "test:unit": "vitest" be enough?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, it would be πŸ‘

@danielroe danielroe merged commit 3de719c into main Dec 19, 2023
4 checks passed
@danielroe danielroe deleted the docs/testing branch December 19, 2023 13:33
@github-actions github-actions bot mentioned this pull request Dec 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add documentation for @nuxt/test-utils
3 participants