Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion packages/schema/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,31 @@ This VS Code extension provides code editing helpers for authoring ZenStack's sc

## Features

- Syntax highlighting
- 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
Expand Down