跳到正文
cccskills
免费在 GitHub 公开

prisma-next-build

Wire Prisma Next into the project's build system with the right build-tool plugin — Vite today via @prisma-next/vite-plugin-contract-emit (Vite 7 / 8); Next.js / Webpack / esbuild / Rollup / Turbopack are named as gaps rather than fabricated. Always offers the Vite plugin proactively when the project is using Vite. Use for vite plugin, vite-plugin, vite.config.ts, prismaVitePlugin, contract emit on save, HMR, hot reload contract, dev server, Next.js plugin, next plugin, withPrismaNext, webpack plugin, esbuild plugin, rollup plugin, build integration, dev server plugin, vite 7, vite 8.

中文简介正在准备中。当前显示原文说明。

查看安装方法

包含的文件(1)

  • SKILL.md9.8 KB

SKILL.md(原文)

安装前可以查看交给 AI 代理的指令内容。

Prisma Next — Build-System Integration

Edit your data contract. Prisma handles the rest.

This skill covers Prisma Next's build-tool plugins — the dev-server / build-system integrations that re-emit contract artifacts automatically as the user edits the contract source. Today that's @prisma-next/vite-plugin-contract-emit for Vite 7 and Vite 8. Next.js, Webpack, esbuild, Rollup, and Turbopack plugins are documented under What Prisma Next doesn't do yet with the workaround.

If the project is using Vite and consuming the contract, install the plugin. There's no good reason not to — manual prisma-next contract emit during dev is friction the plugin eliminates. The agent should proactively offer the plugin whenever it sees a vite.config.ts in the project; the user doesn't need to ask.

