chrome-devtools-axi AGENTS.md

AGENTS.md

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

Commands

pnpm run build       # tsc to dist/ + chmod the CLI entrypoint
pnpm run build:skill # Regenerate the minimal skills/chrome-devtools-axi/SKILL.md stub from src/skill.ts
pnpm run dev         # Run the CLI from source with tsx
pnpm test            # vitest run (test/*.test.ts)
pnpm run test:watch  # vitest watch mode

Run a single test file: pnpm test test/cli.test.ts. Filter by test name: pnpm test -- -t "formatStopOutput". Check formatting with pnpm exec prettier --check ..

The committed skills/chrome-devtools-axi/SKILL.md is generated by pnpm run build:skill; pnpm test fails if it drifts from createSkillMarkdown(). Its body and frontmatter are owned by src/skill.ts; update the generator instead of hand-editing SKILL.md.

Project Conventions

• Node 20+, TypeScript, ESM-only ("type": "module", module resolution Node16 - relative imports use .js extensions even from .ts files).
• Tests live in test/*.test.ts and run with Vitest.
• Run pnpm run build and pnpm test before pushing.
• Do not hand-edit generated files: CHANGELOG.md and .release-please-manifest.json (owned by release-please) or skills/chrome-devtools-axi/SKILL.md (owned by build:skill).
• Every pull_request workflow (ci.yml, guard-generated-files.yml, no-mistakes-required.yml) uses paths-ignore for the release-please output set (.release-please-manifest.json, CHANGELOG.md, package.json) so release PRs create zero runs. Job-level bot ifs stay as defense in depth. test/release-ci-exclusions.test.ts derives that set from release-please-config.json and fails if a workflow drifts; update the ignore lists when adding extra-files or changing release-type.
• Generated files are listed in .prettierignore; validate them with their generator checks instead of formatting them directly.
• Keep skills/chrome-devtools-axi/ in the npm files list when changing package contents; the skill-first install path depends on it shipping with the package.
• pnpm-workspace.yaml enforces a minimum release age for dependency updates as a supply-chain guard; axi-sdk-js and chrome-devtools-axi are exempt.
• .airlock/lint.sh must use pnpm (never npm install or npx); test/airlock-lint.test.ts enforces this.
• Human-authored PRs to main must go through no-mistakes (>= 1.46.0); the gate in no-mistakes-required.yml requires the body signature, the no-mistakes-pipeline-attestation:v1 comment (review/test/document all completed), and the attested head_sha to equal the PR's current head. See CONTRIBUTING.md.
• .github/workflows/no-mistakes-required.yml is a thin caller of the shared kunchenguid/no-mistakes/.github/actions/require-no-mistakes composite action, pinned to an immutable commit SHA and never @main. Enforcement logic and its tests live upstream in the no-mistakes repository; change enforcement there rather than copying it back here, and bump this repository's pin in a deliberate separate PR. This repo still owns its on:, paths-ignore, concurrency, permissions, job name, and author-exemption if:.
• The gate runs on opened, edited, and reopened events, not on pushes. When one of those events runs, the shared action's head binding rejects a body that no-mistakes did not rewrite for the current head. That is the attestation contract, not a flake: push through git push no-mistakes so the body is refreshed.