Run any Skill in Manus with one click

orval

Stars163

Forks12

UpdatedMay 27, 2026 at 09:50

Orval OpenAPI TypeScript client generation best practices. This skill should be used when configuring Orval, generating TypeScript clients from OpenAPI specs, setting up React Query/SWR hooks, creating custom mutators, or writing MSW mocks. Triggers on tasks involving orval.config.ts, OpenAPI codegen, API client setup, or mock generation.

Installation

Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.

Run Skill in Manus

Source

pproenca

pproenca/dot-skills

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

File Explorer

48 files

SKILL.md

readonly

name	orval
description	Orval OpenAPI TypeScript client generation best practices. This skill should be used when configuring Orval, generating TypeScript clients from OpenAPI specs, setting up React Query/SWR hooks, creating custom mutators, or writing MSW mocks. Triggers on tasks involving orval.config.ts, OpenAPI codegen, API client setup, or mock generation.

Orval OpenAPI Best Practices

Comprehensive guide for generating type-safe TypeScript clients from OpenAPI specifications using Orval. Contains 42 rules across 8 categories, prioritized by impact to guide automated configuration, client generation, and testing setup.

When to Apply

Reference these guidelines when:

Configuring Orval for a new project
Setting up OpenAPI-based TypeScript client generation
Integrating React Query, SWR, or Vue Query with generated hooks
Creating custom mutators for authentication and error handling
Generating MSW mocks for testing

Rule Categories by Priority

Priority	Category	Impact	Prefix
1	OpenAPI Specification Quality	CRITICAL	`spec-`
2	Configuration Architecture	CRITICAL	`orvalcfg-`
3	Output Structure & Organization	HIGH	`output-`
4	Custom Client & Mutators	HIGH	`mutator-`
5	Query Library Integration	MEDIUM-HIGH	`oquery-`
6	Type Safety & Validation	MEDIUM	`types-`
7	Mock Generation & Testing	MEDIUM	`mock-`
8	Advanced Patterns	LOW	`adv-`

Quick Reference

1. OpenAPI Specification Quality (CRITICAL)

spec-operationid-unique - Use unique and descriptive operationIds
spec-schemas-reusable - Define reusable schemas in components
spec-tags-organization - Organize operations with tags
spec-response-types - Define all response types explicitly
spec-required-fields - Mark required fields explicitly

2. Configuration Architecture (CRITICAL)

orvalcfg-mode-selection - Choose output mode based on API size
orvalcfg-client-selection - Select client based on framework requirements
orvalcfg-separate-schemas - Separate schemas into dedicated directory
orvalcfg-input-validation - Validate OpenAPI spec before generation
orvalcfg-baseurl-setup - Configure base URL properly
orvalcfg-prettier-format - Enable automatic code formatting

3. Output Structure & Organization (HIGH)

output-file-extension - Use distinct file extensions for generated code
output-index-files - Generate index files for clean imports
output-naming-convention - Configure consistent naming conventions
output-clean-target - Enable clean mode for consistent regeneration
output-headers-enabled - Enable headers in generated functions

4. Custom Client & Mutators (HIGH)

mutator-custom-instance - Use custom mutator for HTTP client configuration
mutator-error-types - Export custom error types from mutator
mutator-body-wrapper - Export body type wrapper for request transformation
mutator-interceptors - Use interceptors for cross-cutting concerns
mutator-token-refresh - Handle token refresh in mutator
mutator-fetch-client - Use fetch mutator for smaller bundle size

5. Query Library Integration (MEDIUM-HIGH)

oquery-hook-options - Configure default query options globally
oquery-key-export - Export query keys for cache invalidation
oquery-infinite-queries - Enable infinite queries for paginated endpoints
oquery-suspense-support - Enable suspense mode for streaming UX
oquery-signal-cancellation - Pass AbortSignal for request cancellation
oquery-mutation-callbacks - Use generated mutation options types

6. Type Safety & Validation (MEDIUM)

types-zod-validation - Generate Zod schemas for runtime validation
types-zod-strict - Enable Zod strict mode for safer validation
types-zod-coerce - Use Zod coercion for type transformations
types-use-dates - Enable useDates for Date type generation
types-bigint-support - Enable useBigInt for large integer support

7. Mock Generation & Testing (MEDIUM)

mock-msw-generation - Generate MSW handlers for testing
mock-use-examples - Use OpenAPI examples for realistic mocks
mock-delay-config - Configure mock response delays
mock-http-status - Generate mocks for all HTTP status codes
mock-index-files - Generate mock index files for easy setup

8. Advanced Patterns (LOW)

adv-input-transformer - Use input transformer for spec preprocessing
adv-operation-override - Override settings per operation
adv-output-transformer - Use output transformer for generated code modification
adv-form-data-handling - Configure form data serialization

