Giter Club home page Giter Club logo

eflint-syntax-highlighting's Introduction

eFLINT Syntax Highlighting

Provides basic syntax highlighting for the eFLINT language for Visual Studio Code.

Features

Adds basic syntax highlighting for most keywords, buildin functions and data types for eFLINT. For example:

Example syntax hightlighting
Example of the eFLINT syntax highlighter using the builtin Monokai theme.

More constructs or features may be added in the future. Ideally, a language server might even provide much more advanced syntax highlighting.

Installation

To install the extension in your local setup, you can either download the extension via the marketplace (recommended), download the package VSIX file from the repository or compile the VSIX file yourself.

Marketplace

To download the extension from the marketplace, simply go the Extensions tab in Visual Studio Code.

Then, search for "eflint" and click on Install to install the latest version.

Screenshot to install from the marketplace
Menu to install the extension from the marketplace.

This method is recommended because you can also automatically receive updates.

Downloading

You can also choose to download a specific version of the extension from its repository. Simply select the desired release, and then download the .vsix file to someplace on your machine (where does not matter, as long as you can find it).

Then, you can install the extension by going to the Extensions tab in Visual Studio Code and then clicing the three-dot menu at the top of the middle panel. From there, you can select Install from VSIX....

Screenshot to install VSIX file
Menu to install a local .vsix file.

Navigate to the .vsix file you downloaded, and click Install.

Screenshot to browse to a VSIX file
Browsing to a .vsix file on Windows.

The extension should be installed once this operation completes.

Compilation

Before you begin, you should first install npm on your machine. Once done, you can install the vsce package we will use to build the extension:

npm install -g vsce

Then you can clone the repository:

git clone https://gitlab.com/eflint/tools/syntax-hightlighting-vscode
cd ./syntax-highlighting-vscode

With vsce installed and the repository cloned, you can compile the extension by running:

vsce package

This will generate the package .vsix file for us.

To install the extension, you can follow the steps taken for downloading the extension, except that you already have a .vsix file ready (so no need to download it from the repository).

Usage

To use the extension, simply create a new file.

Screenshot to create a new file
Steps to create a new file.

If you give the new file a .eflint extension, the extension should be enabled on this file automatically. If not, you can manually select it in the lower-right corner of the window.

Screenshot to select the eFLINT language 1
The button to open the language selection menu.

Screenshot to select the eFLINT language 2
The menu to select the eFLINT language for this file.

Release Notes

A brief overview of each release is given here. For more details, check the CHANGELOG.md file.

1.2.0

More keywords and support for #include and #require.

1.1.1

Bug fixes for comments and links in the README.

1.1.0

Added support for a lot more keywords, operators and identifiers. Also added an icon for the language.

1.0.0

Initial release of the extension.

eflint-syntax-highlighting's People

Contributors

lut99 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.