Language-Tools Documentation

config.ts

@@ -146,6 +146,11 @@ const siteConfig = {
             url: 'concepts/components/preview-features',
             codeBlock: false,
           },
+          {
+            text: 'Prisma Language Tools',
+            url: 'concepts/components/prisma-language-tools',
+            codeBlock: false,
+          },
         ],
       },
       {

content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/02-code-actions.mdx

@@ -0,0 +1,266 @@
+---
+title: 'Code Actions'
+metaTitle: 'Code Actions'
+metaDescription: 'Code Actions ...'
+tocDepth: 2
+---
+
+<TopBlock>
+
+The Prisma Language Server provides the following options to restructure code and fix issues:
+
+- [Quick Fixes](#quick-fixes) represent code changes that fix issues that the Prisma Language Server identifies in your code.
+- [Refactorings](#refactorings) represent ways to restructure your code.
+
+</TopBlock>
+
+## Quick Fixes
+
+This section lists the Quick Fixes provided by the Prisma Language Server.
+
+Quick fixes have the following key bindings in different code editors:
+
+| Editor  | Key binding     |
+| ------- | --------------- |
+| VS Code | `Cmd / Win + .` |
+
+### Add Index for Relation Fields
+
+![applying a quick-fix for relationMode to add index](code_action-relation_mode-index.gif)
+
+### Add a missing <inlineCode>@unique</inlineCode> attribute to a relation
+
+These Quick Fixes add missing `@unique` attributes to either the referencing or the referenced side of a relation. The following examples add missing `@unique` attributes to a `Profile` model that references a `Post` model.
+
+#### Add a missing <inlineCode>@unique</inlineCode> attribute to a referencing field
+
+This example adds a missing `@unique` attribute to the `userId` relation scalar field in the referencing `Profile` model:
+
+<TabbedContent tabs={[<FileWithIcon text="Before" icon="file"/>, <FileWithIcon text="After" icon="file"/>]}>
+<tab>
+
+```prisma
+datasource db {
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
+}
+
+model Profile {
+  id     Int    @id
+  userId String
+  user   User   @relation(fields: [userId], references: [email])
+  // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  // Quick Fix: Make referencing field(s) unique
+}
+
+model User {
+  id      Int      @id
+  email   String   @unique
+  profile Profile?
+}
+```
+
+</tab>
+<tab>
+
+```prisma
+datasource db {
+  provider = "postgresql"
+  url      = env("DATABASE_URL")
+}
+
+model Profile {
+  id     Int    @id
+  userId String @unique // @unique attribute added
+  user   User   @relation(fields: [userId], references: [email])
+}
+
+model User {
+  id      Int      @id
+  email   String   @unique
+  profile Profile?
+}
+```
+
+</tab>
+</TabbedContent>
+
+#### Add a missing <inlineCode>@unique</inlineCode> attribute to a referenced field
+
+This example adds a `@unique` attribute to the `email` field in the referenced `Post` model:
+
+<TabbedContent tabs={[<FileWithIcon text="Before" icon="file"/>, <FileWithIcon text="After" icon="file"/>]}>
+<tab>
+
+```prisma
+model Profile {
+  id     Int    @id
+  userId String @unique
+  user   User   @relation(fields: [userId], references: [email])
+  // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+  // Quick Fix: Make referenced field(s) unique
+}
+
+model User {
+  id      Int      @id
+  email   String
+  profile Profile?
+}
+```
+
+</tab>
+<tab>
+
+```prisma
+model Profile {
+  id     Int    @id
+  userId String @unique
+  user   User   @relation(fields: [userId], references: [email])
+}
+
+model User {
+  id      Int      @id
+  email   String   @unique // @unique attribute added
+  profile Profile?
+}
+```
+
+</tab>
+</TabbedContent>
+
+### Fix the spelling of a field
+
+This Quick Fix updates incorrectly spelled relation types. In the following example, the `User` model has a `posts` field with an incorrectly named `Poste[]` relation type. The Quick Fix corrects the name to `Post[]`:
+
+<TabbedContent tabs={[<FileWithIcon text="Before" icon="file"/>, <FileWithIcon text="After" icon="file"/>]}>
+<tab>
+
+```prisma
+model User {
+  id    Int     @id
+  posts Poste[]
+  //    ^^^^^
+  // Quick Fix: Change spelling to 'Post'
+}
+
+model Post {
+  id     Int   @id
+  User   User? @relation(fields: [userId], references: [id])
+  userId Int?
+}
+```
+
+</tab>
+<tab>
+
+```prisma
+model User {
+  id    Int    @id
+  posts Post[] // Spelling corrected
+}
+
+model Post {
+  id     Int   @id
+  User   User? @relation(fields: [userId], references: [id])
+  userId Int?
+}
+```
+
+</tab>
+</TabbedContent>
+
+### Create a new model or enum
+
+This Quick Fix suggests that you add a new model or enum if you add a relation field to your model with a relation type that you have not yet defined. In the following example, the `User` model has a `posts` relation field, but no `Post` model or enum currently exists:
+
+<TabbedContent tabs={[
+    <FileWithIcon text="Before" icon="file"/>,
+    <FileWithIcon text="After (model)" icon="file"/>,
+    <FileWithIcon text="After (enum)" icon="file"/>,
+    ]}>
+<tab>
+
+```prisma
+model User {
+  id    Int    @id
+  posts Post[]
+  //    ^^^^
+  // Quick Fix: Create new model/enum 'Post'
+}
+```
+
+</tab>
+<tab>
+
+```prisma
+model User {
+  id    Int    @id
+  posts Post[]
+}
+
+// New model added
+model Post {
+
+}
+```
+
+</tab>
+<tab>
+
+```prisma
+model User {
+  id Int @id
+  posts Post|[]
+}
+
+// New enum added
+enum Post {
+
+}
+```
+
+</tab>
+</TabbedContent>
+
+### Rename the <inlinecode>experimentalFeatures</inlinecode> field
+
+This Quick Fix renames the legacy `experimentalFeatures` field in the `generator` block to `previewFeatures`:
+
+<TabbedContent tabs={[<FileWithIcon text="Before" icon="file"/>, <FileWithIcon text="After" icon="file"/>]}>
+<tab>
+
+```prisma
+generator client {
+  provider             = "prisma-client-js"
+  experimentalFeatures = ["fullTextSearch"]
+  // ^^^^^^^^^^^^^^^^^
+  // Quick Fix: Rename property to 'previewFeatures'
+}
+```
+
+</tab>
+<tab>
+
+```prisma
+generator client {
+  provider = "prisma-client-js"
+  previewFeatures = ["fullTextSearch"] // Correct name
+}
+```
+
+</tab>
+</TabbedContent>
+
+## Refactorings
+
+This section lists the refactorings provided by the Prisma Language Server.
+
+### Rename
+
+| Editor  | Key binding |
+| ------- | ----------- |
+| VS Code | `F2`        |
+
+Renames the word currently below the cursor and any references within the same file. This currently only handles surface-level renames with a `@map()` to the original name. Therefore the client will use the new name but the underlying db will still use the old.
+
+![Gif of renaming a model in VS Code](code_action-rename.gif)

content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/03-auto-complete.mdx

@@ -0,0 +1,42 @@
+---
+title: 'Completions'
+metaTitle: 'Completions'
+metaDescription: 'Completions ...'
+tocDepth: 2
+---
+
+<TopBlock>
+
+- [Field attributes](#field-attributes): ...
+- [Native types](#native-types): ...
+- [Supported fields](#supported-fields): ...
+
+</TopBlock>
+
+## Field attributes
+
+### Example
+
+![completions-field-attributes](completion-field-attributes.png)
+
+## Native types
+
+### Example
+
+![completions-native-db-types](completion-native-db-types.png)
+
+## Supported fields
+
+| block      | field           |
+| ---------- | --------------- |
+| generator  | provider        |
+| generator  | engineType      |
+| generator  | previewFeatures |
+| ---        | ---             |
+| datasource | provider        |
+| datasource | url             |
+| datasource | relationMode    |
+
+### Example
+
+![completions-supported-fields-datasource-provider](completion-datasource-provider-fields.png)

content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/index.mdx

@@ -0,0 +1,37 @@
+---
+title: 'Prisma Language Server'
+metaTitle: 'Prisma Language Server'
+metaDescription: 'The Prisma Language Server ...'
+---
+
+<TopBlock>
+
+The Prisma Language Server implements the [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) and offers functionality in the following areas:
+
+<!-- TODO: link to https://www.prisma.io/docs/concepts/components/prisma-schema#auto-formatting ? -->
+
+- [Formatting](#formatting): ...
+- [Linting and validation](#linting):
+- [Auto-completion](/concepts/components/prisma-language-tools/prisma-language-server/auto-complete): ...
+- [Code Actions](/concepts/components/prisma-language-tools/prisma-language-server/code-actions): ...
+- [Tooltips](#tooltips): ...
+- [Go to Definition](#go-to-definition): ...
+- [Document symbols](#document-symbols): ...
+
+<!-- TODO: [**File Watcher?**](file-watcher): ... --->
+
+<!-- TODO: Do we want to link the language-tools source? -->
+
+<!-- TODO: Do we want to menton prisma-engines -- part of the language server is implemented there  -->
+
+</TopBlock>
+
+## Formatting
+
+## Linting
+
+## Tooltips
+
+## Go to Definition
+
+## Document symbols

content/200-concepts/100-components/09-prisma-language-tools/05-vs-code/index.mdx

@@ -0,0 +1,38 @@
+---
+title: 'Prisma VS Code Extension'
+metaTitle: 'Prisma VS Code Extension'
+metaDescription: 'Prisma VS Code Extension'
+---
+
+<TopBlock>
+
+- [Syntax Highlighting](#syntax-highlighting)
+- [Colour Theme Validation](#colour-theme-validation)
+- [Client File Watcher](#client-file-watcher)
+- [Insider](#insider)
+
+</TopBlock>
+
+## Syntax Highlighting
+
+<!-- TODO ... -->
+
+## Colour Theme Validation
+
+To ensure effective syntax highlighting, ... emit the following warning:
+
+<!-- TODO: Picture? -->
+
+> The VS Code Color Theme {currentTheme} you are using unfortunately does not fully support syntax highlighting. We suggest you switch to 'suggestedTheme' which does fully support it and will give you a better experience.
+
+## Client File Watcher
+
+Monitors for changes in the client types and will refresh the TypeScript language server on detected change.
+
+## Insider
+
+It is not reccomended to have both the Stable and Insider release of the Prisma VS Code extension enabled in a given workspace. On detection, we emit the following warning:
+
+<!-- TODO: Picture? -->
+
+> You have both the Insider and stable Prisma VS Code extension installed. Please uninstall or disable one of them for a better experience.