Getting Started

Welcome to playwright-core — annotation-driven Playwright testing infrastructure for better observability and traceability.

What is playwright-core?

This is a monorepo of Playwright testing tools built around annotation-driven testing. It provides:

Type-safe annotations for linking tests to user journeys and business requirements
Flexible reporter with pluggable storage adapters
Ready-to-use adapters for filesystem, Slack, and Firestore

Open Source — These packages are published to npm and can be used by any team.

Packages Overview

Annotation Framework

Type-safe helpers for annotating tests with metadata. Includes validation framework and Contentstack conventions.

@lytics/playwright-annotations

Core Reporter

Adapter-based reporter that processes test results and writes them to multiple backends.

@lytics/playwright-reporter

Storage Adapters

Ready-to-use adapters for filesystem, Slack notifications, and Google Cloud Firestore.

@lytics/playwright-adapters

Installation


# Install all packages
npm install @lytics/playwright-annotations @lytics/playwright-reporter @lytics/playwright-adapters
 
# Or install individually
npm install @lytics/playwright-annotations
npm install @lytics/playwright-reporter
npm install @lytics/playwright-adapters

Prerequisites

Node.js v22 LTS or higher
Playwright v1.40 or higher

Next Steps

Quickstart — Get up and running in 5 minutes
Core Concepts — Understand annotation-driven testing
Annotations — Learn the annotation framework