Skip to content

AGENTS.md

Latest commit

 

History

History
43 lines (26 loc) · 1.53 KB

AGENTS.md

File metadata and controls

43 lines (26 loc) · 1.53 KB
Raw

AGENTS.md

This file provides guidance to AI coding agents when working with code in this repository.

Project Overview

uBlacklist is a browser extension that blocks specific sites from appearing in search engine results. It supports Chrome, Firefox, Edge, and Safari, with cloud sync via Google Drive, Dropbox, WebDAV, and browser sync.

Development Commands

# Install dependencies (pnpm >= 10 required)
pnpm install

# Build extension (outputs to dist/<browser>[-debug])
pnpm build [--browser=chrome|firefox|edge|safari] [--debug]

# Run all checks (oxlint and oxfmt)
pnpm check

# Run tests
pnpm test

# Fix linting/formatting issues
pnpm fix

Verifying Changes

After editing, run pnpm check to verify (this runs oxlint and oxfmt).

Ruleset and SERPINFO Specifications

The ruleset and SERPINFO specifications are available as agent skills (ublacklist-ruleset and ublacklist-serpinfo), published in ublacklist/packages.

Adding or Changing Messages

  1. Edit src/_locales/en/messages.json (English is the source of truth; other locales are managed via Crowdin — do not edit them directly).
  2. Run pnpm generate:message-names to regenerate message name constants.

Related Repositories

uBlacklist is split across multiple repositories; this repository (iorate/ublacklist) contains the extension itself, and the others are listed in the Related repositories section of the README. Changes to a specific subsystem belong in its repository.