ghul.templates 0.0.11

ghūl 'dotnet new' templates

These are 'dotnet new' templates for quick-starting a console application or class library .NET 6.0 project written in the ghūl programming language.

Note that these templates do not include things like GitHub Actions workflows, development container config, Dependabot config, unit tests, etc. For a GitHub repository template that does include all those things, see the ghūl repository template repo.

CI/CD status

Package

ghul.templates

Prerequisites

This template will create a skeleton ghūl programming language project that can be built on any host that supports the .NET 6.0 SDK, including any of:

• GitHub Codespaces
• Windows 10
• Windows 10 with Docker Desktop and either the ghūl development container or another image that includes the .NET 6.0 SDK
• Windows 10 with WSL2
• Linux with
• Linux with Docker and ghūl development container or another image that includes the .NET 6.0 SDK

You'll need to install the .NET 6.0 SDK or, for the Docker options, make sure you're using an image that includes it (try the ghūl development image or the Microsoft .NET SDK image)

Recommended

• Visual Studio Code
• The ghūl language Visual Studio Code extension, which will give you rich language support including:
  • syntax highlighting
  • error highlighting as you type
  • code snippets
  • symbol information on hover
  • intelligent code completion
  • function signature help
  • find uses
  • go to/peek definition
  • go to symbol in file
  • go to symbol in workspace

Installing the templates

The templates are distributed as a NuGet package containing two .NET templates. Before you can use them, you need to install the template package:

$ dotnet new --install ghul.templates

Instantiating the templates

Start by creating a new folder for your project and cd into it

$ mkdir example
$ cd example

Then use dotnet new to initialize a new instance of either template in your project folder:

$ dotnet new ghul-console

Or

$ dotnet new ghul-classlib

This will create a .ghulproj MSBuild project file, a .ghul source file and some other supporting files:

$ find

./src
./src/example.ghul
./src/README.md
./README.md
./.config
./.config/dotnet-tools.json
./.vscode
./.vscode/tasks.json
./example.ghulproj

Building the template application or package

ghūl applications are standard .NET applications using familiar MSBuild projects and .NET SDK commands such as dotnet build and dotnet pack. However, before these commands will work, you do need to install the ghūl compiler

Installing the ghūl compiler

(If you're developing in a container using the ghūl development Docker image then you can skip this step)

The ghūl compiler is packaged as a .NET tool and can be installed either locally or globally.

Local tool install

This template includes a local tool manifest in the .config folder which includes the compiler, so you can install the compiler locally simply by restoring local tools:

$ dotnet tool restore

Note: if you're using Visual Studio Code and the ghūl extension, the extension will do this for you automatically when you open the project folder

Global tool install

If you prefer to install the compiler globally, you can run:

$ dotnet tool install --global ghul.compiler

Note: if you do install the compiler globally, you will also need to change the GhulCompiler property in your .ghulproj file to reference it:

    <GhulCompiler>ghul-compiler</GhulCompiler>

Building your project

Just use the normal dotnet commands:

$ dotnet build

$ dotnet pack

And, for the console application template:

$ dotnet run

etc. etc.

In Visual Studio Code, run the build task (<ctrl> + <shift> + B), which is set up to run dotnet build or dotnet pack