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, compilation warnings, and formatting.

Code Formatter

The extension comes with a built-in code formatter that ensures consistent code styling within your workspace. The formatter is designed to simplify your coding process and enhance the readability of your codebase.

Customizable Options

While the formatter's default settings are designed to be helpful right out of the box, we understand that different projects and preferences may require specific adjustments. Therefore, we provides you with the flexibility to customize certain formatting options.

The following parameters can be configured to suit your needs:

1. max_line_width: A number that defines the maximum character count for each line. This helps you maintain a clean and readable code layout.
2. insert_spaces: A boolean value that determines whether to use spaces for indentation instead of tabs. Set this to true for spaces or false for tabs.
3. tab_size: A number that defines the number of spaces to be used for each level of indentation.

We aim to increase the level of customization of the formatter. If you have any request for a change of the default style or would like a new parameter for the customization please open a issue in the repoistory.

To configure these parameters, create a file named .rellformat in the root directory of your workspace. Inside this file, you can define the settings as follows:

[*.rell]
max_line_width = 120
insert_spaces = true
tab_size = 4

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"},
  }

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. To fetch the Language Server Jar you will need to have access to the rell-eclipse repository and create a personal access token for your profile on gitlab with api access. Add this token in .secrets file to be able to fetch the Language Server Jar

4. Create Custom Java Runtime Environment and fetch Language Server Jar:

   npm run setup

Run the extension with local changes

1. Hit F5 to run the extension (or go into the view Run and Debug and press Run Extension)
2. VS Code will open a new window where you can open your Rell project and get language support.

Publish new version

To publish a new version of the extension up to the vs code marketplace one need to update the version in package.json and merge it into main branch. This will trigger a pipeline on bitbucket which will publish a new version.

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.