Nucleify Docs
EN PL

Tests

Vitest

Nucleify uses Vitest for unit and integration tests across the monorepo. Root config defines two projects — web (Nuxt environment) and shared (happy-dom) — plus a separate compiler test suite.

Running tests

pnpm tests              # all root projects (web + shared)
pnpm test:watch         # watch mode
pnpm test:web           # Nuxt project only
pnpm test:shared        # shared_modules only
pnpm compiler:test      # compiler unit tests

CI and the Husky pre-commit hook run pnpm tests as part of .config/bash/hook-checks.sh alongside bash tests, Biome, TypeScript, Stylelint, Nuxt build, and compiler checks (pre-push is a no-op).

Project configuration

Root vitest.config.ts defines workspace projects:

web project

  • Root: web/
  • Environment: nuxt (via @nuxt/test-utils)
  • Include: vitests/**/*.{test,spec}.{js,ts,jsx,tsx}
  • Timeout: 30s
  • Alias: nucleify → web/src/nucleify.ts

shared project

  • Root: shared_modules/
  • Environment: happy-dom
  • Include: **/vitests/**/*.{test,spec}.{js,ts}
  • Timeout: 15s
  • Alias: nucleify → shared_modules/nucleify.ts
  • Define: import.meta.client / import.meta.server shims

Both projects share setup from .config/vitest_setup.ts and use threaded pools.

Compiler project

Separate config at .config/vitest.compiler.config.ts:

pnpm compiler:test

Tests live in compiler/tests/.

Where to put tests

Location Pattern Project
web/vitests/ *.test.ts web
shared_modules/nuc_*/vitests/ *.test.ts shared
compiler/tests/ fixtures + unit compiler

Co-locate module tests inside the module (shared_modules/nuc_colors/vitests/). Do not put shared module tests under web/vitests/ unless they require Nuxt runtime.

Writing module tests

Example under shared_modules/nuc_colors/vitests/:

import { describe, expect, it } from 'vitest'
import { darkenColor } from '../../utils/darken_color'

describe('darkenColor', () => {
  it('darkens a hex color', () => {
    expect(darkenColor('#ffffff', 0.1)).toMatch(/^#[0-9a-f]{6}$/i)
  })
})

Run only shared module tests while iterating:

pnpm test:shared

Writing Nuxt tests

Place files in web/vitests/. The Nuxt test environment mounts components with @nuxt/test-utils:

import { describe, expect, it } from 'vitest'
import { mountSuspended } from '@nuxt/test-utils/runtime'
import MyComponent from '~/components/MyComponent.vue'

describe('MyComponent', () => {
  it('renders', async () => {
    const wrapper = await mountSuspended(MyComponent)
    expect(wrapper.text()).toContain('expected')
  })
})

Setup file

.config/vitest_setup.ts configures global test behavior (mocks, matchers from @testing-library/jest-dom where used). Both web and shared projects import it via setupFiles.

Console log suppression is enabled (onConsoleLog: () => false) to reduce noise in CI.

Pre-commit hook suite

Husky pre-commit runs (via .config/bash/hook-checks.sh), in order:

  1. pnpm btest — bash test suite
  2. pnpm check — Biome
  3. pnpm typeslint — TypeScript (web/tsconfig.json)
  4. pnpm slint — Stylelint on SCSS
  5. pnpm build — Nuxt production build
  6. pnpm tests — Vitest
  7. pnpm compiler:test — compiler unit tests
  8. pnpm compiler:check — emit fingerprints

Pre-push is a no-op. Fix failures locally before committing.

Coverage & debugging

Run a single file:

pnpm vitest run shared_modules/nuc_stores/cookie/get_item/index.test.ts
pnpm vitest run --project web web/vitests/some.test.ts

Enable watch during development:

pnpm test:watch