编辑器设置
本页介绍了如何配置您的编辑器,以便在使用 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 语言服务器。
Vim
- vim-prisma 提供 Prisma Schema Language 的文件检测和语法高亮。
neovim
- coc-prisma 实现了 Prisma 语言服务器。
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 语言服务器。
Helix
- Helix (从 22.08 版本开始) 提供 Prisma Schema Language 的语法高亮,并使用 Prisma 语言服务器。
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