Skip to content

ever-co/ever-works / .agents/skills/vercel-react-best-practices

vercel-react-best-practices

Verified

React and Next.js performance optimization guidelines from Vercel Engineering. This skill should be used when writing, reviewing, or refactoring React/Next.js code to ensure optimal performance patterns. Triggers on tasks involving React components, Next.js pages, data fetching, bundle optimization, or performance improvements.

FileKindSize
AGENTS.mdmarkdown101.9 KB
README.mdmarkdown3.3 KB
SKILL.mdskill md7.2 KB
metadata.jsonconfig901 B
rules/_sections.mdmarkdown1.5 KB
rules/_template.mdmarkdown633 B
rules/advanced-effect-event-deps.mdmarkdown1.7 KB
rules/advanced-event-handler-refs.mdmarkdown1.4 KB
rules/advanced-init-once.mdmarkdown949 B
rules/advanced-use-latest.mdmarkdown1.0 KB
rules/async-api-routes.mdmarkdown1.1 KB
rules/async-cheap-condition-before-await.mdmarkdown1.2 KB
rules/async-defer-await.mdmarkdown2.1 KB
rules/async-dependencies.mdmarkdown1.3 KB
rules/async-parallel.mdmarkdown650 B
rules/async-suspense-boundaries.mdmarkdown2.4 KB
rules/bundle-barrel-imports.mdmarkdown2.7 KB
rules/bundle-conditional.mdmarkdown931 B
rules/bundle-defer-third-party.mdmarkdown881 B
rules/bundle-dynamic-imports.mdmarkdown790 B
rules/bundle-preload.mdmarkdown1.1 KB
rules/client-event-listeners.mdmarkdown1.9 KB
rules/client-localstorage-schema.mdmarkdown1.9 KB
rules/client-passive-event-listeners.mdmarkdown1.6 KB
rules/client-swr-dedup.mdmarkdown1.1 KB
rules/js-batch-dom-css.mdmarkdown3.1 KB
rules/js-cache-function-results.mdmarkdown1.9 KB
rules/js-cache-property-access.mdmarkdown534 B
rules/js-cache-storage.mdmarkdown1.6 KB
rules/js-combine-iterations.mdmarkdown765 B
rules/js-early-exit.mdmarkdown1.1 KB
rules/js-flatmap-filter.mdmarkdown1.4 KB
rules/js-hoist-regexp.mdmarkdown1.0 KB
rules/js-index-maps.mdmarkdown835 B
rules/js-length-check-first.mdmarkdown1.7 KB
rules/js-min-max-loop.mdmarkdown2.2 KB
rules/js-request-idle-callback.mdmarkdown2.6 KB
rules/js-set-map-lookups.mdmarkdown532 B
rules/js-tosorted-immutable.mdmarkdown1.7 KB
rules/rendering-activity.mdmarkdown557 B
rules/rendering-animate-svg-wrapper.mdmarkdown1.1 KB
rules/rendering-conditional-render.mdmarkdown936 B
rules/rendering-content-visibility.mdmarkdown786 B
rules/rendering-hoist-jsx.mdmarkdown990 B
rules/rendering-hydration-no-flicker.mdmarkdown2.2 KB
rules/rendering-hydration-suppress-warning.mdmarkdown850 B
rules/rendering-resource-hints.mdmarkdown2.6 KB
rules/rendering-script-defer-async.mdmarkdown1.8 KB
rules/rendering-svg-precision.mdmarkdown588 B
rules/rendering-usetransition-loading.mdmarkdown2.0 KB
rules/rerender-defer-reads.mdmarkdown966 B
rules/rerender-dependencies.mdmarkdown823 B
rules/rerender-derived-state-no-effect.mdmarkdown1.2 KB
rules/rerender-derived-state.mdmarkdown727 B
rules/rerender-functional-setstate.mdmarkdown2.9 KB
rules/rerender-lazy-state-init.mdmarkdown1.9 KB
rules/rerender-memo-with-default-value.mdmarkdown1.1 KB
rules/rerender-memo.mdmarkdown1.1 KB
rules/rerender-move-effect-to-event.mdmarkdown1.2 KB
rules/rerender-no-inline-components.mdmarkdown2.0 KB
rules/rerender-simple-expression-in-memo.mdmarkdown1014 B
rules/rerender-split-combined-hooks.mdmarkdown1.8 KB
rules/rerender-transitions.mdmarkdown1.0 KB
rules/rerender-use-deferred-value.mdmarkdown1.8 KB
rules/rerender-use-ref-transient-values.mdmarkdown1.6 KB
rules/server-after-nonblocking.mdmarkdown1.9 KB
rules/server-auth-actions.mdmarkdown2.5 KB
rules/server-cache-lru.mdmarkdown1.3 KB
rules/server-cache-react.mdmarkdown2.2 KB
rules/server-dedup-props.mdmarkdown2.0 KB
rules/server-hoist-static-io.mdmarkdown4.3 KB
rules/server-no-shared-module-state.mdmarkdown1.7 KB
rules/server-parallel-fetching.mdmarkdown1.5 KB
rules/server-parallel-nested-fetching.mdmarkdown991 B
rules/server-serialization.mdmarkdown1000 B
# React Best Practices

