Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Language-Tools Documentation #4191

Closed
wants to merge 29 commits into from
Closed

Language-Tools Documentation #4191

wants to merge 29 commits into from

Conversation

Druue
Copy link
Contributor

@Druue Druue commented Dec 5, 2022

Describe this PR

There currently exists no real public documentation for Prisma's language-tools. The goal here is to remedy that.

Changes

Adding new sections on language-tools

  • Language Server functionality :: WIP
  • Extended VSCode Functionality :: WIP

What issue does this fix?

Closes #4174

@Druue Druue requested review from Jolg42 and keerlu December 5, 2022 12:15
@vercel
Copy link

vercel bot commented Dec 5, 2022

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 17, 2023 10:58am

… accurately represented. Missing ; After (enum) ; tab has been moved, and ; After (model) ; has been added

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? -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.


To ensure effective syntax highlighting, ... emit the following warning:

<!-- TODO: Picture? -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.


<!-- 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 -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.


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 ? -->
Copy link
Contributor Author

@Druue Druue Dec 14, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to have a link to the auto-formatting section in prisma-schema here?

Copy link
Contributor

This PR probably requires the following redirects to be added to vercel.json:

  • This PR does not change any pages in a way that would require a redirect.

Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 46.7%, saving 621.63 KB.

Filename Before After Improvement Visual comparison
content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/code_action-rename.png 125.97 KB 71.63 KB -43.1% View diff
content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/completion-datasource-provider-fields.png 195.96 KB 104.05 KB -46.9% View diff
content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/completion-field-attributes.png 260.95 KB 142.33 KB -45.5% View diff
content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/completion-index-configuration.png 173.03 KB 87.87 KB -49.2% View diff
content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/completion-model-attributes.png 199.11 KB 107.02 KB -46.2% View diff
content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/completion-native-db-types.png 218.24 KB 111.36 KB -49.0% View diff
content/200-concepts/100-components/09-prisma-language-tools/01-prisma-language-server/tooltip-model-comment.png 157.25 KB 84.62 KB -46.2% View diff

196 images did not require optimisation.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add docs on language tooling
5 participants