diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 21c6d4e8e..ce67a12ce 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -127,6 +127,10 @@ export default defineConfig({
text: 'Debugging',
link: '/guide/debugging',
},
+ {
+ text: 'In-source testing',
+ link: '/guide/in-source',
+ },
{
text: 'Comparisons',
link: '/guide/comparisons',
diff --git a/docs/guide/features.md b/docs/guide/features.md
index d55c52857..70691f4c7 100644
--- a/docs/guide/features.md
+++ b/docs/guide/features.md
@@ -221,6 +221,8 @@ export default defineConfig({
})
```
+Learn more at [Mocking](/guide/mocking)
+
## Coverage
Vitest supports Native code coverage via [c8](https://github.com/bcoe/c8)
@@ -255,8 +257,6 @@ Vitest also provides a way to run tests with in your source code along with the
This makes the tests share the same closure as the implementations and able to test against private states without exporting. Meanwhile, it also brings the closer feedback loop for development.
-To get started, put a `if (import.meta.vitest)` block at the end of your source file and write some tests inside it. For example:
-
```ts
// src/index.ts
@@ -276,61 +276,4 @@ if (import.meta.vitest) {
}
```
-Update the `includeSource` config for Vitest to grab the files under `src/`:
-
-```ts
-// vite.config.ts
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
- test: {
- includeSource: ['src/**/*.{js,ts}'],
- },
-})
-```
-
-Then you can start to test!
-
-```bash
-$ npx vitest
-```
-
-For production build, you will need to set the `define` options in your config file, letting the bundler to do the dead code elimination. For example, in Vite
-
-```diff
-// vite.config.ts
-import { defineConfig } from 'vitest/config'
-
-export default defineConfig({
-+ define: {
-+ 'import.meta.vitest': false,
-+ },
- test: {
- includeSource: ['src/**/*.{js,ts}']
- },
-})
-```
-
-To get TypeScript support for `import.meta.vitest`, add `vitest/importMeta` to your `tsconfig.json`:
-
-```diff
-// tsconfig.json
-{
- "compilerOptions": {
- "types": [
-+ "vitest/importMeta"
- ]
- }
-}
-```
-
-Reference to [`test/import-meta`](https://github.com/vitest-dev/vitest/tree/main/test/import-meta) for the full example.
-
-
-This feature could be useful for:
-
-- Unit testing for small-scoped functions or utilities
-- Prototyping
-- Inline Assertion
-
-It's recommended to **use separate test files instead** for more complex tests like components or E2E testing.
+Learn more at [In-source testing](/guide/in-source)
diff --git a/docs/guide/in-source.md b/docs/guide/in-source.md
new file mode 100644
index 000000000..785c82fe9
--- /dev/null
+++ b/docs/guide/in-source.md
@@ -0,0 +1,134 @@
+# In-source testing
+
+Vitest also provides a way to run tests with in your source code along with the implementation, simliar to [Rust's module tests](https://doc.rust-lang.org/book/ch11-03-test-organization.html#the-tests-module-and-cfgtest).
+
+This makes the tests share the same closure as the implementations and able to test against private states without exporting. Meanwhile, it also brings the closer feedback loop for development.
+
+## Setup
+
+To get started, put a `if (import.meta.vitest)` block at the end of your source file and write some tests inside it. For example:
+
+```ts
+// src/index.ts
+
+// the implementation
+export function add(...args: number[]) {
+ return args.reduce((a, b) => a + b, 0)
+}
+
+// in-source test suites
+if (import.meta.vitest) {
+ const { it, expect } = import.meta.vitest
+ it('add', () => {
+ expect(add()).toBe(0)
+ expect(add(1)).toBe(1)
+ expect(add(1, 2, 3)).toBe(6)
+ })
+}
+```
+
+Update the `includeSource` config for Vitest to grab the files under `src/`:
+
+```ts
+// vite.config.ts
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
+ test: {
+ includeSource: ['src/**/*.{js,ts}'],
+ },
+})
+```
+
+Then you can start to test!
+
+```bash
+$ npx vitest
+```
+
+## Production build
+
+For production build, you will need to set the `define` options in your config file, letting the bundler to do the dead code elimination. For example, in Vite
+
+```diff
+// vite.config.ts
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig({
++ define: {
++ 'import.meta.vitest': 'undefined',
++ },
+ test: {
+ includeSource: ['src/**/*.{js,ts}']
+ },
+})
+```
+
+### Other Bundlers
+
+
+unbuild
+
+```diff
+// build.config.ts
+import { defineConfig } from 'unbuild'
+
+export default defineConfig({
++ replace: {
++ 'import.meta.vitest': 'undefined',
++ },
+ // other options
+})
+```
+
+Learn more: unbuild
+
+
+
+
+rollup
+
+```diff
+// rollup.config.js
++ import replace from '@rollup/plugin-replace'
+
+export default {
+ plugins: [
++ replace({
++ 'import.meta.vitest': 'undefined',
++ })
+ ],
+ // other options
+}
+```
+
+Learn more: rollup
+
+
+
+## TypeScript
+
+To get TypeScript support for `import.meta.vitest`, add `vitest/importMeta` to your `tsconfig.json`:
+
+```diff
+// tsconfig.json
+{
+ "compilerOptions": {
+ "types": [
++ "vitest/importMeta"
+ ]
+ }
+}
+```
+
+Reference to [`test/import-meta`](https://github.com/vitest-dev/vitest/tree/main/test/import-meta) for the full example.
+
+## Notes
+
+This feature could be useful for:
+
+- Unit testing for small-scoped functions or utilities
+- Prototyping
+- Inline Assertion
+
+It's recommended to **use separate test files instead** for more complex tests like components or E2E testing.
diff --git a/docs/src/components/FeaturesList.vue b/docs/src/components/FeaturesList.vue
index ae671916b..05924f9f2 100644
--- a/docs/src/components/FeaturesList.vue
+++ b/docs/src/components/FeaturesList.vue
@@ -17,7 +17,7 @@
Tinyspy built-in for mocking
happy-dom or jsdom for DOM mocking
Native code coverage via c8
- Rust like in-source testing
+ Rust like in-source testing