neondatabase/ai-rules

neon-drizzle

Creates a fully functional Drizzle ORM setup with a provisioned Neon database.

소스 보기

사용 방법

  1. 설치 명령을 복사하고 자신의 에이전트 환경에 설치하기 전에 소스 패키지를 확인하세요.
  2. 필요한 도구, 인증 정보, 지원 환경은 원본 문서에서 확인하세요.
  3. 입력과 원하는 산출물을 설명하고 출처와 결과를 대조하세요.
npx skills add https://github.com/neondatabase/ai-rules --skill neon-drizzle

시작 전 확인

  • 설치에는 모델 구독, API 한도, 파일 접근 권한이 포함되지 않습니다.
  • 별점 수와 설치 수는 활동 지표이며 독립적인 품질·보안 검증이 아닙니다.
원본 Skill 문서

원본 저장소의 제목, 예시, 코드, 표, 링크, 이미지를 유지해 표시합니다.

Neon Drizzle Integration

Comprehensive Drizzle ORM setup for Neon databases with guided workflows.

When to Use This Skill

  • Setting up Drizzle in a new project (Next.js, Vite, Express, etc.)
  • Integrating Drizzle into an existing application
  • Creating or modifying database schemas
  • Troubleshooting migration issues

Code Generation Rules

When generating TypeScript/JavaScript code:

  • BEFORE generating import statements, check tsconfig.json for path aliases (compilerOptions.paths)
  • If path aliases exist (e.g., "@/": ["./src/"]), use them (e.g., import { x } from '@/lib/utils')
  • If NO path aliases exist or unsure, ALWAYS use relative imports (e.g., import { x } from '../../../lib/utils')
  • Verify imports match the project's configuration
  • Default to relative imports - they always work regardless of configuration

Available Guides

Each guide is a complete, self-contained walkthrough with numbered phases:

  • `guides/new-project.md` - Full setup from scratch (see: Table of Contents)
  • `guides/existing-project.md` - Add Drizzle to running apps (see: Table of Contents)
  • `guides/schema-only.md` - Schema creation and modification (see: Table of Contents)
  • `guides/troubleshooting.md` - Debug common issues (organized by error type)

I'll automatically detect your context (package manager, framework, deployment target) and select the appropriate guide based on your request.

Quick Examples

Tell me what you're building - I'll handle the rest:

  • "Setup Drizzle for my Next.js blog on Vercel" → Auto-detects Vercel + Next.js → HTTP adapter
  • "Add Drizzle to my Express API" → Auto-detects Node.js server → WebSocket adapter
  • "Create a users table with auth fields" → Loads schema guide → Generates schema

Reference Documentation

For deeper technical details (loaded on-demand):

  • references/adapters.md - HTTP vs WebSocket decision guide
  • references/migrations.md - Migration patterns and troubleshooting
  • references/query-patterns.md - Example queries and best practices

Templates & Scripts

  • templates/schema-example.ts - Multi-table schema with relations
  • templates/drizzle-config.ts - Configuration examples
  • scripts/generate-schema.ts - Automated migration generation
  • scripts/run-migration.ts - Programmatic migration runner

Related Skills

  • neon-auth - Add authentication
  • neon-js - Full SDK with auth + PostgREST-style data API
  • neon-serverless - Connection setup without ORM
  • neon-toolkit - Ephemeral databases for testing
  • add-neon-docs - Add Neon best practices to your project (run after setup)

Workflow

I will:

  1. Detect your project context automatically
  2. Select and load the appropriate guide
  3. Follow the guide's phases sequentially
  4. Track progress using the guide's workflow checklist
  5. Load reference files only when needed
  6. Offer to add Neon best practices to your project docs

Ready to get started? Just describe what you're building!

관련 작업