Vitest setup in Svelte

Introduction

Vitest helps you check if your Svelte code works correctly by running tests automatically.

You want to make sure your Svelte components behave as expected.

You want to catch mistakes early before your app goes live.

You want to run tests quickly during development.

You want to add confidence when changing or adding new features.

Syntax

Svelte

npm install -D vitest @testing-library/svelte @sveltejs/vite-plugin-svelte

// vitest.config.ts
import { defineConfig } from 'vitest/config'
import { svelte } from '@sveltejs/vite-plugin-svelte'

export default defineConfig({
  plugins: [svelte()],
  test: {
    globals: true,
    environment: 'jsdom'
  }
})

Install Vitest and Svelte testing tools as developer dependencies.

Configure Vitest to use the Svelte plugin and set the test environment to simulate a browser.

Examples

Installs Vitest and helpers for testing Svelte components.

Svelte

npm install -D vitest @testing-library/svelte @sveltejs/vite-plugin-svelte

Basic Vitest config to enable Svelte support and browser-like testing environment.

Svelte

// vitest.config.ts
import { defineConfig } from 'vitest/config'
import { svelte } from '@sveltejs/vite-plugin-svelte'

export default defineConfig({
  plugins: [svelte()],
  test: {
    globals: true,
    environment: 'jsdom'
  }
})

Sample Program

This test renders a simple Button component, checks if the label appears, and verifies the click event works.

Svelte

// Example test file: src/__tests__/Button.test.ts
import { render, fireEvent } from '@testing-library/svelte'
import Button from '../Button.svelte'
import { describe, it, expect } from 'vitest'

describe('Button component', () => {
  it('shows the correct label and reacts to click', async () => {
    const { getByText } = render(Button, { props: { label: 'Click me' } })
    const button = getByText('Click me')
    expect(button).toBeTruthy()

    let clicked = false
    button.addEventListener('click', () => { clicked = true })

    await fireEvent.click(button)
    expect(clicked).toBe(true)
  })
})

Important Notes

Use jsdom environment to simulate browser features in tests.

Use @testing-library/svelte for easy component rendering and user event simulation.

Run tests with npx vitest or add a script in package.json like "test": "vitest".

Summary

Vitest helps test Svelte components quickly and simply.

Install Vitest and configure it with the Svelte plugin and jsdom environment.

Write tests using @testing-library/svelte to check component behavior.

Practice

1. What is the main purpose of Vitest in a Svelte project?

easy

A. To deploy the app to a server

B. To build the Svelte app for production

C. To style components with CSS

D. To run tests and check if components work correctly

Solution

1. Step 1: Understand Vitest's role

   Vitest is a testing tool used to verify code correctness.

2. Step 2: Compare options with Vitest's purpose

   Only To run tests and check if components work correctly describes testing, which matches Vitest's function.

3. Final Answer:

   To run tests and check if components work correctly -> Option D

4. Quick Check:

   Vitest = Testing tool [OK]

Hint: Vitest is for testing, not building or styling [OK]

Common Mistakes:

• Confusing Vitest with build tools
• Thinking Vitest styles components
• Assuming Vitest deploys apps

2. Which of the following is the correct way to configure Vitest for Svelte testing in vite.config.js?

easy

A. import { defineConfig } from 'vite'; export default defineConfig({ plugins: [], test: { environment: 'node' } });

B. import { defineConfig } from 'vite'; import svelte from '@sveltejs/vite-plugin-svelte'; export default defineConfig({ plugins: [], test: { environment: 'jsdom' } });

C. import { defineConfig } from 'vite'; import svelte from '@sveltejs/vite-plugin-svelte'; export default defineConfig({ plugins: [svelte()], test: { environment: 'jsdom' } });

D. import { defineConfig } from 'vitest'; import svelte from '@sveltejs/vite-plugin-svelte'; export default defineConfig({ plugins: [svelte()] });

Solution

1. Step 1: Check plugin usage for Svelte

   The Svelte plugin must be included in plugins array for Svelte support.

