Rell Language Extension for Visual Studio Code

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

Features

This extension enables language features for Rell, including syntax- and semantic highlighting, syntax- and compilation warnings, go-to definition, find references, symbol renaming (except for module symbols), linter, formatting, workspace caching, and a Rell Test Runner.

Linter

The extension comes with a built-in Rell linter, which helps developers detect potential issues at early stage and enforces some best practices.

Configuration file:

File name: .rell_lint

Location: Must be located in the root directory of the project.

Content:

[*.rell]
# Check Rell naming convention (true | false)
rule_naming_convention=true

# Warns about imports from non module files (true | false)
rule_import_from_non_module=true

# Preferred quote format (double | single)
rule_quote_format=double

# Rell formatter integration. Detects violations as you type (true | false)
rule_formatter=true

# Detects variables that could be declared as constants (true | false)
rule_constant_detection=true

# Warns about declared but unused variables (true | false)
rule_unused_variable=true

# Warns about outer joins without join conditions, which result in a Cartesian product (true | false)
rule_outer_join_cartesian_product=true

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 repository.

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

Workspace Caching

Index caching is disabled by default and can be enabled from the UI within vs-code Settings -> Extensions -> Rell and check the checkbox.
To invalidate caches that has been created use the command Rell: Invalidate index caches from the vscode command palette.

Coloring and Styling

The extension comes with a color schema that uses modifiers to only alter colors for Rell files. We believe that the colors we present using this gives better contextual awareness of the different tokens of Rell. It is disabled by default. Can be enabled from the UI within vs-code Settings -> Extensions -> Rell.

Rell Test Runner

The test runner utilizes the Chromia CLI. By default it is executed with the command chr, for this you need to have Chromia CLI installed on your machine. But this can be configured with the setting rell.chrExecutablePath to use an explicit chr binary path or running it with docker.