Editor setup

Source URL: https://docs.prisma.io/docs/orm/more/dev-environment/editor-setup

Editor setup

Learn how to configure your editor and IDEs for an optimal developer experience with Prisma ORM

This page describes how you can configure your editor for an optimal developer experience when using Prisma ORM.

If you don’t see your editor here, please open a feature request” and ask for dedicated support for your editor (e.g. for syntax highlighting and auto-formatting).

VS Code extension

You can install the official Prisma VS Code extension. It adds extra capabilities to VS Code when developing applications with Prisma ORM:

• Syntax highlighting of schema.prisma
• Linting
  • Diagnostic tools are used to surface errors and warnings in your schema file as you type.
• Code Completion
  • Completion results appear for symbols as you type.
  • You can trigger this manually with the Ctrl+Space shortcut.
• Documentation help
  • Documentation of a completion result pops up as completion results are provided.
• Quick info on hover
  • Documentation Comments (///) of models and enums appear anywhere you hover over their usages.
• Go to Definition
  • Jump to or peek a model or enum’s declaration.
• Formatting
  • Format code either manually or on save (if configured).
    • To automatically format on save, add the following to your settings.json file:

"editor.formatOnSave": true

  * To enable formatting in combination with `prettier`, add the following to your `settings.json` file

use the Prettier plugin for Prisma

"[prisma]": {
              "editor.defaultFormatter": "Prisma.prisma"
            },

• Rename
  • Rename models, enums, fields and enum values
    • Click into the model or enum, press F2 and then type the new desired name and press Enter
    • All usages will be renamed
    • Automatically applies @map or @@map on the schema
• Quick-fixes
  • Quickly fix typos in model and enum names
  • Create new models and enums with a single click

If you’re using VS Code, you can use VS Code agent mode to enter prompts such as “create Postgres database” or “apply schema migration” directly in the chat. The VS code agent handles all underlying Prisma CLI invocations and API calls automatically. See our VS Code Agent documentation for more details.

Community projects

Note : Community projects are not maintained or officially supported by Prisma and some features may by out of sync. Use at your own discretion.

• Emacs

  • emacs-prisma-mode provides syntax highlighting of the Prisma Schema Language and uses the Prisma Language Server.

• Vim

  • vim-prisma provides file detection and syntax highlighting of the Prisma Schema Language.

• neovim

  • coc-prisma implements the Prisma Language Server.

• JetBrains IDE

  • Prisma ORM Provided by JetBrains. This plugin provides PSL grammar, syntax highlighting, LSP, and more.

• Sublime Text

  • Prisma - For Sublime Text 3 & 4 - Provides syntax highlighting for the Prisma Schema Language. (Source Code)
  • LSP-prisma - For Sublime Text 4 - Language Server helper package for Prisma schema files that uses Prisma’s Language Server to provide linting, error checking, formatting, autocompletion, renaming etc. Note: It requires the Prisma package to be installed. (Source Code)

• nova

  • nova provides syntax highlighting of the Prisma Schema Language and uses the Prisma Language Server.

• Helix

  • Helix (from version 22.08) provides syntax highlighting of the Prisma Schema Language and uses the Prisma Language Server.

• CLI autocomplete

• inshellisense

You can get IDE-style autocompletion for Prisma CLI using inshellisense. It supports: bash, zsh, fish, pwsh, powershell (Windows Powershell).

To install, run:

npm

pnpm

yarn

bun

    npm install -g @microsoft/inshellisense