playwright-release

A CLI tool that fetches, parses, and displays Playwright release notes from the official repository.

Features

• Fetches Playwright release notes in Markdown format.
• Parses Markdown string to extract release sections and information.
• Outputs structured release data via terminal GUI.

Usage

Using shell alias

1. build the application:

   pnpm install
   pnpm build

2. open your shell configuration file (e.g., ~/.bashrc, ~/.zshrc) and add the following alias:

   alias pr="node ~/path/to/playwright-release/dist/index.js"

3. reload your shell configuration:

   source ~/.bashrc

4. then use the alias:

   pr

Development

pnpm install
pnpm dev

Build

pnpm build

Keyboard shortcuts

List

• down | j - move down to the next item
• up | k - move up to the previous item
• right | l | Enter - switch to infobox

Infobox

• left | h - switch back to list
• down | j - scroll down in the infobox
• up | k - scroll up in the infobox

Screen

• Ctrl + c | q | Q - exit the application
• r | R - rerender the screen

Search

Search input allows for very simple searching by checking whether provided string is present in the release notes.

• Alt + s | s | S - focus the search input
• Enter - submits search query string and updates UI with results. Switches focus to list.

Scripts

• dev: Run the app in development mode using tsx.
• build: Compile TypeScript to JavaScript in the dist directory.
• type-check: Run TypeScript type checking.
• lint: Lint the codebase with ESLint.

Project Structure

• src/api.ts: Fetches Markdown from the Playwright repository.
• src/parser.ts: Parses Markdown and converts it to JSON.
• src/client.ts: Handles displaying or using the parsed data.
• src/index.ts: Main entry point, orchestrates fetching, parsing, and output.

License

MIT