Documentation

Use ubq#

Guide: The API, the rules, and the commands.
API reference: Each export of the package, with its type.
Convert a project: How to move a project from tap, node:test, vitest, jest, or mocha.
Configuration: Which files ubq runs, and the ubq key of package.json.
Agent skill: The use-ubq skill that ubq skill writes for your agent.
License: Blue Oak Model License 1.0.0.

Design#

This documentation record how ubq was designed and built: the decisions and their reasons, the measurements, and the status of the work. Agents and people wrote them during the work, for the agents and people who maintain the tool.

Goals: The goals of the project, from its author.
What agents need: What an agent needs from a test tool. Written by an agent, before the design.
Decisions: Each design decision, with its reason.
Measurements: The measured costs that the design depends on.
Architecture: The parts, the process model, events, coverage, and the store.
API design: The test file API, and what is absent on purpose.
Events: The events that a test process sends to the runner.
Status: What is built, and the known limits.
Open questions: Points that wait for a decision.
Coverage on Bun: What ubq needs from Bun for coverage of each test.
Server: The optional background server.