Inspect Scout Viewer

A React-based web viewer for Inspect AI evaluation logs.

Prerequisites

This project uses pnpm as its package manager, managed through corepack.

Setup

Enable corepack (required once):

corepack enable

That's it! Corepack is built into Node.js 16.9+ and will automatically install the correct pnpm version (specified in package.json) when you run pnpm commands.

Alternative: If you prefer to install pnpm manually, see the official pnpm installation guide.

Install Dependencies

pnpm install

Development

Start the development server:

pnpm dev

Build for production:

pnpm build

Watch mode for development:

pnpm watch

Preview production build:

pnpm preview

Code Quality

Run linting:

pnpm lint

Auto-fix linting issues:

pnpm lint:fix

Format code:

pnpm format

Check formatting:

pnpm format:check

Type check:

pnpm typecheck

Run all checks (lint, format, typecheck):

pnpm check

TypeScript Types from OpenAPI

Types are auto-generated from the FastAPI OpenAPI spec to keep client/server in sync.

How It Works

The type generation pipeline:

Python Pydantic models → openapi.json → generated.ts → built app

1. Export schema: Python script exports OpenAPI spec from FastAPI to openapi.json
2. Generate types: openapi-typescript generates TypeScript types from schema
3. Type adapter: src/types/api-types.ts re-exports types with clean names
4. Usage: Import types from src/types/index.ts in your code

Updating Types After API Changes

When Python Pydantic models change:

# 1. Export updated OpenAPI schema
.venv/bin/python scripts/export_openapi_schema.py

# 2. Types regenerate automatically on next build
pnpm build

Commit both openapi.json and src/types/generated.ts.

Manual Type Generation

pnpm types:generate

CI Validation

CI automatically validates the type generation pipeline:

• openapi-schema job: Regenerates openapi.json and fails if it differs from committed version
• js-build job: Regenerates generated.ts and fails if it differs from committed version

If CI fails, run the commands shown in the error message and commit the updated files.

Tech Stack

• React 19
• TypeScript
• Vite
• Bootstrap 5
• AG Grid
• React Router