convex-best-practices

SKILL.md

Production-ready Convex patterns for function organization, validation, query optimization, TypeScript safety, and error handling.

Covers five core areas: function organization by domain, argument and return type validation, indexed query patterns, ConvexError handling, and write conflict avoidance through idempotent mutations

Enforces code quality via @convex-dev/eslint-plugin with four rules covering function syntax, validators, table IDs, and runtime imports

Includes complete CRUD examples, internal vs. public function patterns, and TypeScript best practices using Id and Doc types

Emphasizes the "Zen of Convex" philosophy: let Convex manage caching and real-time sync, design functions as your API, and think in reactive subscriptions rather than requests

Convex Best Practices

Build production-ready Convex applications by following established patterns for function organization, query optimization, validation, TypeScript usage, and error handling.

Code Quality

All patterns in this skill comply with @convex-dev/eslint-plugin. Install it for build-time validation:

npm i @convex-dev/eslint-plugin --save-dev

// eslint.config.js
import { defineConfig } from "eslint/config";
import convexPlugin from "@convex-dev/eslint-plugin";