neon-toolkit

Neon Toolkit スキル

Neon Toolkit を使用して、一時的な Neon データベースの作成、管理、クリーンアップを自動化します。

使用する場面

• テスト実行ごとに新しいデータベースを作成する場合
• CI/CD パイプラインでデータベースを起動する場合
• 分離された開発環境を構築する場合
• 手動セットアップなしで迅速にプロトタイプを作成する場合

推奨しない用途： 本番データベース、チームで共有する環境、ローカルのみの開発（Docker を使用してください）、無料プランのアカウント（有料プロジェクトが必要です）。

コード生成ルール

TypeScript/JavaScript コードを生成する場合：

• import 文を生成する前に、tsconfig.json でパスエイリアス（compilerOptions.paths）を確認します
• パスエイリアス（例：「@/」: ["./src/"]）がある場合は使用します（例：import { x } from '@/lib/utils'）
• パスエイリアスがない場合、または判断できない場合は、必ず相対インポートを使用します（例：import { x } from '../../../lib/utils'）
• インポートがプロジェクトの設定と一致していることを確認します
• 既定では相対インポートを使用します。設定にかかわらず常に動作します

リファレンスドキュメント

主なリソース： 包括的なガイドラインについては、プロジェクトルートにある [neon-toolkit.mdc](https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-toolkit.mdc) を参照してください。以下の内容が含まれています：

• 基本概念（Organization、Project、Branch、Endpoint）
• インストールと認証のセットアップ
• データベースのライフサイクル管理パターン
• API クライアントの使用例
• エラー処理の方法

クイックセットアップ

インストール

npm install @neondatabase/toolkit

基本的な使い方

import { NeonToolkit } from '@neondatabase/toolkit';

const neon = new NeonToolkit({ apiKey: process.env.NEON_API_KEY! });

// Create ephemeral database
const db = await neon.createEphemeralDatabase();
console.log(`Database URL: ${db.url}`);

// Use the database...

// Cleanup
await db.delete();

テンプレートとスクリプト

• templates/toolkit-workflow.ts - 一時データベースを使用する一連のワークフロー
• scripts/create-ephemeral-db.ts - 一時データベースを作成します
• scripts/destroy-ephemeral-db.ts - 一時データベースをクリーンアップします

よくある使用例

テスト

const db = await neon.createEphemeralDatabase();
// Run tests with fresh database
await db.delete();

CI/CD との統合

export NEON_API_KEY=${{ secrets.NEON_API_KEY }}
npm test  # Uses ephemeral database

関連スキル

• neon-serverless - データベースへの接続用
• neon-drizzle - スキーマとマイグレーション用

---

プロジェクトにベストプラクティスを取り入れませんか？ パラメーター SKILL_NAME="neon-toolkit" を指定して neon-plugin:add-neon-docs を実行すると、リファレンスリンクを追加できます。