A structured repository for creating and maintaining React Best Practices optimized for agents and LLMs.

## Structure

- `rules/` - Individual rule files (one per rule)
    - `_sections.md` - Section metadata (titles, impacts, descriptions)
    - `_template.md` - Template for creating new rules
    - `area-description.md` - Individual rule files
- `src/` - Build scripts and utilities
- `metadata.json` - Document metadata (version, organization, abstract)
- **`AGENTS.md`** - Compiled output (generated)
- **`test-cases.json`** - Test cases for LLM evaluation (generated)

## Getting Started

1. Install dependencies:

    ```bash
    pnpm install
    ```

2. Build AGENTS.md from rules:

    ```bash
    pnpm build
    ```

3. Validate rule files:

    ```bash
    pnpm validate
    ```

4. Extract test cases:
    ```bash
    pnpm extract-tests
    ```

## Creating a New Rule

1. Copy `rules/_template.md` to `rules/area-description.md`
2. Choose the appropriate area prefix:
    - `async-` for Eliminating Waterfalls (Section 1)
    - `bundle-` for Bundle Size Optimization (Section 2)
    - `server-` for Server-Side Performance (Section 3)
    - `client-` for Client-Side Data Fetching (Section 4)
    - `rerender-` for Re-render Optimization (Section 5)
    - `rendering-` for Rendering Performance (Section 6)
    - `js-` for JavaScript Performance (Section 7)
    - `advanced-` for Advanced Patterns (Section 8)
3. Fill in the frontmatter and content
4. Ensure you have clear examples with explanations
5. Run `pnpm build` to regenerate AGENTS.md and test-cases.json

## Rule File Structure

Each rule file should follow this structure:

````markdown
---
title: Rule Title Here
impact: MEDIUM
impactDescription: Optional description
tags: tag1, tag2, tag3
---

## Rule Title Here

Brief explanation of the rule and why it matters.

**Incorrect (description of what's wrong):**

```typescript
// Bad code example
```
````

**Correct (description of what's right):**

```typescript
// Good code example
```

Optional explanatory text after examples.

Reference: [Link](https://example.com)

## File Naming Convention

- Files starting with `_` are special (excluded from build)
- Rule files: `area-description.md` (e.g., `async-parallel.md`)
- Section is automatically inferred from filename prefix
- Rules are sorted alphabetically by title within each section
- IDs (e.g., 1.1, 1.2) are auto-generated during build

## Impact Levels

- `CRITICAL` - Highest priority, major performance gains
- `HIGH` - Significant performance improvements
- `MEDIUM-HIGH` - Moderate-high gains
- `MEDIUM` - Moderate performance improvements
- `LOW-MEDIUM` - Low-medium gains
- `LOW` - Incremental improvements

## Scripts

- `pnpm build` - Compile rules into AGENTS.md
- `pnpm validate` - Validate all rule files
- `pnpm extract-tests` - Extract test cases for LLM evaluation
- `pnpm dev` - Build and validate

## Contributing

When adding or modifying rules:

1. Use the correct filename prefix for your section
2. Follow the `_template.md` structure
3. Include clear bad/good examples with explanations
4. Add appropriate tags
5. Run `pnpm build` to regenerate AGENTS.md and test-cases.json
6. Rules are automatically sorted by title - no need to manage numbers!

## Acknowledgments

Originally created by [@shuding](https://x.com/shuding) at [Vercel](https://vercel.com).
brainstormingobra/superpowersYou MUST use this before any creative work - creating features, building components, adding functionality, modifying behavior, or planning anything new, in software or out of it (a talk, a business, a renovation).Stars: 322kUpdated Claude CodeCodexVerifiedInstall
brand-guidelinesanthropics/skillsApplies Anthropic's official brand colors and typography to any sort of artifact that may benefit from having Anthropic's look-and-feel. Use it when brand colors or style guidelines, visual formatting, or company design standards apply.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
frontend-designanthropics/skillsGuidance for distinctive, intentional visual design when building new UI or reshaping an existing one. Helps with aesthetic direction, typography, and making choices that don't read as templated defaults.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
mcp-builderanthropics/skillsGuide for creating high-quality MCP (Model Context Protocol) servers that enable LLMs to interact with external services through well-designed tools. Use when building MCP servers to integrate external APIs or services, whether in Python (FastMCP) or Node/TypeScript (MCP SDK).Stars: 198kUpdated Claude CodeCodexVerifiedInstall