Engine DevTools extension provides integration with the Nginstack platform, enabling Visual Studio Code as an alternative to Engine IDE for editing code stored in an Nginstack database.
This extension is still in an experimental phase. We do not recommend its use in production.
This page is just an overview. A more detailed documentation (in portuguese) is available here.
Version numbers for this extension are incremented according to the Nginstack platform versions. This way, for example, 29.x will be the extension's compatible version for Nginstack 29.x.
Detailed release notes are available here.
Setting up a database connection
In order to access the desired database, you need to add it to your settings:
The extension has a view named "connections". This view shows all databases added to your settings, as well as their status.
At the right of the database name, when selecting or hovering the cursor over it, there appears four icons, a pencil, a house, an X, an on/off symbol. These are buttons for editing, marking as "main", removing and toggling a database connection, respectively.
The status are represented by colored indicators at your database name's left. Green when connected, orange when attempting to connect, grey when turned off and red when an error occur. By hovering your cursor over the database name, a tooltip detailing the connection status is shown.
Editing/Removing a database configuration
To remove a database configuration, click on the X button, as explained in the previous section. To edit the configuration, click on the pencil button and proceed the same way as if you were adding a database (with the exception that input boxes will come filled in with current settings).
It is recommended to use the extension's buttons to remove or edit a database configuration, rather
than doing it directly through VS Code
Toggling a database connection
You can opt to add or remove a VFS File tree from workspace without removing your database settings. Do this by clicking on the on/off button.
Status indicators of databases that are turned off will become grey, and the extension will disconnect from that database.
Marking a database as main
There are a series of functionalities performed by the extension that need to retrieve information from a database (e.g. VFS file keys functioning as document links). In order to have some of those functionalities working with files outside the VFS, like local files, the extension uses the database connection marked as main.
Opening and editing the Virtual File System
Once you connect to a database, the extension creates an in-memory file system that is a representation of the VFS, opened as another project folder in your File Explorer.
Creating files and directories
Since files and directories in the VFS are linked to the concept of products that can be licensed and permissions regarding those products, creating new files is not as straightforward as if they were local.
When you create a new file, a list of changeable products will appear on the screen, from which you will be able to select the product that file will belong to.
Engine DevTools extension utilizes its own language server to provide functionalities such as hovers, document links, completion proposal. It also uses eslint to provide source code diagnostics.