colinhacks/reylo

选用指南

AI 根据 README 整理 · 2026/10/22 19:36:47

使用方式

通过 npm 安装，在 tsconfig.json 中配置 contentMappers，并使用 --runExternalCode 进行类型检查。运行时需要加载 reylo/register 或使用相应插件。

查看 README 依据

- ⚡ **No codegen** — the type checker asks Reylo directly: no generated files, no watcher. ## Setup To install Reylo, you'll need: - **TypeScript 7.1 (currently in beta).** The first release with content mappers. - **Node 24 or later.** - **A running dev database.** Postgres, MySQL 8.0.22 or later, or a SQLite file: Reylo reads your current schema from it. On Postgres and SQLite, [a schema file](https://reylo.dev/#schema-files) will do instead. Install Reylo, the engine for your database and TypeScript 7.1: ```sh npm install reylo npm install -D @reylosql/postgres # or mysql, sqlite

npm install -D typescript@beta ``` Add Reylo to `tsconfig.json`: ```jsonc // tsconfig.json { "compilerOptions": { /* ... */ }, "contentMappers": [ { "package": "reylo", "extensions": [".sql"] } ] } ``` Then type-check with `--runExternalCode`, which lets `tsc` run content mappers: ```jsonc // package.json { "scripts": { "typecheck": "tsc --noEmit --runExternalCode" } } ``` Point Reylo at your dev database with `DATABASE_URL`, in your environment or in `.env`: ```sh # .env DATABASE_URL=postgres://localhost:5432/app # or mysql://…, or file:./app.db for SQLite ```

To make `.sql` imports work at run time too, load Reylo where your code runs. On Node: ```sh node --env-file=.env --import reylo/register main.ts ``` For Bun, Nub, Vite, Next.js, esbuild, webpack, Rspack, Cloudflare Workers and Jest, add [the plugin for your setup](https://reylo.dev/#plugins), or copy its complete [example project](https://github.com/colinhacks/reylo/tree/main/examples). To see the types as you type, set up [your editor](https://reylo.dev/#editors). ## Usage Write a query in a `.sql` file, import it, and run it with your database driver: ```sql -- get_user.sql

部署要求

需要 TypeScript 7.1（目前处于 beta 版）、Node 24 或更高版本，以及一个运行中的开发数据库（Postgres、MySQL 8.0.22+ 或 SQLite 文件）。

查看 README 依据

- ⚡ **No codegen** — the type checker asks Reylo directly: no generated files, no watcher. ## Setup To install Reylo, you'll need: - **TypeScript 7.1 (currently in beta).** The first release with content mappers. - **Node 24 or later.** - **A running dev database.** Postgres, MySQL 8.0.22 or later, or a SQLite file: Reylo reads your current schema from it. On Postgres and SQLite, [a schema file](https://reylo.dev/#schema-files) will do instead. Install Reylo, the engine for your database and TypeScript 7.1: ```sh npm install reylo npm install -D @reylosql/postgres # or mysql, sqlite

已知限制

Reylo 需要 TypeScript 7.1（目前处于 beta 版）和 Node 24 或更高版本。

查看 README 依据

- ⚡ **No codegen** — the type checker asks Reylo directly: no generated files, no watcher. ## Setup To install Reylo, you'll need: - **TypeScript 7.1 (currently in beta).** The first release with content mappers. - **Node 24 or later.** - **A running dev database.** Postgres, MySQL 8.0.22 or later, or a SQLite file: Reylo reads your current schema from it. On Postgres and SQLite, [a schema file](https://reylo.dev/#schema-files) will do instead. Install Reylo, the engine for your database and TypeScript 7.1: ```sh npm install reylo npm install -D @reylosql/postgres # or mysql, sqlite