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.

Sign up for GitHub

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

doc: add the formatting instruction for VSCode extension #1469

Merged
merged 2 commits into from
May 30, 2024
+24 −1
Merged

doc: add the formatting instruction for VSCode extension #1469

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6fcfb9f
doc: add the formatting instruction for VSCode extension
jiashengguo May 27, 2024
0410668
remove unnecessary code
jiashengguo May 27, 2024
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
View file
Open in desktop
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"
},
```
jiashengguo marked this conversation as resolved.
Show resolved Hide resolved

- Inline error reporting
- Go-to definition
- Hover documentation
Expand Down
Loading