Setup¶

This document holds instructions on the development setup.

Node.js¶

We use Node.js version 18.15.0. To install node, use nvm or nvm-windows.

1
2
3
4
5

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bash
source ~/.bashrc

nvm install 18.15.0
nvm use 18.15.0

Yarn¶

We use Yarn 2 (Modern). Install it as follows.

1

corepack enable

Tasks¶

We use ./task as build tool.

Using Tasks¶

Execute a task as follows. On Windows, execute it using, e.g., Git Bash.

1

./task [task]

Get an overview of tasks as follows.

1

./task tasks:list

Get help for a specific task as follows.

1

./task tasks:help [task]

Writing Tasks¶

Tasks can be written in Bash, Typescript, and Python and are located in ./tasks/some/command/task{.sh,.ts,.py}. The following environment variables are available.

Some hints:

• There is no need to include #!/usr/bin/bash or set -e in Bash tasks.
• Bash tasks are executed from TASK_ROOT_DIR.
• To add a summary, place a single line in ${TASK_TASK_DIR}/summary.
• To add a help text for a task, place the text in ${TASK_TASK_DIR}/help.
• Always add a new line at the end of every file.

Repository¶

The repository is a monorepo consisting of the CLI, server, docs, tests, etc. Clone it as follows.

1
2
3
4
5
6

git clone https://github.com/opentosca/opentosca-vintner.git
cd opentosca-vintner
git lfs install
git lfs pull
./task install
./task examples:pull:link

Large Files¶

Larges files, such as binaries or archives used in examples, are added using git lfs. This includes the file extensions .bin, .gz, .tar, .zip, .xz, and .jar.

Signed Commits¶

Commits are required to be signed. Therefore, register a signing key as follows.

• Generating a new GPG key
• Adding a GPG key to your GitHub account
• Telling Git About Your Signing Key
• Signing Commits

Enable auto-signing inside the repository.

1

git config commit.gpgsign true

JetBrains¶

We use WebStorm, which is free for students. Install Webstorm using JetBrains Toolbox.

ESLint¶

Open the Project Settings using Ctrl + Alt + S. ESLint should be configured as given in the figure below with the following pattern.

1

{**/*,*}.{ts}

Prettier¶

Open the Project Settings using Ctrl + Alt + S. Prettier should be configured as given in the figure below with the following pattern.

1

{**/*,*}.{ts,json,yaml,yml}

Excluded Directories¶

The following directories should be excluded from search by the IDE.

• .nyc_output
• docs/.venv
• build
• build-tasks
• coverage
• yarn
• dist
• node_modules