Qwerty Object-Role-Modelling (ORM) Architect

This is a vs-studio-code extension that supports rich interactions for constructing an ORM schema within the editor. The features of the editor are futher explained in the extension's readme.

At a high level, the extension allows for the construction of ORM schemas and exporting them into a svg. The following schema is constructed to very roughly capture how might a travel agency might handle their application data for a website.

The underlying file structure used to store the schema is currently written within yaml. You can check out the file structure for the above schema here.

Developing and building/packaging the extension

The following sections outline the setup for the extension if you wish to contribute or would like a standalone installer for vs-code.

Dev Environment

The .devcontainer folder contains an image for the dev environment that should be used for testing and developing. Make sure to have docker (or similar) installed and the devcontainers extension from the vs-code marketplace.

Once installed, the command Remote: [re]open in container command can be used to launch vs-code within the image. A built in development runner can be launched via vs-code by press F5. Webpack watcher will repackage the extension as changes are found. After the inital build is completed, a secondary instance of vs-code will launch with the extension available. In order to retrigger changes from a rebuild, you may need to run either of the following commands in the development instance Developer: Reload Webviews (usually enough), or Developer: Reload Window if top level extension changes have been added.

Preparing and Packaging

To prepare the extension for the marketplace or for personal installment, make sure to have the vsce or "Visual Studio Code Extensions" CLI installed.

Using vsce, the extension can be packaged via the following commands

cd extension
vsce package

Note that the version of the extension is controlled by the version attribute in package.json.

After package is completed, a new vsix file will be generated. This file can be shared for personal installs of the extension without the marketplace approval.

Publishing

Using vsce, the extension can be published via the following command:

vsce publish

Note that publishing to marketplace requires a PAT for the marketplace version of the extension to be pushed.

Following extension guidelines

Ensure that you've read through the extensions guidelines and follow the best practices for creating your extension.

• Extension Guidelines