mcpField
N
neon-drizzle

neon-drizzle

github.com/neondatabase数据与数据库86983 次安装39 周前更新
代码仓库

关于 neon-drizzle

用于在 Neon 数据库中配置 Drizzle ORM 并集成到应用的引导技能。它根据项目背景选择新建或现有项目、模式操作及迁移排错指南。

主要功能

  1. 01新建与现有项目指南
  2. 02模式创建和修改指导
  3. 03迁移问题排查
  4. 04根据项目背景选择指南
  5. 05模式与迁移脚本

适用场景

  1. 01使用 Neon 启动 Drizzle 项目
  2. 02为现有应用集成 Drizzle
  3. 03创建或修改数据库模式
  4. 04排查迁移错误

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/neondatabase/ai-rules --skill neon-drizzle

安装后在 Claude Code 中输入/neon-drizzle确认已加载。

包含的文件

除 SKILL.md 外,安装时一起下载的参考资料和脚本。

guides/
existing-project.md
new-project.md
schema-only.md
troubleshooting.md
references/
adapters.md
migrations.md
query-patterns.md
scripts/
generate-schema.ts
run-migration.ts
templates/
db-http.ts
db-websocket.ts
drizzle-config.ts
schema-example.ts

详细介绍

Neon Drizzle 集成

为 Neon 数据库提供全面的 Drizzle ORM 设置,并配有引导式工作流。

何时使用此技能

  • 在新项目(Next.js、Vite、Express 等)中设置 Drizzle
  • 将 Drizzle 集成到现有应用程序中
  • 创建或修改数据库架构
  • 排查迁移问题

代码生成规则

生成 TypeScript/JavaScript 代码时:

  • 生成导入语句之前,先检查 tsconfig.json 中的路径别名(compilerOptions.paths)
  • 如果存在路径别名(例如 "@/": ["./src/"]),请使用它们(例如 import { x } from '@/lib/utils')
  • 如果不存在路径别名或不确定,始终使用相对导入(例如 import { x } from '../../../lib/utils')
  • 确认导入方式符合项目配置
  • 默认使用相对导入——无论配置如何,它们都始终有效

可用指南

每份指南都是完整且独立的分步教程,包含编号阶段:

  • guides/new-project.md - 从头开始完成全部设置(参见:目录)
  • guides/existing-project.md - 将 Drizzle 添加到正在运行的应用中(参见:目录)
  • guides/schema-only.md - 创建和修改架构(参见:目录)
  • guides/troubleshooting.md - 调试常见问题(按错误类型整理)

我会自动检测你的上下文(包管理器、框架、部署目标),并根据你的请求选择合适的指南。

快速示例

告诉我你要构建什么——其余的交给我:

  • "为我部署在 Vercel 上的 Next.js 博客设置 Drizzle" → 自动检测 Vercel + Next.js → HTTP 适配器
  • "将 Drizzle 添加到我的 Express API" → 自动检测 Node.js 服务端 → WebSocket 适配器
  • "创建一个包含身份验证字段的 users 表" → 加载架构指南 → 生成架构

参考文档

如需更深入的技术细节(按需加载):

  • references/adapters.md - HTTP 与 WebSocket 的选择指南
  • references/migrations.md - 迁移模式和故障排查
  • references/query-patterns.md - 查询示例和最佳实践

模板和脚本

  • templates/schema-example.ts - 包含关联关系的多表架构
  • templates/drizzle-config.ts - 配置示例
  • scripts/generate-schema.ts - 自动生成迁移
  • scripts/run-migration.ts - 以编程方式运行迁移

相关技能

  • neon-auth - 添加身份验证
  • neon-js - 提供身份验证和 PostgREST 风格数据 API 的完整 SDK
  • neon-serverless - 无需 ORM 的连接设置
  • neon-toolkit - 用于测试的临时数据库
  • add-neon-docs - 将 Neon 最佳实践添加到项目文档中(设置后运行)

工作流

我将:

  1. 自动检测你的项目上下文
  2. 选择并加载合适的指南
  3. 按顺序遵循指南中的各个阶段
  4. 使用指南中的工作流检查清单跟踪进度
  5. 仅在需要时加载参考文件
  6. 提议将 Neon 最佳实践添加到项目文档中

准备好开始了吗?只需描述你要构建什么!

评论

支持 Markdown