dx-review — Claude Code skill: what it does, how to install
dx-review audits library APIs for developer ergonomics, TypeScript typing quality, and error clarity. Flags friction points before external developers hit them.
MIT 1 installs ★ 1,855 updated 2026-10-26
npx skills add LibPDF-js/core --skill dx-review -a claude-codeWhat dx-review does
The skill evaluates public library interfaces from a consumer's viewpoint. When no specific scope is given in the prompt, the agent examines the primary public exports. It tests method naming predictability, default arguments, and whether common operations require excessive boilerplate. The review focuses on discoverability, consistency, ergonomics, error messaging, TypeScript definitions, JSDoc examples, and alignment with platform conventions.
During the audit, the agent inspects type declarations, walks through typical user workflows, and catches confusing parameter orders. The skill writes its findings to .agents/scratch/dx-review-<scope>.md. Every documented issue includes a severity rating, the awkward code snippet, and a concrete refactoring recommendation.
What it helps with
- audit public API ergonomics and naming consistency
- detect loose TypeScript types that weaken editor autocomplete
- spot unnecessary boilerplate across standard library workflows
- generate a markdown review with side-by-side code recommendations
Example prompts for the agent
- Run a DX review on our main public API
- Check the developer ergonomics of the form manipulation module
- Audit TypeScript types and error handling in the current export surface
How to install dx-review
1Skills CLI (Vercel)
npx skills add LibPDF-js/core --skill dx-review -a claude-code2Manually: put the files in place
~/.claude/skills/dx-review/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/dx-review/
1Skills CLI (Vercel)
npx skills add LibPDF-js/core --skill dx-review -a codex2Manually: put the files in place
.agents/skills/dx-review/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add LibPDF-js/core --skill dx-review -a cursor2Manually: put the files in place
.cursor/skills/dx-review/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install LibPDF-js/core .opencode/skills/dx-review2Manually: put the files in place
.github/skills/dx-review/SKILL.md1Skills CLI (Vercel)
npx skills add LibPDF-js/core --skill dx-review -a gemini-cli2Platform CLI
gemini skills install https://github.com/LibPDF-js/core --path .opencode/skills/dx-reviewManually: put the files in place
.devin/skills/dx-review/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add LibPDF-js/core --skill dx-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 dx-review
How to install dx-review in Claude Code?
Run npx skills add LibPDF-js/core --skill dx-review -a claude-code.
What does dx-review evaluate?
It inspects public APIs across consistency, discoverability, boilerplate friction, TypeScript type precision, error clarity, in-code documentation, and platform conventions.
Where does the skill store its findings?
The agent saves a structured markdown report to .agents/scratch/dx-review-<scope>.md, detailing issues with severity levels, category tags, and replacement code examples.
Source text
SKILL.md · MIT
--- name: dx-review description: Review developer experience and API ergonomics --- You are reviewing the developer experience (DX) of the library to ensure it feels good to use. As a library consumed by other developers, ergonomics matter as much as functionality. ## Your Task 1. **Identify scope** - Based on the conversation context, determine what module or feature to review. If no specific scope is mentioned, review the main public API. 2. **Analyze the API surface** - How do developers interact with this code? 3. **Evaluate ergonomics** - Is it intuitive, consistent, and pleasant to use? 4. **Report findings** - Document issues and recommendations ## DX Evaluation Criteria ### 1. Discoverability - Can developers find what they need? - Are method names intuitive and searchable? - Is the API surface appropriately sized (not too sprawling)? ### 2. Consistency - Do similar operations work the same way? - Are naming conventions consistent across the API? - Do return types follow predictable patterns? ### 3. Ergonomics - Is the common case easy? (pit of success) - Are required parameters actually required? - Do defaults make sense for typical usage? - Is there unnecessary boilerplate? ### 4. Error Experience - Are errors actionable? (tells you what went wrong AND how to fix it) - Do errors surface at the right time? (fail fast) - Are error types specific enough to catch programmatically? ### 5. Type Experience - Does autocomplete guide developers? - Are types precise (not too wide like `any` or `string`)? - Do generics add value or just complexity? ### 6. Documentation in Code - Are public methods documented with JSDoc? - Do examples in comments actually work? - Are parameter constraints documented? ### 7. Comparison to Standards - How does this compare to similar libraries developers know? - Does it follow platform conventions (Node.js, Web APIs)? - Would a developer's intuition from other libraries apply here? ## Review Process ### Step 1: Use the API Put yourself in a consumer's shoes: - What would a developer try first? - What questions would they have? - Where would they get stuck? ### Step 2: Read the Types Examine the TypeScript definitions: - What does autocomplete show? - Are overloads clear or confusing? - Do type errors make sense? ### Step 3: Trace Common Workflows Walk through typical tasks: - Opening a PDF and reading metadata - Modifying form fields - Saving changes - Handling errors ### Step 4: Look for Friction Identify pain points: - Unnecessary ceremony or boilerplate - Confusing parameter orders - Inconsistent patterns - Missing conveniences ## Output Format Write your review to `.agents/scratch/dx-review-<scope>.md`: ````markdown # DX Review: <Scope> ## Summary Overall assessment and top priorities. ## What's Working Well - Positive patterns to preserve ## Issues Found ### Issue 1: <Title> **Severity:** High/Medium/Low **Category:** Discoverability/Consistency/Ergonomics/Errors/Types/Docs **Problem:** Description of the issue from a developer's perspective. **Example:** ```typescript // Current awkward usage ``` **Recommendation:** ```typescript // Proposed improvement ``` ### Issue 2: ... ## Recommendations Summary Prioritized list of changes to improve DX. ## Comparison Notes How we compare to pdf-lib, pdfjs, or other libraries developers might know. ``` ## Guidelines - **Be specific** - Vague feedback isn't actionable - **Show, don't tell** - Include code examples - **Prioritize** - Not all issues are equal - **Be constructive** - Propose solutions, not just problems - **Consider tradeoffs** - Note when fixing one thing might hurt another - **Think like a user** - You're advocating for developers who will use this ## Begin Review the scope determined from the conversation context (or the main API if unspecified) and document your DX findings. ``` ````
© LibPDF-js · MIT · LibPDF-js/core