Skip to content

Latest commit

 

History

History

README.md

ZenStack V3 VS Code Extension

ZenStack is the modern data layer for TypeScript applications. It provides a data modeling language, a type-safe ORM with built-in access control, and other utilities that help you streamline full-stack development. This VS Code extension provides code editing helpers for authoring ZenStack's schema files (.zmodel files).

Use this extension if you are using ZenStack v3.x, otherwise use the original extension that works with v2.x. See Configuration for how to use both versions side by side.

Features

  • Syntax highlighting
  • Inline error reporting
  • Go-to definition
  • Hover documentation
  • Code section folding

Configuration

Side by side with the original ZenStack extension

If you have the original ZenStack v2 extension installed, it may compete with this extension on handling .zmodel files. In this case, add the following settings to your .vscode/settings.json file to specify which extension should handle .zmodel files.

To let this extension handle .zmodel files, add:

"files.associations": {
    "*.zmodel": "zmodel-v3"
},

To let the v2 extension handle .zmodel files, add:

"files.associations": {
    "*.zmodel": "zmodel"
},

Auto formatting

To automatically format on save, add the following to your .vscode/settings.json file:

"editor.formatOnSave": true

To enable formatting in combination with prettier, add the following to your .vscode/settings.json file:

"[zmodel-v3]": {
    "editor.defaultFormatter": "zenstack.zenstack-v3"
},

Links

Community

Join our discord server for chat and updates!

License

MIT