ghul.compiler 0.5.21

ghūl compiler

This package contains the ghūl programming language compiler packaged as a .NET tool

Prerequisites

The compiler requires the .NET 6.0 SDK

Target

The compiler produces standard .NET assemblies and packages targeting .NET 6.0

Getting the compiler

There are a few different ways to get the compiler - you might not need to use this package directly.

Use a ghūl .NET project template

If you initialize your project using one of the ghūl .NET project templates, the template will add the compiler to your project folder as a local .NET tool - just run dotnet tool restore to restore it.

Clone the ghūl GitHub repository template

If you create a new GitHub repo from the ghūl repository template, then the compiler will be pre-configured as a local .NET tool in your project folder - run dotnet tool restore to restore it.

Use the ghūl development container image

The compiler is pre-installed globally in the ghūl development container

Install the compiler as a local or global .NET tool

If none of the above options suits, you can manually install the compiler from this package - see below for details.

Using the compiler

Project file

The compiler expects to be driven by MSBuild using a .ghulproj project file. See the ghūl targets package for a minimal example, or use one of the project templates to get started.

Source files

You'll need some ghūl source files. By convention ghūl source files have the extension .ghul, and the standard MSBuild targets will include **/*.ghul when building.

Building and running

Once you have a project file and some ghūl source files, you can use the normal .NET SDK commands to build, pack, and run your project:

dotnet build

dotnet pack

dotnet run

Runtime dependencies for ghūl applications

Applications written in ghūl require the .NET 6.0 runtime

Development environment

Visual Studio Code will give you rich language support via the ghūl VSCode language extension.

Manual compiler install

Local tool install

To install the compiler locally in your project folder:

dotnet new tool-manifest # if you don't already have a tool manifest file

dotnet tool install ghul.compiler # install the latest release of the compiler locally

dotnet ghul-compiler # run the compiler

A local tool install means you get a predictable compiler version on every build, provided you check in the tool manifest. It also means you can easily use different versions of the compiler for different projects on the same machine.

Global tool install

To install the compiler globally for the current user:

dotnet tool install --global ghul.compiler # install the latest release of the compiler globally

ghul-compiler # run the compiler

Gotchas

The ghūl language is sufficiently expressive and the compiler is stable enough for the compiler itself to be written in ghūl. However, this is an incomplete compiler for an experimental programming language: there will be compiler bugs!