sinpro.devVitest
How we automate our tests using Vitest.
Vitest is a testing framework designed for unit testing.
Installation
npm install -D vitest
File Name
In the same directory as the file of the code to be tested is in, write test code in a file named [filename of the code to be tested].test.ts.
Options
Change the files to be included in the test run.
export default defineConfig({
test: {
include: ['src/**/*.{test,spec}.{js,ts}'],
coverage: {
all: true,
include: ['src/**/*.ts'],
exclude: [
'src/**/+*.ts',
'src/app.d.ts',
'src/hooks.server.ts',
'src/scripts/create_git_branch.ts',
],
reporter: ['lcov', 'text'],
},
},
})
Scripts
We have prepared the following scripts to execute Vitest.
{
"scripts": {
"test:unit": "vitest",
"test:unit:run": "vitest run",
"coverage": "vitest run --coverage",
}
}
VSCode Extension
Use the VSCode Extension for testing.
Sample Code
import { expect, it } from 'vitest'
import { ValidId } from './valid_id'
it('1', () => {
expect(new ValidId(1).id).toEqual(1)
})
When checking thrown errors:
import { expect, it } from 'vitest'
import { ValidId } from './valid_id'
it('NaN', () => {
expect(() => new ValidId(NaN)).toThrow('id is not a number')
})
In-source testing
if (import.meta.vitest) {
const { expect, it } = import.meta.vitest
it('get_initial_app_locale_code', () => {
expect(get_initial_locale_code()).toBe('en-US')
})
}
export default defineConfig({
define: {
'import.meta.vitest': 'undefined',
},
})
{
"compilerOptions": {
"types": ["vitest/importMeta"]
}
}
Here is the official documentation >
Use test.each when there are multiple test data
- Define the type of your test specifications using the
typekeyword. - Prepare your test data in an array format.
- Use
test.eachto execute tests on each item in your array of test data.
type Spec = {
name: string
path: string
description: string
}
const specs: Spec[] = [
{
name: 'About',
path: './docs/10-company-information/20-about.md',
description:
'sinProject Inc. is an software development company in Osaka, Japan. We primarily use SvelteKit and TypeScript, but also work with other programming languages and frameworks.',
},
{
name: 'Events',
path: './docs/10-company-information/40-events.md',
description: 'Here are some of the events organized by sinProject.',
},
]
it.each(specs)('generate_page_content($name)', async (spec) => {
const { name, path, description, content } = spec
const result = await Markdown.generate_page_content(path)
expect(result.title).toBe(name)
expect(result.description).toBe(description)
})