compat-review — Claude Code skill: what it does, how to install
compat-review verifies lodash compatibility claims in es-toolkit pull requests against runtime behavior. Runs before-and-after Vitest comparisons.
MIT 238 installs ★ 11,397 updated 2026-10-24
npx skills add toss/es-toolkit --skill compat-review -a claude-codeWhat compat-review does
This skill streamlines reviewing compatibility pull requests in the es-toolkit repository. It inspects PR metadata with gh pr view, isolates the target function, and drafts a temporary Vitest spec at src/compat/{category}/_compat-review-{fn}.spec.ts. The test suite pairs the contributor's sample cases with roughly 10 synthesized edge cases covering nullish values, type coercion, and boundary inputs.
The evaluation runs in two stages via yarn vitest. First, it confirms the bug exists on the main branch. Next, it applies the diff with git apply to verify that the fix works without breaking edge cases. Once finished, it wipes the test file, resets the working tree via git checkout -- ., and writes a structured markdown report.
The workflow fails if the GitHub CLI (gh) is missing or if tests cannot resolve lodash and es-toolkit/compat locally.
What it helps with
- verify reported lodash behavioral discrepancies at runtime
- generate boundary and type-coercion test cases for utility functions
- check pull requests for regressions prior to merging
- format before-and-after test execution reports
Example prompts for the agent
- Review PR 1234 to verify lodash compatibility claims
- Run compat-review for the chunk function
- Test compat layer discrepancies in PR 850
How to install compat-review
1Skills CLI (Vercel)
npx skills add toss/es-toolkit --skill compat-review -a claude-code2Manually: put the files in place
~/.claude/skills/compat-review/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/compat-review/
1Skills CLI (Vercel)
npx skills add toss/es-toolkit --skill compat-review -a codex2Manually: put the files in place
.agents/skills/compat-review/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add toss/es-toolkit --skill compat-review -a cursor2Manually: put the files in place
.cursor/skills/compat-review/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install toss/es-toolkit .claude/skills/compat-review2Manually: put the files in place
.github/skills/compat-review/SKILL.md1Skills CLI (Vercel)
npx skills add toss/es-toolkit --skill compat-review -a gemini-cli2Platform CLI
gemini skills install https://github.com/toss/es-toolkit --path .claude/skills/compat-reviewManually: put the files in place
.devin/skills/compat-review/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add toss/es-toolkit --skill compat-review -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about compat-review
How to install compat-review in Claude Code?
Run npx skills add toss/es-toolkit --skill compat-review -a claude-code. The skill file will be placed in ~/.claude/skills/compat-review/SKILL.md.
What does compat-review do?
It runs automated runtime comparisons between es-toolkit/compat and lodash. The agent builds a temporary Vitest suite, checks behavior before and after applying a PR patch, and delivers a markdown table verdict.
Which local tools are required for this skill?
The skill relies on gh, git, and yarn in your environment. Inside the agent, it requests execution access for Bash, Read, Write, Grep, and Glob.
Source text
SKILL.md · MIT
---
name: compat-review
description: Verify compat PR claims by running lodash vs es-toolkit/compat at runtime
argument-hint: '<PR number or function name>'
allowed-tools: Bash, Read, Write, Grep, Glob
---
# Compat Layer Review
Verify that a compat PR actually fixes a real lodash inconsistency.
## Input
$ARGUMENTS — PR number (e.g. `1234`) or function name (e.g. `chunk`)
## Workflow
### 1. Identify target function and PR claims
**PR number**:
```bash
gh pr view {number} --repo toss/es-toolkit --json title,body,files
```
From the PR description and diff, extract:
- Which compat function is being fixed
- What inconsistency the contributor claims (expected vs actual behavior)
- Any test examples the contributor provides
**Function name**: Read the function source and its spec to understand current behavior.
### 2. Build comparison test
Create a temporary vitest spec at `src/compat/{category}/_compat-review-{fn}.spec.ts`.
```typescript
import { describe, expect, it } from 'vitest';
import { fn as compatFn } from 'es-toolkit/compat';
import { fn as lodashFn } from 'lodash';
```
Include two groups of test cases:
**A. Contributor's claimed examples** — Extract directly from the PR description or test diff. These are the cases the PR claims to fix.
**B. ~10 additional edge cases you generate** — Based on the function's signature and lodash's known behavior patterns:
- Empty inputs: `[]`, `{}`, `''`, `0`
- Nullish: `null`, `undefined`
- Negative/zero/float numbers: `-1`, `0`, `1.5`, `NaN`, `Infinity`
- Type coercion: string numbers (`'3'`), boolean, mixed types
- Boundary: single-element arrays, very long strings, deeply nested objects
- Pick cases that are relevant to the specific function
Each test:
```typescript
it('description', () => {
let lodashResult, compatResult;
let lodashErr: any, compatErr: any;
try {
lodashResult = lodashFn(args);
} catch (e) {
lodashErr = e;
}
try {
compatResult = compatFn(args);
} catch (e) {
compatErr = e;
}
if (lodashErr && compatErr) return; // both throw = consistent
if (lodashErr || compatErr) {
throw new Error(`Behavior mismatch: ${lodashErr ? 'lodash throws' : 'compat throws'}`);
}
expect(compatResult).toEqual(lodashResult);
});
```
### 3. Run comparison BEFORE the PR change
```bash
yarn vitest run src/compat/{category}/_compat-review-{fn}.spec.ts
```
Record which tests fail — these are real inconsistencies that exist on main.
### 4. Apply PR changes and re-run
```bash
gh pr diff {number} --repo toss/es-toolkit | git apply
```
Run the same test again. Confirm that:
- The contributor's claimed examples now pass
- The additional edge cases still pass (no regressions)
Revert after testing:
```bash
git checkout -- .
```
### 5. Clean up
Delete `_compat-review-*.spec.ts`.
### 6. Report
```
## {fn} — Compat Review
### PR Claim
{What the contributor says they're fixing}
### Verification (BEFORE fix)
| # | Input | lodash | compat | Match? | Source |
|---|-------|--------|--------|--------|--------|
| 1 | ... | ... | ... | MISMATCH | PR example |
| 2 | ... | ... | ... | MATCH | Edge case |
### Verification (AFTER fix)
| # | Input | lodash | compat | Match? | Source |
|---|-------|--------|--------|--------|--------|
### Verdict
- [ ] PR claim is valid (inconsistency confirmed on main)
- [ ] Fix resolves the claimed inconsistency
- [ ] No regressions in edge cases
- [ ] Existing tests still pass
```
© toss · MIT · toss/es-toolkit