When to Use

  • The project is using Vite (the agent sees a vite.config.ts or @vitejs/* deps) and the contract is being consumed at runtime — proactively offer the plugin.
  • User asks how to wire Prisma Next into their Vite project.
  • User asks about Next.js integration, Webpack integration, or any other bundler — the answer is "not yet, here's the workaround" and the skill walks them through it.
  • User mentions: vite plugin, vite-plugin, vite.config.ts, prismaVitePlugin, contract emit on save, HMR, hot reload contract, dev server, vite 7, vite 8.
  • User mentions Next.js / Webpack / esbuild / Rollup / Turbopack in the context of Prisma Next integration — the gap-listing path fires.

When Not to Use

  • User wants to wire db.ts and middleware → prisma-next-runtime.
  • User wants to file a feature request for an unbuilt bundler plugin → prisma-next-feedback.

Key Concepts

  • The plugin's job is contract emit, on a schedule the bundler knows about. It is not a runtime concern — at runtime, the application reads contract.json / contract.d.ts the same way whether the plugin emitted them or a script did. The plugin saves you the manual command during development.
  • Vite 7 and Vite 8 only. Peer range ^7.0.0 || ^8.0.0. Vite 6 is not on the support matrix.
  • executeContractEmit is the canonical publish path. Custom plugins for other bundlers must also call it — never re-implement the load → emit → publish dance. The atomic-rename invariant (contract.d.ts renamed before contract.json) and the per-output FIFO queue live in @prisma-next/cli/control-api.
  • No build-time / production emission. The Vite plugin runs in vite dev only. For vite build / production, run prisma-next contract emit from a prebuild script.

Workflow — Vite (the supported path)

1. Install the plugin

pnpm add -D @prisma-next/vite-plugin-contract-emit

(Or npm install --save-dev, yarn add -D, bun add -d — use what the project's package manager is.)

2. Wire vite.config.ts

// vite.config.ts
import { defineConfig } from 'vite';
import { prismaVitePlugin } from '@prisma-next/vite-plugin-contract-emit';

export default defineConfig({
  plugins: [prismaVitePlugin('prisma-next.config.ts')],
});

The argument is the path to prisma-next.config.ts relative to Vite root. Not the path to schema.psl or contract.ts — the plugin reads the config to discover the contract source.

3. Configure (optional)

plugins: [
  prismaVitePlugin('prisma-next.config.ts', {
    debounceMs: 150,           // delay before re-emitting (default 150)
    logLevel: 'info',          // 'silent' | 'info' | 'debug' (default 'info')
  }),
],

Set logLevel: 'debug' only while troubleshooting; default 'info' in committed config so the dev server isn't noisy.

4. Verify the dev loop

  1. Start vite dev.
  2. Watch for the success log: [prisma-next] emitted contract.d.ts + contract.json.
  3. Edit prisma/schema.psl (e.g. add a field to a model).
  4. Within ~150ms (the debounce), watch for a re-emit log line.
  5. Type-check your application code that uses the new field — should pass without restarting the dev server.

If the plugin warns about config-only watching, see Common Pitfalls.

5. CI / production builds

The plugin does not run during vite build. For CI and production deploys, run prisma-next contract emit as a prebuild step:

// package.json
{
  "scripts": {
    "prebuild": "prisma-next contract emit",
    "build": "vite build"
  }
}

pnpm build then runs prebuild automatically before build.

Workflow — React Router v7 Framework Mode

The Vite plugin is compatible with @react-router/dev/vite. Both plugins are listed in vite.config.ts; there's no ordering constraint between them today, and the Prisma Next plugin's re-emit fires alongside React Router's own SSR re-load.

import { reactRouter } from '@react-router/dev/vite';
import { prismaVitePlugin } from '@prisma-next/vite-plugin-contract-emit';

export default defineConfig({
  plugins: [
    reactRouter(),
    prismaVitePlugin('prisma-next.config.ts'),
  ],
});

See examples/react-router-demo for the canonical configuration plus a smoke test that proves the dev loop.

Common Pitfalls

  1. Pointing the plugin at schema.psl instead of prisma-next.config.ts. The argument is the config path. The plugin reads the config to find the contract source.
  2. Vite 6 or earlier. Not supported. Upgrade Vite to 7 or 8.
  3. The plugin warns: "watching only the config; loader resolved inputs unavailable." The plugin couldn't resolve contract.source.inputs from the loader. The fallback watches only prisma-next.config.ts itself, so contract edits won't re-emit. Causes: the config file throws during loading; the contract source path resolves outside the Vite root. Fix the config error first, then check that the contract source path in the config is relative to (or inside) the Vite root.
  4. Expecting vite build to re-emit. It doesn't. Add a prebuild script.
  5. Emit errors during dev: the plugin surfaces them via Vite's error overlay. Read the overlay; the underlying cause is a contract authoring problem — chain to prisma-next-debug for resolution (PSL syntax, missing namespace, conflicting extensions).
  6. Re-installing dependencies without the plugin's peer-range move. When PN bumps the plugin's peer range, you must re-run pnpm install so the lockfile picks up the new range. A stale lockfile keeps the old plugin and produces confusing version mismatch warnings.

What Prisma Next doesn't do yet

  • Next.js plugin. No first-party @prisma-next/next-plugin-* exists. Workaround: run prisma-next contract emit from a prebuild script in package.json and run it manually during development when the contract changes. Many Next.js projects also run a dev-time tsx --watch against a small script that calls the CLI on contract-source change. If you want a first-party Next.js plugin, file a feature request via the prisma-next-feedback skill.
  • Webpack, esbuild, Rollup, Turbopack plugins. None exist yet as first-party. Workaround: the canonical executeContractEmit surface lives in @prisma-next/cli/control-api — a small per-bundler plugin can call it from the bundler's prebuild hook, but PN doesn't ship one for you. The vite-plugin-contract-emit source is the reference implementation if you want to write one yourself. If you want a first-party plugin for your bundler, file a feature request via the prisma-next-feedback skill.
  • vite build integration. The plugin runs in vite dev only. Workaround: a prebuild script that runs prisma-next contract emit. If you want the plugin to also run during vite build, file a feature request via the prisma-next-feedback skill.
  • Vite 6 or earlier. Not on the support matrix. Workaround: upgrade Vite to 7 or 8. If you have a hard reason to stay on Vite 6, file a feature request via the prisma-next-feedback skill.

Reference Files

Checklist

  • Plugin pointed at prisma-next.config.ts (not the contract source).
  • Vite version 7 or 8 (pnpm ls vite).
  • vite dev log shows the initial emit on server start.
  • Editing the contract source triggers a re-emit log line.
  • prebuild script (or equivalent) runs prisma-next contract emit for CI / production builds.
  • No vite build expectation that the plugin will run.
  • For non-Vite bundlers: surfaced the What PN doesn't do yet entry and routed the user to prisma-next-feedback if they want first-party support.
  • Did NOT confabulate a @prisma-next/next-plugin-contract-emit package or any other bundler-specific plugin that doesn't exist.

评价

还没有评价。欢迎分享你的使用感受。

评论

无需登录即可发表。欢迎分享使用感受、提问,或说明在哪些环境下无法运行。

还没有评论。来写第一条吧。

提交后会立即公开。请勿填写邮箱、电话等个人信息。URL 最多 2 个。

0 / 1000 字

此表单受 reCAPTCHA 保护,适用 Google 的隐私权政策和服务条款。

同一仓库的技能

Route a vague Prisma Next prompt to the right specific skill. Use for "help me with Prisma Next", "what is Prisma Next", "explain Prisma Next", "I'm new to PN", "where do I start", "what can I do with Prisma Next", "what can I do next with Prisma", "just ran createprisma", "tour of Prisma Next", "Prisma Next overview", and comparison questions like "Prisma Next vs Prisma 7", "PN vs Drizzle", "PN vs Kysely", "PN vs TypeORM". Do NOT use when the prompt clearly matches a workflow skill — adoption / quickstart / first-touch orientation / brownfield introspection, schema / contract editing, migration authoring (db update / migration plan / migrate), migration review on deploy / concurrent migrations, queries / db.orm / db.sql / TypedSQL, runtime / db.ts / middleware wiring, build / Vite plugin / Next.js plugin, debug / structured error envelopes / PN-* error codes, or feedback / bug report / feature request — load that sibling skill directly.

中文简介正在准备中。当前显示原文说明。

prisma/open-chat242026年7月23日 更新

Edit the Prisma Next data contract — add models, fields, relations, indexes, enums, value objects (composite types), type aliases, namespaces (Postgres schemas), cross-contract foreign keys (cross-space FK), polymorphic types (`@@discriminator` / `@@base`), use extension namespaces (`pgvector.Vector(...)`, `cipherstash.EncryptedString(...)`), wire `prisma-next.config.ts` with `defineConfig` from the `@prisma-next/<target>/config` façade, and run `prisma-next contract emit`. Use for schema, models, fields, attributes, soft delete, paranoid, scopes, validations, callbacks, prisma schema, PSL, contract.prisma, contract.ts, contract.json, contract.d.ts, façade imports, `@prisma-next/postgres/config`, `@prisma-next/postgres/contract-builder`, `@prisma-next/postgres/control`, `@prisma-next/mongo/config`, `@prisma-next/mongo/contract-builder`, `extensions:`, `extensionPacks`, pgvector, cipherstash, postgis, paradedb, supabase, `@prisma-next/extension-supabase`, `@@control`, control policy, managed, tolerated, external, observed, PN-CLI-4002, PN-CLI-4003, PN-CLI-4011.

中文简介正在准备中。当前显示原文说明。

prisma/open-chat242026年7月23日 更新

Read a Prisma Next structured error envelope and route to the right recovery — code, domain, severity, why, fix, meta. Use for error, exception, my emit failed, my query won't typecheck, my query crashed, my migration won't apply, MIGRATION.HASH_MISMATCH, BUDGET.ROWS_EXCEEDED, BUDGET.TIME_EXCEEDED, RUNTIME.ABORTED, PLAN.HASH_MISMATCH, CONTRACT.MARKER_MISSING, PN-RUN-3001, PN-RUN-3002, PN-RUN-3030, PN-MIG-2001, PN-CLI-4011, PN-SCHEMA-0001, drift, capability missing, planner conflict, prisma studio, EXPLAIN, query log, db.end, db.close, script won't exit, hangs, close connection, pool.end, client is closed.

中文简介正在准备中。当前显示原文说明。

prisma/open-chat242026年7月23日 更新

Upgrade Prisma Next in your extension. Bumps every `@prisma-next/*` dependency to the requested target (or npm `latest`), runs the per-transition upgrade instructions for the extension SPI (middleware lifecycle, codec / migration-tools / framework-components churn, seed-migration on-disk shape), verifies the pins are correctly exact via `prisma-next-check-pins`, runs the extension's own typecheck and tests, and commits each minor step on its own. Use when the user asks to "upgrade Prisma Next" in an extension package, or to update an extension's `@prisma-next/*` deps to a new minor.

中文简介正在准备中。当前显示原文说明。

prisma/open-chat242026年7月23日 更新

Hand a Prisma Next question or report off to the team — file a GitHub issue (bug or feature request), or route Q&A / design discussion / direct-team-contact to the Prisma Discord at pris.ly/discord. Use for bug, bug report, file an issue, report a bug, feature request, missing feature, this should be a feature, file this, this is a bug, this is broken, surprising behaviour, this doesn't work, file feedback, send feedback, capability gap, file via prisma-next-feedback, ask the team, talk to the team, talk to the Prisma team, talk to Prisma, Discord, Prisma Discord, Q&A, design feedback, is this the intended way, how should I do X, extension author question, extension author needs help.

中文简介正在准备中。当前显示原文说明。

prisma/open-chat242026年7月23日 更新

Review what Prisma Next migrations will run on merge or deploy, render the migration graph, resolve concurrent / diamond-convergence conflicts, and configure environment refs for CI. Use for "what migrations are going to run", "what runs on deploy", merge conflict, diamond convergence, concurrent migrations, migration status, ref management, staging, production, MIGRATION.DIVERGED, MIGRATION.NO_MARKER, MIGRATION.MARKER_NOT_IN_HISTORY, prisma migrate status, prisma migrate diff, prisma migrate resolve.

中文简介正在准备中。当前显示原文说明。

prisma/open-chat242026年7月23日 更新

查看 prisma 的全部技能

报告此技能的问题