Testing

Vitest is a modern, fast, and feature rich testing framework that integrates with Typescript and our development environment.

Mocking Capabilities: As a client side library that interacts heavily with browser APIs, the ability to mock these dependencies a necessity. Provides an intuitive mocking system (vi.mock(), vi.fn()). As seen in tests we use this to mock browser APIs like AudioContext and navigator.mediaDevices. This allows us to test logic in testable units without a live browser environment.
Module Mocking: The API is made up of classes that interact with each other. Vitest module mocking allows us to replace entire classes with mocked versions of themselves, allowing testing of each classes individual logic.
TypeScript Support & Performance: Vitest offers support for Typescript with minimal configuration. Also built on top of vite with is fast (APIs bundler of choice is also vite).

Given that AACommodate is a client side library with complex internal logic and dependencies on browser specific functions, Vitest is an ideal choice. Powerful mocking, Typescript support, and Vite bundling are the primary reason for its suitability. This ensure AACommodate can be a dependable tool for developers.

This is auto generated on every pull request against main with passing test in our Github actions CI/CD Pipeline