Git Product home page Git Product logo

catala-language-server's Introduction

Catala VSCode extension and LSP server

Disclaimer

Be advised that this is a work in progress repository and is not yet considered as a fully functional VSCode extension.

Features

Client side:

  • Syntax highlighting

LSP-server:

  • Highlighting of miscellaneous type of errors
  • Auto-completion

Getting started

Prerequisites

In order to build and use this extension, you will need to install:

  • OPAM, the OCaml package manager
  • npm, the JavaScript package manager

As this extension is still a work in progress, it uses some Catala compiler's experimental features that are yet to be merged in the published OPAM's Catala package. Therefore, it requires to also clone Catala and install the experimental branch locally through these steps:

git clone https://github.com/CatalaLang/catala.git
cd catala
git checkout vbot@lsp-tools
opam pin add catala .

Instead of pinning the experimental version, it is also possible to copy the Catala's cloned repository (including the branch switch) to server/vendors/.

Installation

# 1. Clone this repository
git clone https://github.com/CatalaLang/catala-language-server/
# 2. Go to the directory
cd catala-language-server/
# 3. Install the JS dependencies
npm install
# 4. Install the OCaml dependencies
cd server ; opam install . --deps-only ; cd ..
# 5. Build the extension
npm run compile

Testing

  1. Open VSCode at the repository's root (e.g., in a terminal $ code .)
  2. Go to "Run and Debug" in the VSCode sidebar (invoked by command "View: Show Run and Debug")
  3. Choose "Launch Client" and click on the play button
  4. A new VSCode window should open with the extension running
    • you can press CTRL+R to reload the extension window to apply changes

License

All the code contained in this repository is released under the Apache license (version 2) unless another license is explicited for a sub-directory.

catala-language-server's People

Contributors

vincent-botbol avatar

Stargazers

Romain Primet avatar

Watchers

Louis Gesbert avatar Denis Merigoux avatar  avatar

Forkers

rprimet

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.