How to Use

Read individual reference files for detailed explanations and code examples:

Section definitions - Category structure and impact levels
Rule template - Template for adding new rules
Example: spec-operationid-unique

Related Skills

For consuming generated hooks, see tanstack-query skill
For mocking generated API clients, see test-msw skill
For schema validation, see zod skill

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md

More from this repository

same repository

write-design-docs

pproenca/dot-skills

Write, revise, or review software design documents using Malte Ubl's "Design Docs at Google" guidance. Use when Codex needs to draft a design doc, technical design, RFC, engineering review doc, architecture proposal, mini design doc, or design-doc review focused on context, goals, non-goals, trade-offs, alternatives, cross-cutting concerns, review lifecycle, and deciding whether a design doc is warranted.

2026-06-12163

go-process-cli

pproenca/dot-skills

Write Go CLIs that manage processes and workloads — daemons, supervisors, job runners, deploy tools, anything that spawns or controls other processes. Use when writing, reviewing, or refactoring Go that handles OS signals, runs children via os/exec, fans out concurrent work, threads context for cancellation, returns exit codes, or builds a flag/cobra command surface. Covers the footguns the standard library makes easy to hit — SIGTERM vs Ctrl-C, SIGKILL-by-default children, orphaned process groups, pipe deadlocks, goroutine leaks, zombie reaping, and os.FindProcess lying about liveness. Triggers whenever the task touches process lifecycle, graceful shutdown, subprocess control, or concurrent workload supervision in Go — even if not named.

2026-05-31163

design-review

pproenca/dot-skills

Structured UI design review — existing code (React/JSX, CSS, Tailwind) and, when behaviour matters, the running app in a real browser — reported as a prioritised Before / After / Why table. Covers visual hierarchy, spacing, typography, colour & contrast, component states, motion, responsiveness, accessibility, multi-page flow & navigation, and interaction continuity — grounded in Refactoring UI and Emil Kowalski's principles. For animation/jank/FPS, focus order, and cross-page UX it can drive Chrome via chrome-devtools-mcp to capture what a screenshot can't. Trigger when the user asks to "review this UI", "design review", "critique this component/screen/page or multi-page flow", asks why something "looks off", "looks AI-generated", or "looks like a wireframe", or wants to raise visual polish. For building UI from scratch use web-taste; for the full animation set see emilkowal-animations.

2026-05-27163

deterministic-metric-design

pproenca/dot-skills

Inventing deterministic metrics — turning a fuzzy property like 'maintainability', 'risk', or 'how reducible this code is' into a deterministic, computable number an agent can trust and optimize. Covers the path from construct to adoption — operationalizing the construct, confronting computability limits (Kolmogorov, Rice) with sound proxies, picking the right measurement scale, proving properties (monotonicity, invariance, the Weyuker/Briand axioms), guaranteeing determinism, establishing construct validity (not just LOC in disguise), and hardening against Goodhart-style gaming when an agent optimizes the metric. Trigger when designing, reviewing, or validating a quantitative metric, score, measure, or index — and even when the user doesn't say 'metric' but wants to quantify, score, rank, or measure code/behavior, build a deterministic optimization target, or invent a measure for something previously unquantified (e.g., behavior-preserving codebase-size reduction).

2026-05-27163

implementation-design-patterns

pproenca/dot-skills

Implementation guide for the 22 Gang of Four design patterns in TypeScript, distilled from refactoring.guru. Use this skill when writing, refactoring, or reviewing TypeScript that exhibits a pattern-shaped problem — class-explosion from inheritance, conditionals switching on type, tight coupling to concrete classes, tree-shaped models, runtime algorithm selection, undo/redo, snapshot-and-restore, state-dependent behavior, subscriber notification, or hiding subsystem complexity. Each pattern entry includes intent, problem, solution, applicability (when to use AND when NOT to use), a runnable TypeScript example, implementation steps, pros/cons, and relations to sibling patterns. Trigger even when no pattern is named — cues like "class getting unwieldy," "giant switch," "swap implementations at runtime," "combinatorial subclasses," "need undo," or "traverse a tree" are pattern-shaped. Covers all 5 Creational, 7 Structural, and 10 Behavioral GoF patterns.

2026-05-27163

implementation-functional-patterns

pproenca/dot-skills

TypeScript's functional answers to the 22 Gang of Four classes — factory functions (Factory Method, Abstract Factory, Prototype, Memento), module-scope singletons, fluent immutable builders, wrapper functions (Adapter, Facade), native Proxy, WeakMap caches (Flyweight), discriminated unions with exhaustive match (State, Visitor, Composite), event emitters and signals (Mediator, Observer), pipelines and composition (CoR, Decorator), stream methods (Iterator), closures-as-commands, higher-order strategies, lambda placement. Use when reviewing TypeScript that has a class-shaped problem the GoF catalog solves with a hierarchy but where idiomatic TS reaches for a function, a tagged union, or a data structure. Each rule names the GoF pattern(s) it replaces and when the class form still wins. Trigger on "factory class", "singleton getInstance", "state machine class", "observer pattern", "AST visitor", "where do I put this lambda". Sibling to implementation-design-patterns.

