Setup

Setting up your system

For jPipe to work on your computer, you'll need the two following software:

• Java (version 21)
• Graphviz

Installing the command-line compiler

Using Homebrew (Mac OS X)

You have to load McSCert's tap and then install the jpipe formula. Brew will take care of installing the dependencies if needed.

~ $ brew tap ace-design/mcscert
~ $ brew install jpipe

Using APT (Ubuntu/Debian)

A .deb package will soon be available.

Compiling from source

The compiler's source code is in the ab-compiler directory. We rely on Maven to build the system:

~ $ git clone [email protected]:ace-design/jpipe.git
~ $ cd jpipe/ab-compiler
ab-compiler $ mvn -q install

At the end of the compilation process, a file named jpipe.jar will be available in the ab-compiler directory. To use the compiler this way, simply use java -jar jpipe.jar instead of jpipe.

Installing the Visual Code plugin

We provide a language server and its integration into VS Code to support designers using jPipe. To access it:

1. Open VS Code
2. Navigate to the Extension panel on the left menu
3. Search for jpipe in the search bar
4. Select the extension published by McSCert
5. Click on the install button

Remark: The extension comes with a standalone compiler. This version assumes that you have Java and Graphviz available on your computer. If you cannot use the extension, try to double-check if these two tools are in your PATH.