Crystal Install und Setup IDE

Installation IDE

Bei dem von uns getesteten System war Visual Studio 2022 Community Edition bereits installiert. Hier sind auch folgende Pakete mit installiert worden:
- vs_BuildTools
- Windows 10 SDK

Als eigenliche IDE für Crystal wird aber Visual Studio Code verwendet. Ob nun die reine Installation von Visual Studio Code ausreicht, ist uns nicht bekannt.

Link zum Download von VS-Code bei Microsoft

Installiert diese Software für euer System.

Installation Crystal Compiler

Für die Installation von Crystal gibt es einen Windows-Installer (.exe) und eine ZIP-Paket, welches als protable Variante betrachtet wird. Beide kann man in Github runterladen:

Download Crystal auf Github

Wir haben uns hier für den Windows-Installer entschieden:
crystal-1.11.2-windows-x86_64-msvc-unsupported.exe

Bei der Installation foglt einfach den Anweisungen.

Windows Entwicklermodus aktivieren

In der Windows Systemsteuerung muss der "Entwicklermodus" eingeschaltet werden.

Im Suchfeld der "Einstellungen" tippt einfach "für entwickler" und wählt "Einstellungen für Entwickler". Es öffnet sich ein Fenster in dem die Option "Entwicklermodus" angeboten wird.

Visual Studio Code einrichten

Crystal Syntax Highlighter

Eine enorme Erleichterung bringt ein Syntax Highlighter beim programmieren. Den kann man sich als Addon installieren.

Run > Install additional Debuggers

Es gibt für Crystal verschiede Tools. Wir haben folgenden erfolgreich im Einsatz:

Crystal Language
Crystal Programming Language
Crystal Language Tools

Crystal Debugger

Der Debugger ist wichtig, damit man auch direkt aus der IDE heraus das Programm compilieren und starten kann. Ebenso werden etwaige Fehler angezeigt.

Aus den Debugger gibt es als Addon:

Run > Install additional Debuggers

Wir haben uns für folgenden entschieden:

CodeLLDB von Vadim Chugunov

Projekt aufsetzen

Für einen ersten Test brauchen wir jetzt noch ein sehr einfaches Projekt.

Dazu legen wir folgende Ordner an.

\projekt
\projekt\src
\projekt\.vscode

Achtet auf den Punkt bei .vscode.

Im Ordner .vscode brauchen wir 2 Dateien, die wir manuell anlegen:
tasks.json

{
	"version": "2.0.0",
	"tasks": [
		{
			"label": "crystal: build current file (debug)",
			"type": "shell",
			"command": "crystal build --release --progress --debug ${relativeFile} -o src/${fileBasenameNoExtension}",
		}
	]
}

launch.json

{
"version": "0.2.0",
    "configurations": [
        {
            "type": "lldb",
            "request": "launch",
            "name": "crystal: debug current file",
            "preLaunchTask": "crystal: build current file (debug)",
            "program": "${workspaceFolder}/src/${fileBasenameNoExtension}",
            "cwd": "${workspaceFolder}"
        }
    ]
}

Beispielprogramm

Im Projektverzeichnis legt Ihr euch jetzt ein neues File mit Dateiendung .cr an. Wir verwenden main.cr, es kann aber auch ein anderer Name sein.
main.cr

print "Hallo MASCHINFO"

Gestartet wird das Programm mit F5 oder Run > Start Debugging.
Achtet darauf, dass bei dieser Konfiguration immer der aktuelle Tab compiliert wird.

Jetzt sollte sich ein Terminalfenster öffnen, in welchem der Compilierprozess angezeigt wird. Anschließend wird as kleine Programm gestartet und "Hallo MASCHINFO" ausgegeben.

Die fertige main.exe wir im Verzeichnis src gespeichert und kann als unabhängiges Programm gestartet werden.

Shards - Einbinden von externen Programmbibliotheken (Library)

Über Bibliotheken (Libraries) werden in Crystal-lang externe Programmteile eingebunden. Standardmäßig werden diese Bibliotheken auf Github bereitgestell und über eine Crystal eigene Funktion namens "shards" im eigenen Projekt verwendet.

Voraussetzung

Auf eurem Rechner muss Git installiert sein. Wer das noch nicht gemacht hat, kann sich die Installationsfiles auf der Herstellerseite herunterladen.

Git Installer

Wir haben uns für "64-bit Git for Windows Setup (Standalone Installer)" entschieden. Bei der Installation wurden alle Empfehlungen übernommen. Anschließend muss der Computer neu gestartet werden.

Shards ausführen

Im Projektverzeichnis erstellt Ihr eine neue Datei shards.yml mit folgendem Inhalt:

name: simpletest
version: 1

dependencies:
  colors:
    github: xtokio/colors

Die Angaben für name und version sind nicht von Relevanz.
Die eigentliche Bibliothek wird unter dependencies:

Hier binden wird die Bibliothek colors ein.

Nähere Infos dazu findet Ihr unter Github Colors.

Nachdem die Datei gespeichert wurde, führt man in der Commandozeile im Projektverzeichnis folgenden Befehl aus:

shards install

Dabei werden die benötigte Dateien heruntergeladen und im Projektverzeichnis gespeichert.

PS D:\projektverzeicnis> shards install
Resolving dependencies
Fetching https://github.com/xtokio/colors.git
Installing colors (0.1.0 at d2ddcce)
Writing shard.lock

Jetzt sollte es einige neue Verzeichnisse und Dateien im Projekt geben:
Datei shards.lock
Ordner lib und .shards

Beispielprogramm mit externe Bibliothek

# loading the library colors
require "colors"

# print some simple text in differen colors
puts "MASCHINFO".green
puts "MASCHINFO".blue