golem-examples

Crates.iogolem-examples
lib.rsgolem-examples
version0.1.15
sourcesrc
created_at2023-08-29 15:39:41.024937
updated_at2024-04-01 09:38:49.848385
descriptionGolem example templates
homepagehttps://golem.cloud
repository
max_upload_size
id958252
Daniel Vigovszky

documentation

README

# Golem Cloud example templates This repository contains all the *examples* available for the `golem` CLI tool using via the `golem new` command. See the example templates section on the [Golem CLI page](https://www.golem.cloud/learn/golem-cli). ## Structure The examples are organized to directories per **guest languages**. Each guest language directory contains an `INSTRUCTIONS` text file, which is a template itself and gets printed as a result of the `golem new` command. Each subdirectory of the guest languages is a template where the directory's name becomes the template's name. Each **example** consists of arbitrary number of files and subdirectories and a `metadata.json` file. The `golem new` command applies the below defined **template rules** for each file's and directory's name, and for each file's contents. The metadata file contains required information and also allows some additional project generation steps to be enabled. ### Metadata JSON The following fields are required: - `description` is a free-text description of the example The following fields are optional: - `requiresAdapter` is a boolean. If true, the appropriate version of the WASI Preview2 to Preview1 adapter is copied into the generated project (based on the guest language) to an `adapters` directory. - `requiresGolemHostWIT` is a boolean. If true, the Golem specific WIT interface gets copied into `wit/deps`. - `requiresWASI` is a boolean. If true, the WASI Preview2 WIT interfaces which are compatible with Golem Cloud get copied into `wit/deps`. - `exclude` is a list of sub-paths and works as a simplified `.gitignore` file. It's primary purpose is to help the development loop of working on examples and in the future it will likely be dropped in favor of just using `.gitignore` files. ### Template rules Golem examples are currently simple and not using any known template language, in order to keep the examples **compilable** as they are - this makes it very convenient to work on existing ones and add new examples as you can immediately verify that it can be compiled into a _Golem template_. When calling `golem-new` the user specifies a **template name**. The provided component name must use either `PascalCase`, `snake_case` or `kebab-case`. There is an optional parameter for defining a **package name**, which defaults to `golem:template`. It has to be in the `pack:name` format. The following occurrences get replaced to the provided component name, applying the casing used in the template: - `template-name` - `TemplateName` - `template_name` - `pack::name` - `pack:name` - `pack_name` - `pack/name` - `PackName`
Commit count: 0

cargo fmt