Vitest setup in Svelte - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is Vitest used for in a Svelte project?

Vitest is a testing framework used to write and run tests for your Svelte components and JavaScript code. It helps ensure your code works as expected.

beginner

Which command installs Vitest and its related dependencies in a Svelte project?

You run npm install -D vitest @testing-library/svelte @testing-library/jest-dom to install Vitest and testing libraries for Svelte.

intermediate

Where do you add the Vitest configuration in a SvelteKit project?

You add Vitest settings inside the vite.config.js or vite.config.ts file under the test property to customize test behavior.

beginner

How do you run Vitest tests from the command line?

Use npx vitest or add a script like "test": "vitest" in package.json and run npm test.

intermediate

Why is it important to include @testing-library/svelte with Vitest?

Because @testing-library/svelte provides helpful tools to render Svelte components and interact with them in tests, making tests easier and more reliable.

Which command installs Vitest and testing libraries for Svelte?

A npm install -D vitest @testing-library/svelte @testing-library/jest-dom

B npm install vitest svelte

C npm install -g vitest

D npm install svelte-testing-library

Option A installs Vitest and the recommended testing libraries for Svelte projects.

Where do you configure Vitest settings in a SvelteKit project?

A In a separate vitest.config.js file by default

B In svelte.config.js

C In package.json scripts only

D In vite.config.js or vite.config.ts under the test property

Vitest configuration is usually added inside vite.config.js or vite.config.ts under the test property.

What command runs Vitest tests from the terminal?

A npx vitest

B npm start

C npm build

D vitest run

You run tests with npx vitest or npm test if you set a script.

Why use @testing-library/svelte with Vitest?

A To compile Svelte components faster

B To deploy Svelte apps

C To render and interact with Svelte components in tests easily

D To write CSS styles

@testing-library/svelte helps test Svelte components by rendering and simulating user actions.

Which file typically contains the test scripts for Vitest?

A style.css

B Files with .test.js or .spec.js extensions

C main.js

D index.html

Test files usually have .test.js or .spec.js extensions so Vitest can find and run them.

Explain the steps to set up Vitest in a new Svelte project.

Think about installation, configuration, writing tests, and running them.

Describe why @testing-library/svelte is important when using Vitest.

Focus on how it helps interact with components during testing.

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