Rell Language Extension for Visual Studio Code

THIS IS AN ALPHA VERSION UNDER DEVELOPMENT

Rell is a programming language built for the relational blockchain platform Chromia. It allows to you build dapps in a way that's safe, concise and intuitive.

Features

This extension enables language features for Rell, including syntax- and semantic highlighting, and compilation warnings.

Commands

Commands are built into the Command Palette of vs code to facilitate common actions in a Chromia project.

Avaliable commands:

    Rell: New Template Project

Easiest way to start a new Chromia project. It will set up everything you need to get going.

    Rell: Run Node

Run a postchain application locally with the configured Run.xml file.
Note: This command assums that the Run.xml file is located at <projectPath>/config/Run.xml

Coloring and Styling

The extension comes with a default style schema for Rell files. If one would like to change the default style for a specific semantic token the following steps is required:

1. Open vs-code command pallet and run the command 'Developer: Inspect Editor Tokens and Scopes'
2. Click on the field you like to change
   
   This specific token is 'rell-function' with default color of '#dcdcaa'
3. To change the style of the 'rell-function' token add the following to your settings.json

"editor.semanticTokenColorCustomizations": {
    "rules": {
        "rell-function": {"foreground": "#b000b6", "fontStyle": "bold"},
  }

Run Rell Applications in VS Code

To run your postchain application locally you can use the Run Node command stated above.

Rell postchain app in Docker

To run your postchain application you can also use Docker. Follow the guide in the Readme of this repository.

Note: If you want the blockchain to re-start from blockheight 0 when you spin up the docker containers, make sure to set the WIPE_DB environment variable to true. This will also change the genesis block with the current state of your Rell modules that is set in the run.xml file.

Calling Rell-app with Postchain-client

To call a Rell app when it is running use the Postchain client: https://bitbucket.org/chromawallet/postchain-client/src/master

Contributing

Requirements

To develop on the extension currently requires Java Development Kit (JDK). To check if you have JDK installed on your machine, open a terminal and run

    java --version

Prepare IDE sources

1. Clone the repository:

   git clone git@bitbucket.org:chromawallet/rell-vscode.git

2. In the root directory of the project run

   npm install

3. Create Custom Java Runtime Environment

   To set up the JRE that is needed for the language server initiate your repo with

   npm run setup

   If you are on a windows machine you might need to add the path to your Java installation to your .bashrc file

Open IDE sources in VS code

1. Setup VS code:
   • Download
2. Open the cloned project in VS Code.
3. Hit F5 to run the extension
4. VS Code will open a new window where you can open your Rell project and get language support.

Release Notes

0.1.0

Alpha release of rell language extension for VS Code. The extension is under testing, please report bugs or write feature reqeusts here.