WebStorm 2025.2 Help

Prisma

WebStorm 集成了 Prisma ORM ，支持 Prisma Schema Language 的语法。

WebStorm 中的 Prisma ORM 支持基于 Prisma Language Server 实现。 WebStorm 附带内置的 Prisma Language Server。 建议通过下载最新的服务器版本并在 设置 | 语言与框架 | Prisma 页面中指定其路径来保持 Language Server 的最新状态，如 配置 Prisma Language Server 中所述。

开始之前

  1. 请确保您的电脑已安装 Node.js。 请按照 配置本地 Node.js 解释器、 在 Windows 子系统 Linux 上使用 Node.js 或 配置远程 Node.js 解释器 的说明在项目中配置 Node.js 解释器。

    请在 Prisma ORM 官方网站 上查看所需 Node.js 版本的详细信息。

  2. 请按 从 JetBrains Marketplace 安装插件 中所述，在 设置 | 插件 页面和标签页 Marketplace 上安装并启用 Prisma ORM 插件。

配置 Prisma Language Server

WebStorm 中的 Prisma ORM 支持基于 Prisma Language Server 实现。 WebStorm 附带内置的 Prisma Language Server。 建议保持 Language Server 为最新版本

  1. 全局安装最新版 @prisma/language-server。 为此，请打开嵌入式 终端 （Alt+F12 ），然后输入：

    npm install -g @prisma/language-server

  2. 打开 设置 对话框（Ctrl+Alt+S ），并转到 设置 | 语言与框架 Prisma。

  3. 在 Language Server 包 字段中，指定 @prisma/language-server 包的路径。

    指定 Prisma Language Server 的路径

  4. 请确保选中了 已启用 选项。

    选择 已禁用 选项以关闭 Prisma Language Server，并仅使用内部 WebStorm 的代码补全和检查功能。

代码补全

WebStorm 在 schema 文件中提供对 Prisma Schema Language 语法的 代码补全 ，并显示补全项的文档。

Prisma Schema 中的补全

  • 默认情况下，补全建议在输入时自动显示。 要禁用此行为，请按 Ctrl+Alt+S 打开设置，选择 设置 | 编辑器 | 常规 | 代码补全 ，然后取消选中 输入时显示建议 复选框。

  • 要手动触发补全，请按 Ctrl+Space。

代码检查

将鼠标悬停在出现问题的高亮代码元素上时，您可以在编辑器中直接查看 Prisma LSP 诊断信息。

LSP 验证错误

检测到的错误将显示 在 问题 工具窗口中，以及鼠标悬停时编辑器中的弹窗中。

  • 缺少必需属性

    缺少必需属性

  • 缺少 binary targets

  • 检测到缺失的 @@schema 属性，并建议了快速修复方案。

    缺少 @@schema 属性 — 检查与快速修复

文档查阅

WebStorm 显示各种特定于 Prisma 的符号的文档，包括 datasource 和 generator 块。

快速文档查阅

当您将鼠标悬停在编辑器中的符号上或按下 Ctrl+Q ，以及执行 代码补全操作时，将显示 文档 弹窗。

要在 结构 工具窗口中查看符号的文档，请选择该符号并按下 Ctrl+Q。

从结构工具窗口查看快速文档

详细了解请参阅 代码引用信息。

注释

您可以在数据模型的上方、下方和内部添加注释。 支持多行注释。

要添加注释，请开始输入 /** 并按下 Enter。 WebStorm 会在每行开头添加关闭的 */ 和 *。

将鼠标悬停在符号上，会在 文档 弹窗中显示格式良好的注释。

注释在文档弹窗中正确呈现

或者，您也可以在 渲染视图 模式下查看注释。 为此，请点击注释旁边的边栏中的 “切换渲染视图”图标 ，或按下 Ctrl+Alt+Q。

要在 文档 工具窗口中查看注释，请将鼠标悬停在符号上，在 文档 弹窗中点击 更多图标 ，然后选择 在文档工具窗口中打开。

在文档工具窗口中打开注释

结构视图

借助 WebStorm，您可以在 结构 工具窗口中查看和导航 schema 文件的结构（Alt+7）。 该工具窗口会与当前打开的 Prisma Schema 同步，因此在工具窗口中选择某个项时，schema 文件中也会自动选择该项。

特定代码块辅助功能

generator 代码块

  • WebStorm 会在 generator 块中即时提供代码补全，并为所选项提供快速文档。

    generator 代码块中的代码补全

  • WebStorm 能识别 binary targets ，并提供语法高亮、代码补全和快速文档。

  • 除了在 node_modules 文件夹中生成 Prisma Client 的 prisma-client-js generator 外，WebStorm 还识别并为输出为纯 TypeScript 代码的 prisma-client generator 提供代码补全和快速文档。

    支持 prisma-client generator

    请参阅 Prisma 官方网站了解更多信息。

datasource 代码块

WebStorm 会在 datasource 块中即时提供代码补全，并为所选项提供快速文档。

支持多个数据库 schema

  • WebStorm 能识别 schemas 键在 datasource 块中的使用，并提供高亮显示、代码补全和快速文档。

  • WebStorm 支持通过块属性引用 @@schema ，包括补全以及 显示用途 （Ctrl+F7）。

    查找／显示 schema 的使用

    专用检查功能可检测缺少的 @@schema 属性，并建议添加的快速修复方案。

    缺少 @@schema 属性 — 检查与快速修复

  • 对于已定义的 schema，可使用 重命名重构操作。

请参阅 Prisma 官方网站了解更多信息。

多文件 Prisma schema

在 WebStorm 中，您可以使用 跨多个文件拆分的 Prisma schema ，并支持代码补全、文档查看、导航、搜索等功能。

  • WebStorm 支持通过 @relation 跨同一目录、其子目录或不同目录中的文件建立连接。 新添加的关系会自动重新格式化。

  • 位于子目录中的多文件 schema 会被 npx prisma generate 识别。

  • 为 关系 和 类型 提供代码补全和快速文档。

  • 您可以使用 Alt+F7 在整个项目中 查找符号的用途。

    在拆分 schema 中查找 model 的使用

    要跳转至符号的声明处，请按 Ctrl+B。

  • 您可以查看其他 .prisma 文件中指定模型的快速文档。

    为其他 .prisma 文件中定义的 model 提供快速文档

  • 专用检查功能会检测 generator 和 datasource 块的重复项，并在 问题 工具窗口中及编辑器弹窗中以悬停方式显示错误。

    检测重复项

分片

对于 Prisma ORM 6.10 及之后版本，WebStorm 支持通过 @shardKey 和 @@shardKey 属性进行分片，便于在数据库负载增长时扩展。

如需使用分片功能，请确保将 previewFeatures = ["shardKeys"] 添加到 generator 块中。

  • 支持对 @shardKey 和 @@shardKey 的代码补全及快速文档查询。

    @shardKey 的快速文档

  • 对块属性 @@shardKey 中的字段提供补全功能。 补全列表仅包含非空标量字段

    @@shardKey 中字段的补全

  • 您可以使用 Alt+F7 查找 @@shardKey 块属性字段的用途。

    查找 @@shardKey 代码块属性中字段的使用

  • 您可以对 @@shardKey 块属性中的字段应用 重命名重构操作。

最后修改日期： 2025年 9月 26日
PrettierReact