Skip to content

Commit 30d1141

Browse files
authored
chore: vscode readme (#32)
1 parent 0badf91 commit 30d1141

File tree

3 files changed

+56
-2
lines changed

3 files changed

+56
-2
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,3 +400,4 @@ See [Prisma Migrate](https://www.prisma.io/docs/orm/prisma-migrate) documentatio
400400
1. Prisma client extensions are not supported.
401401
1. Prisma custom generators are not supported (may add support in the future).
402402
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.
403+
1. Raw SQL query APIs (`$queryRaw`, `$executeRaw`) are not supported.

packages/ide/vscode/README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# ZenStack VS Code Extension
2+
3+
[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.
4+
5+
This VS Code extension provides code editing helpers for authoring ZenStack's schema files (.zmodel files).
6+
7+
## Features
8+
9+
- Syntax highlighting of `*.zmodel` files
10+
11+
- In case the schema file is not recognized automatically, add the following to your settings.json file:
12+
13+
```json
14+
"files.associations": {
15+
"*.zmodel": "zmodel"
16+
},
17+
```
18+
19+
- Auto formatting
20+
21+
- To automatically format on save, add the following to your settings.json file:
22+
23+
```json
24+
"editor.formatOnSave": true
25+
```
26+
27+
- To enable formatting in combination with prettier, add the following to your settings.json file:
28+
```json
29+
"[zmodel]": {
30+
"editor.defaultFormatter": "zenstack.zenstack"
31+
},
32+
```
33+
34+
- Inline error reporting
35+
- Go-to definition
36+
- Hover documentation
37+
- Code section folding
38+
39+
## Links
40+
41+
- [Home](https://zenstack.dev)
42+
- [Documentation](https://zenstack.dev/docs)
43+
- [Community chat](https://discord.gg/Ykhr738dUe)
44+
- [Twitter](https://twitter.com/zenstackhq)
45+
- [Blog](https://dev.to/zenstack)
46+
47+
## Community
48+
49+
Join our [discord server](https://discord.gg/Ykhr738dUe) for chat and updates!
50+
51+
## License
52+
53+
[MIT](https://github.com/zenstackhq/zenstack/blob/main/LICENSE)

packages/ide/vscode/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
{
22
"name": "zenstack",
33
"publisher": "zenstack",
4-
"version": "3.0.0",
4+
"version": "3.0.2",
55
"displayName": "ZenStack Language Tools",
66
"description": "VSCode extension for ZenStack ZModel language",
77
"private": true,
88
"repository": {
99
"type": "git",
10-
"url": "https://github.com/zenstackhq/zenstack-v3"
10+
"url": "https://github.com/zenstackhq/zenstack"
1111
},
1212
"scripts": {
1313
"build": "tsc --noEmit && tsup",

0 commit comments

Comments
 (0)