diff --git a/README.md b/README.md index 42d45f93..6e6ea9a4 100644 --- a/README.md +++ b/README.md @@ -400,3 +400,4 @@ See [Prisma Migrate](https://www.prisma.io/docs/orm/prisma-migrate) documentatio 1. Prisma client extensions are not supported. 1. Prisma custom generators are not supported (may add support in the future). 1. [Filtering on JSON fields](https://www.prisma.io/docs/orm/prisma-client/special-fields-and-types/working-with-json-fields#filter-on-a-json-field-advanced) is not supported yet. +1. Raw SQL query APIs (`$queryRaw`, `$executeRaw`) are not supported. diff --git a/packages/ide/vscode/README.md b/packages/ide/vscode/README.md new file mode 100644 index 00000000..cfb38c25 --- /dev/null +++ b/packages/ide/vscode/README.md @@ -0,0 +1,53 @@ +# ZenStack VS Code Extension + +[ZenStack](https://zenstack.dev) is a toolkit that simplifies the development of a web app's backend. It enhances [Prisma ORM](https://prisma.io) with flexible Authorization and auto-generated, type-safe APIs/hooks, simplifying full-stack development. + +This VS Code extension provides code editing helpers for authoring ZenStack's schema files (.zmodel files). + +## Features + +- Syntax highlighting of `*.zmodel` files + + - In case the schema file is not recognized automatically, add the following to your settings.json file: + + ```json + "files.associations": { + "*.zmodel": "zmodel" + }, + ``` + +- Auto formatting + + - To automatically format on save, add the following to your settings.json file: + + ```json + "editor.formatOnSave": true + ``` + + - To enable formatting in combination with prettier, add the following to your settings.json file: + ```json + "[zmodel]": { + "editor.defaultFormatter": "zenstack.zenstack" + }, + ``` + +- Inline error reporting +- Go-to definition +- Hover documentation +- Code section folding + +## Links + +- [Home](https://zenstack.dev) +- [Documentation](https://zenstack.dev/docs) +- [Community chat](https://discord.gg/Ykhr738dUe) +- [Twitter](https://twitter.com/zenstackhq) +- [Blog](https://dev.to/zenstack) + +## Community + +Join our [discord server](https://discord.gg/Ykhr738dUe) for chat and updates! + +## License + +[MIT](https://github.com/zenstackhq/zenstack/blob/main/LICENSE) diff --git a/packages/ide/vscode/package.json b/packages/ide/vscode/package.json index b6c17200..22bc1dc6 100644 --- a/packages/ide/vscode/package.json +++ b/packages/ide/vscode/package.json @@ -1,13 +1,13 @@ { "name": "zenstack", "publisher": "zenstack", - "version": "3.0.0", + "version": "3.0.2", "displayName": "ZenStack Language Tools", "description": "VSCode extension for ZenStack ZModel language", "private": true, "repository": { "type": "git", - "url": "https://github.com/zenstackhq/zenstack-v3" + "url": "https://github.com/zenstackhq/zenstack" }, "scripts": { "build": "tsc --noEmit && tsup",