OpenParable
Skip to content
← Back to skills

Prettier Compare

Testing & Quality
prettier-compare

Prettier Compare is an Agent Skill for testing & quality published in the biomejs/biome repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Compares code formatting and formatting IR between Biome and Prettier to ensure that Biome's formatting is consistent and correct. Use when validating formatter changes, debugging formatting differences, or comparing output for JavaScript, TypeScript, CSS, or other languages.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/biomejs/biome/blob/HEAD/.claude/skills/prettier-compare/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/prettier-compare, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Purpose

Use packages/prettier-compare/ to inspect any differences between Biome and Prettier formatting (including IR output) before shipping formatter changes.

Prerequisites

  1. Run every command from the repository root so relative paths resolve correctly.
  2. Use bun (the CLI is a Bun script) and ensure dependencies have been installed.
  3. Always pass --rebuild so the Biome WASM bundle matches your current Rust changes.

Code Standards

CRITICAL: No Emojis

Emojis are BANNED in all Prettier comparison code and output:

  • NO emojis in comparison scripts
  • NO emojis in test files
  • NO emojis in output or diagnostic messages

Keep all code professional and emoji-free.

Common workflows

Snippets passed as CLI args:

bun packages/prettier-compare/bin/prettier-compare.js --rebuild 'const x={a:1,b:2}'

Force a language (useful when the tool cannot infer it from a filename):

bun packages/prettier-compare/bin/prettier-compare.js --rebuild -l ts 'const x: number = 1'

Compare files on disk:

bun packages/prettier-compare/bin/prettier-compare.js --rebuild -f src/example.tsx

Read from stdin (great for piping editor selections):

echo 'const x = 1' | bun packages/prettier-compare/bin/prettier-compare.js --rebuild -l js

Tips

  • Use -l/--language when formatting code without an extension so both formatters pick the correct parser.
  • Use -f/--file for large samples or snapshot tests so you can iterate directly on project fixtures.
  • Reference packages/prettier-compare/README.md for deeper CLI details; mirror any updates here, keeping the hard requirement that commands include --rebuild.
  • Use single quotes for code snippets passed as CLI arguments to avoid shell interpretation issues.
  • "\n" does not get escaped into a newline when passed as a CLI argument. You should write a literal newline or use a file instead.
  • The tool is OK to run in read-only/planning modes even when running it with --rebuild since it only rebuilds the Biome WASM bundle and does not modify any source files.