Shortest

Features

Using Shortest in your project

Installation

npx @antiwork/shortest init

Quick start

importtype{ShortestConfig}from"@antiwork/shortest";exportdefault{headless:false,baseUrl:"http://localhost:3000",browser:{contextOptions:{ignoreHTTPSErrors:true},},testPattern:"**/*.test.ts",ai:{provider:"anthropic",},}satisfiesShortestConfig;

import{shortest}from"@antiwork/shortest";shortest("Login to the app using email and password",{username:process.env.GITHUB_USERNAME,password:process.env.GITHUB_PASSWORD,});

Using callback functions

import{shortest}from"@antiwork/shortest";import{db}from"@/lib/db/drizzle";import{users}from"@/lib/db/schema";import{eq}from"drizzle-orm";shortest("Login to the app using username and password",{username:process.env.USERNAME,password:process.env.PASSWORD,}).after(async({ page})=>{// Get current user's clerk ID from the pageconstclerkId=awaitpage.evaluate(()=>{returnwindow.localStorage.getItem("clerk-user");});if(!clerkId){thrownewError("User not found in database");}// Query the databaseconst[user]=awaitdb.select().from(users).where(eq(users.clerkId,clerkId)).limit(1);expect(user).toBeDefined();});

Lifecycle hooks

import{shortest}from"@antiwork/shortest";shortest.beforeAll(async({ page})=>{awaitclerkSetup({frontendApiUrl:process.env.PLAYWRIGHT_TEST_BASE_URL??"http://localhost:3000",});});shortest.beforeEach(async({ page})=>{awaitclerk.signIn({    page,signInParams:{strategy:"email_code",identifier:"iffy+clerk_test@example.com",},});});shortest.afterEach(async({ page})=>{awaitpage.close();});shortest.afterAll(async({ page})=>{awaitclerk.signOut({ page});});

Chaining tests

// Sequential test chainshortest(["user can login with email and password","user can modify their account-level refund policy",]);// Reusable test flowsconstloginAsLawyer="login as lawyer with valid credentials";constloginAsContractor="login as contractor with valid credentials";constallAppActions=["send invoice to company","view invoices"];// Combine flows with spread operatorshortest([loginAsLawyer, ...allAppActions]);shortest([loginAsContractor, ...allAppActions]);

API testing

constreq=newAPIRequest({baseURL:API_BASE_URI,});shortest("Ensure the response contains only active users",req.fetch({url:"/users",method:"GET",params:newURLSearchParams({active:true,}),}),);

shortest(`  Test the API GET endpoint${API_BASE_URI}/users with query parameter { "active": true }  Expect the response to contain only active users`);

Running tests

pnpm shortest# Run all testspnpm shortest login.test.ts# Run specific tests from a filepnpm shortest login.test.ts:23# Run specific test from a file using a line numberpnpm shortest --headless# Run in headless mode using

CI setup

GitHub 2FA login setup

shortest --github-code --secret=<OTP_SECRET>

Environment setup

ANTHROPIC_API_KEY=your_api_keyGITHUB_TOTP_SECRET=your_secret# Only for GitHub auth tests

Shortest CLI development

Web app development

Prerequisites

Warning

Using this package with React 18 in Next.js 14+ projects may cause type conflicts with Server Actions anduseFormStatus

If you encounter type errors with form actions or React hooks, ensure you're using React 19

Getting started

git clone https://github.com/antiwork/shortest.gitcd shortest

npm install -g pnpmpnpm install

Environment setup

For Antiwork team members

pnpm i -g vercelvercel linkvercel env pull

For other contributors

Set up the database

pnpm drizzle-kit generatepnpm db:migratepnpm db:seed# creates stripe products, currently unused

Services configuration

Running locally

pnpm dev