Getting Started

This guide walks you through installing Scriptorium.Quill and Scriptorium.Nib, writing your first test, and running it.

Prerequisites

Required:

• .NET SDK/Runtime
• Fable

Depending on the target you run:

• Node.js — for the JavaScript and TypeScript targets
• Python 3 with fable-library installed

Setup

1. Create a test project

   dotnet new console -lang F# -n YourProjectName
   cd YourProjectName

2. Add the packages

   dotnet add package Scriptorium.Quill
   dotnet add package Scriptorium.Nib

3. Write your first test

   Program.fs

   module YourProjectName.Main
   
   open Scriptorium.Nib.Assertion
   open type Scriptorium.Quill.Test
   open type Scriptorium.Quill.Runner
   
   [<EntryPoint>]
   let main _ =
       runTests [
           testList ("Calculator", [
   
               test ("add returns the sum", fun _ ->
                   assertThat (1 + 1) (isEqualTo 2)
               )
   
               test ("multiple assertions can be chained", fun _ ->
                   assertThat 42 (
                       isGreaterThan 0
                       >> isLessThan 100
                       >> isNotEqualTo 0
                   )
               )
           ])
       ]

4. Finally run the tests

   # .NET
   dotnet run
   
   # JavaScript
   dotnet fable --runScript
   
   # TypeScript
   dotnet fable --lang typescript -o build-ts --run npx tsx build-ts/Program.ts
   
   # Python (needs fable-library in the environment)
   dotnet fable --lang python -o build-py --run uv run --frozen python build-py/program.py

   The same test suite runs unchanged on every target.

   You should see output like this:

   

What’s next?

Test DSL Async tests, focus mode, pending tests, and testSequenced in Scriptorium.Quill.

Assertion functions Learn how to write and compose assertions.

Snapshot testing Don't worry about writing assertions for complex objects. Just snap and compare.

DOM testing Playwright-powered DOM assertions and browser test helpers.