编辑器设置
本页面介绍了如何配置您的编辑器,以便在使用 Prisma ORM 时获得最佳开发体验。
如果此处未列出您的编辑器,请打开功能请求,并要求为您的编辑器提供专门支持(例如,语法高亮和自动格式化)。
VS Code 扩展
您可以安装官方的Prisma VS Code 扩展。它在使用 Prisma ORM 开发应用程序时为 VS Code 添加了额外的功能。
schema.prisma的语法高亮- 代码检查
- 诊断工具用于在您键入时显示 schema 文件中的错误和警告。
- 代码补全
- 在您键入时出现符号的补全结果。
- 您可以通过
Ctrl+Space快捷键手动触发此功能。
- 文档帮助
- 在提供补全结果时弹出补全结果的文档。
- 悬停快速信息
- 当您将鼠标悬停在模型和枚举的用法上时,会显示其文档注释 (
///)。
- 当您将鼠标悬停在模型和枚举的用法上时,会显示其文档注释 (
- 转到定义
- 跳转或查看模型或枚举的声明。
- 格式化
- 手动或在保存时格式化代码(如果已配置)。
- 要在保存时自动格式化,请将以下内容添加到您的
settings.json文件中"editor.formatOnSave": true - 要结合
prettier启用格式化,请将以下内容添加到您的settings.json文件中:或使用Prisma 的 Prettier 插件"[prisma]": {
"editor.defaultFormatter": "Prisma.prisma"
},
- 要在保存时自动格式化,请将以下内容添加到您的
- 手动或在保存时格式化代码(如果已配置)。
- 重命名
- 重命名模型、枚举、字段和枚举值
- 点击模型或枚举,按
F2,然后键入所需的新名称并按Enter。 - 所有用法都将被重命名。
- 自动在 schema 上应用
@map或@@map。
- 点击模型或枚举,按
- 重命名模型、枚举、字段和枚举值
- 快速修复
- 快速修复模型和枚举名称中的拼写错误。
- 一键创建新模型和枚举。
提示
如果您正在使用 VS Code,您可以使用VS Code 代理模式直接在聊天中输入“创建 Postgres 数据库”或“应用 schema 迁移”等提示。VS Code 代理会自动处理所有底层的 Prisma CLI 调用和 API 调用。有关更多详细信息,请参阅我们的VS Code 代理文档。
社区项目
注意:社区项目不由 Prisma 维护或官方支持,某些功能可能不同步。请自行决定使用。
Emacs
- emacs-prisma-mode提供 Prisma Schema Language 的语法高亮并使用 Prisma Language Server。
Vim
- vim-prisma提供 Prisma Schema Language 的文件检测和语法高亮。
neovim
- coc-prisma实现了 Prisma Language Server。
JetBrains IDE
- Prisma ORM由 JetBrains 提供。此插件提供 PSL 语法、语法高亮、LSP 等。
Sublime Text
- Prisma - 适用于 Sublime Text 3 & 4 - 为 Prisma Schema Language 提供语法高亮。(源代码)
- LSP-prisma - 适用于 Sublime Text 4 - Prisma schema 文件的语言服务器辅助包,使用 Prisma 的语言服务器提供代码检查、错误检查、格式化、自动补全、重命名等功能。注意:它需要安装 Prisma 包。(源代码)
nova
- nova提供 Prisma Schema Language 的语法高亮并使用 Prisma Language Server。
Helix
- Helix(从 22.08 版本开始)提供 Prisma Schema Language 的语法高亮并使用 Prisma Language Server。
CLI 自动补全
inshellisense
您可以使用inshellisense获得 Prisma CLI 的 IDE 风格自动补全。它支持:bash、zsh、fish、pwsh、powershell (Windows Powershell)。
要安装,运行
npm install -g @microsoft/inshellisense
Fig
inshellisense基于Fig构建,您也可以直接使用它。它适用于 bash、zsh 和 fish。
要安装,运行
brew install fig