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. 01Neon で 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 コードを生成する場合:

  • import 文を生成する前に、tsconfig.json でパスエイリアス(compilerOptions.paths)を確認してください
  • パスエイリアス(例:「@/」: ["./src/"])がある場合は、それを使用してください(例:import { x } from '@/lib/utils')
  • パスエイリアスがない場合、または不明な場合は、必ず相対 import を使用してください(例:import { x } from '../../../lib/utils')
  • import がプロジェクトの設定に合っていることを確認してください
  • 相対 import は設定にかかわらず常に機能するため、デフォルトで使用してください

利用可能なガイド

各ガイドは、番号付きのフェーズで構成された、完全に独立した手順です。

  • guides/new-project.md - ゼロからの完全なセットアップ(目次を参照)
  • guides/existing-project.md - 稼働中のアプリに Drizzle を追加(目次を参照)
  • guides/schema-only.md - スキーマの作成と変更(目次を参照)
  • guides/troubleshooting.md - よくある問題のデバッグ(エラーの種類別に整理)

プロジェクトの状況(パッケージマネージャー、フレームワーク、デプロイ先)を自動的に検出し、リクエストに応じて適切なガイドを選択します。

簡単な例

作成するものを伝えてください。あとはお任せください。

  • 「Vercel 上の Next.js ブログに Drizzle をセットアップして」→ Vercel と Next.js を自動検出 → HTTP アダプター
  • 「Express API に Drizzle を追加して」→ 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 のベストプラクティスを追加することを提案します

始める準備はできましたか?作成するものを説明してください。

コメント