convex-best-practices

Guidelines for building production-ready Convex apps covering function organization, query patterns, validation, TypeScript usage, error handling, and the Zen of Convex design philosophy

1. Zainstaluj plugin ESLint dla Convex, aby automatycznie sprawdzać zgodność z najlepszymi praktykami: npm i @convex-dev/eslint-plugin --save-dev. Dodaj konfigurację do pliku eslint.config.js, importując convexPlugin i rozszerzając recommended config.

2. Zapoznaj się z czterema głównymi regułami wymuszanymi przez plugin: no-old-registered-function-syntax (wymaga nowej składni), require-argument-validators (każda funkcja musi mieć args: {}), explicit-table-ids (nazwa tabeli w operacjach db) i import-wrong-runtime (brak importów Node w runtime Convex).

3. Przeczytaj oficjalną dokumentację Convex Best Practices na https://docs.convex.dev/understanding/best-practices/ oraz sekcje o obsłudze błędów i konfliktach zapisu, aby zrozumieć kontekst każdej reguły.

4. Zastosuj Zen of Convex w swoim projekcie: pozwól Convexowi zarządzać cachowaniem i synchronizacją real-time, projektuj funkcje jako interfejs API aplikacji, zdefiniuj model danych w schema.ts i traktuj schemat jako źródło prawdy.

5. Podczas pisania kodu funkcji pamiętaj o walidacji argumentów, prawidłowej organizacji funkcji i obsłudze błędów zgodnie z dokumentacją. Plugin ESLint będzie Cię ostrzegać o naruszeniach na etapie budowania.

6. W razie pytań lub niejasności sprawdź llms.txt w dokumentacji Convex, który zawiera szerszy kontekst dla modeli językowych.