エディターのセットアップ
このページでは、Prisma ORM を使用する際に、最適な開発者体験を得るためにエディターをどのように設定できるかについて説明します。
ここにあなたのエディターが表示されない場合は、機能リクエストをオープンして、あなたのエディター専用のサポート(例:シンタックスハイライトや自動フォーマット)をリクエストしてください。
VS Code 拡張機能
公式のPrisma VS Code 拡張機能をインストールできます。これは、Prisma ORM を使用してアプリケーションを開発する際に、VS Code に追加機能を提供します。
schema.prisma
のシンタックスハイライト- リンティング
- 入力中にスキーマファイル内のエラーや警告を表示するために、診断ツールが使用されます。
- コード補完
- 入力中にシンボルの補完結果が表示されます。
Ctrl+Space
ショートカットで手動でトリガーできます。
- ドキュメントヘルプ
- 補完結果が提供されると、その補完結果のドキュメントがポップアップ表示されます。
- ホバー時のクイック情報
- モデルやenumのドキュメントコメント(
///
)は、それらの使用箇所にマウスを合わせると表示されます。
- モデルやenumのドキュメントコメント(
- 定義へ移動
- モデルまたはenumの宣言にジャンプしたり、内容を覗き見ることができます。
- フォーマット
- コードを手動で、または保存時に(設定されている場合)フォーマットします。
- 保存時に自動的にフォーマットするには、
settings.json
ファイルに以下を追加します。"editor.formatOnSave": true
prettier
と組み合わせてフォーマットを有効にするには、settings.json
ファイルに以下を追加します。:またはPrisma用Prettierプラグインを使用する"[prisma]": {
"editor.defaultFormatter": "Prisma.prisma"
},
- 保存時に自動的にフォーマットするには、
- コードを手動で、または保存時に(設定されている場合)フォーマットします。
- 名前の変更
- モデル、enum、フィールド、enum値の名前を変更する
- モデルまたはenumをクリックし、
F2
を押してから新しい名前を入力し、Enter
を押します - すべての使用箇所が変更されます
- スキーマに自動的に
@map
または@@map
を適用します
- モデルまたはenumをクリックし、
- モデル、enum、フィールド、enum値の名前を変更する
- クイックフィックス
- モデル名やenum名のタイプミスを素早く修正する
- ワンクリックで新しいモデルとenumを作成する
VS Code を使用している場合、VS Code エージェントモードを使用して、「Postgres データベースを作成する」や「スキーマ移行を適用する」といったプロンプトをチャットに直接入力できます。VS Code エージェントは、すべての基礎となる Prisma CLI の呼び出しや API コールを自動的に処理します。詳細については、VS Code エージェントのドキュメントを参照してください。
コミュニティプロジェクト
注意:コミュニティプロジェクトはPrismaによってメンテナンスまたは公式にサポートされておらず、一部の機能は同期していない可能性があります。自己責任でご利用ください。
Emacs
- emacs-prisma-modeは、Prismaスキーマ言語のシンタックスハイライトを提供し、Prisma言語サーバーを使用します。
Vim
- vim-prismaは、Prismaスキーマ言語のファイル検出とシンタックスハイライトを提供します。
neovim
- coc-prismaはPrisma言語サーバーを実装しています。
JetBrains IDE
- JetBrains提供のPrisma ORM。このプラグインは、PSL文法、シンタックスハイライト、LSPなどを提供します。
Sublime Text
- Prisma - Sublime Text 3 & 4用 - Prismaスキーマ言語のシンタックスハイライトを提供します。 (ソースコード)
- LSP-prisma - Sublime Text 4用 - Prismaの言語サーバーを使用して、リンティング、エラーチェック、フォーマット、オートコンプリート、名前変更などを提供するPrismaスキーマファイル用の言語サーバーヘルパーパッケージです。注意:Prismaパッケージがインストールされている必要があります。 (ソースコード)
nova
- novaは、Prismaスキーマ言語のシンタックスハイライトを提供し、Prisma言語サーバーを使用します。
Helix
- Helix(バージョン22.08以降)は、Prismaスキーマ言語のシンタックスハイライトを提供し、Prisma言語サーバーを使用します。
CLIオートコンプリート
inshellisense
inshellisense
を使用して、Prisma CLI の IDE スタイルのオートコンプリートを取得できます。対応しているシェルは次のとおりです:bash、zsh、fish、pwsh、powershell (Windows Powershell)。
インストールするには、以下を実行します
npm install -g @microsoft/inshellisense
Fig
inshellisense
はFigの上に構築されており、Figを直接使用することもできます。bash、zsh、fishで動作します。
インストールするには、以下を実行します
brew install fig