2. Step 2: Verify test environment setting

   Vitest tests for Svelte need 'jsdom' environment to simulate browser.

3. Final Answer:

   Correct config includes Svelte plugin and jsdom environment -> Option C

4. Quick Check:

   Plugin + jsdom = Correct Vitest config [OK]

Hint: Include svelte plugin and set environment to jsdom [OK]

Common Mistakes:

• Omitting the Svelte plugin
• Using 'node' instead of 'jsdom' environment
• Importing defineConfig from wrong package

3. Given this test code for a Svelte component using Vitest and @testing-library/svelte:

import { render } from '@testing-library/svelte';
import Button from './Button.svelte';

test('shows button text', () => {
  const { getByText } = render(Button, { props: { label: 'Click me' } });
  getByText('Click me');
});

What happens if the component does NOT display the label prop text?

medium

A. The test throws a syntax error

B. The test fails with an error that text was not found

C. The test passes silently

D. The test logs a warning but passes

Solution

1. Step 1: Understand getByText behavior

   getByText throws an error if the text is not found in the rendered output.

2. Step 2: Analyze test outcome if label missing

   If the component does not show 'Click me', getByText fails and test fails.

3. Final Answer:

   The test fails with an error that text was not found -> Option B

4. Quick Check:

   getByText missing text = test fail [OK]

Hint: getByText throws error if text missing, causing test failure [OK]

Common Mistakes:

• Assuming test passes without text
• Confusing runtime errors with syntax errors
• Thinking warnings allow test to pass

4. You wrote this Vitest config snippet:

import { defineConfig } from 'vite';
import svelte from '@sveltejs/vite-plugin-svelte';

export default defineConfig({
  plugins: [svelte()],
  test: {
    environment: 'node'
  }
});

Why might your Svelte component tests fail to run correctly?

medium

A. Because the test environment is set to 'node' instead of 'jsdom'

B. Because the Svelte plugin is missing from plugins

C. Because defineConfig must be imported from 'vitest' not 'vite'

D. Because the test property should be outside defineConfig

Solution

1. Step 1: Check environment setting for browser features

   Svelte components need a browser-like environment; 'node' lacks DOM APIs.

2. Step 2: Understand impact on tests

   Using 'node' causes tests that rely on DOM (like rendering) to fail.

3. Final Answer:

   Because the test environment is set to 'node' instead of 'jsdom' -> Option A

4. Quick Check:

   Use jsdom for DOM tests, not node [OK]

Hint: Use 'jsdom' environment for Svelte component tests [OK]

Common Mistakes:

• Thinking 'node' environment supports DOM
• Confusing import source for defineConfig
• Misplacing test config outside defineConfig

5. You want to test a Svelte component that conditionally renders a message only if a prop show is true. Which Vitest test code correctly checks that the message appears only when show is true?

import { render } from '@testing-library/svelte';
import Message from './Message.svelte';

test('message visibility', () => {
  // Fill in test code here
});

hard

A. const { queryByText } = render(Message, { props: { show: false } });
expect(queryByText('Hello')).toBeNull();
const { getByText } = render(Message, { props: { show: true } });
getByText('Hello');

B. const { getByText } = render(Message, { props: { show: false } });
getByText('Hello');

C. const { getByText } = render(Message, { props: { show: true } });
expect(getByText('Hello')).toBeNull();

D. const { queryByText } = render(Message, { props: { show: true } });
expect(queryByText('Hello')).toBeNull();

Solution

1. Step 1: Test absence when show is false

   Use queryByText to check 'Hello' is not rendered (returns null).

2. Step 2: Test presence when show is true

   Use getByText to confirm 'Hello' is rendered and found.

3. Final Answer:

   Use queryByText for absence and getByText for presence in two renders -> Option A

4. Quick Check:

   queryByText null means no text; getByText finds text [OK]

Hint: Use queryByText to check absence, getByText to check presence [OK]

Common Mistakes:

• Using getByText expecting null when text missing
• Not testing both true and false cases
• Confusing queryByText and getByText roles