2026-05-27163

name	orval
description	Orval OpenAPI TypeScript client generation best practices. This skill should be used when configuring Orval, generating TypeScript clients from OpenAPI specs, setting up React Query/SWR hooks, creating custom mutators, or writing MSW mocks. Triggers on tasks involving orval.config.ts, OpenAPI codegen, API client setup, or mock generation.

Orval OpenAPI Best Practices

When to Apply

Reference these guidelines when:

Configuring Orval for a new project
Setting up OpenAPI-based TypeScript client generation
Integrating React Query, SWR, or Vue Query with generated hooks
Creating custom mutators for authentication and error handling
Generating MSW mocks for testing

Rule Categories by Priority

Priority	Category	Impact	Prefix
1	OpenAPI Specification Quality	CRITICAL	`spec-`
2	Configuration Architecture	CRITICAL	`orvalcfg-`
3	Output Structure & Organization	HIGH	`output-`
4	Custom Client & Mutators	HIGH	`mutator-`
5	Query Library Integration	MEDIUM-HIGH	`oquery-`
6	Type Safety & Validation	MEDIUM	`types-`
7	Mock Generation & Testing	MEDIUM	`mock-`
8	Advanced Patterns	LOW	`adv-`

Quick Reference

1. OpenAPI Specification Quality (CRITICAL)

spec-operationid-unique - Use unique and descriptive operationIds
spec-schemas-reusable - Define reusable schemas in components
spec-tags-organization - Organize operations with tags
spec-response-types - Define all response types explicitly
spec-required-fields - Mark required fields explicitly

2. Configuration Architecture (CRITICAL)

orvalcfg-mode-selection - Choose output mode based on API size
orvalcfg-client-selection - Select client based on framework requirements
orvalcfg-separate-schemas - Separate schemas into dedicated directory
orvalcfg-input-validation - Validate OpenAPI spec before generation
orvalcfg-baseurl-setup - Configure base URL properly
orvalcfg-prettier-format - Enable automatic code formatting

3. Output Structure & Organization (HIGH)

output-file-extension - Use distinct file extensions for generated code
output-index-files - Generate index files for clean imports
output-naming-convention - Configure consistent naming conventions
output-clean-target - Enable clean mode for consistent regeneration
output-headers-enabled - Enable headers in generated functions

4. Custom Client & Mutators (HIGH)

mutator-custom-instance - Use custom mutator for HTTP client configuration
mutator-error-types - Export custom error types from mutator
mutator-body-wrapper - Export body type wrapper for request transformation
mutator-interceptors - Use interceptors for cross-cutting concerns
mutator-token-refresh - Handle token refresh in mutator
mutator-fetch-client - Use fetch mutator for smaller bundle size

5. Query Library Integration (MEDIUM-HIGH)

oquery-hook-options - Configure default query options globally
oquery-key-export - Export query keys for cache invalidation
oquery-infinite-queries - Enable infinite queries for paginated endpoints
oquery-suspense-support - Enable suspense mode for streaming UX
oquery-signal-cancellation - Pass AbortSignal for request cancellation
oquery-mutation-callbacks - Use generated mutation options types

6. Type Safety & Validation (MEDIUM)

types-zod-validation - Generate Zod schemas for runtime validation
types-zod-strict - Enable Zod strict mode for safer validation
types-zod-coerce - Use Zod coercion for type transformations
types-use-dates - Enable useDates for Date type generation
types-bigint-support - Enable useBigInt for large integer support

7. Mock Generation & Testing (MEDIUM)

mock-msw-generation - Generate MSW handlers for testing
mock-use-examples - Use OpenAPI examples for realistic mocks
mock-delay-config - Configure mock response delays
mock-http-status - Generate mocks for all HTTP status codes
mock-index-files - Generate mock index files for easy setup

8. Advanced Patterns (LOW)

adv-input-transformer - Use input transformer for spec preprocessing
adv-operation-override - Override settings per operation
adv-output-transformer - Use output transformer for generated code modification
adv-form-data-handling - Configure form data serialization

How to Use

Read individual reference files for detailed explanations and code examples:

Section definitions - Category structure and impact levels
Rule template - Template for adding new rules
Example: spec-operationid-unique

Related Skills

For consuming generated hooks, see tanstack-query skill
For mocking generated API clients, see test-msw skill
For schema validation, see zod skill

Full Compiled Document

For the complete guide with all rules expanded: AGENTS.md