Cave

Module cave

import cave

The vocabulary of a Cavefile.

A Cavefile is ordinary Zirric source, and cave is the vocabulary it is written in. The package manager reads the file for its types and attributes rather than executing it, so everything here is declaration, not behaviour.

Package marks the one data declaration that is the manifest. The attributes on the declaration describe the package itself; its fields are the dependencies. Each field names the import, and the attributes on it say where the package comes from — Stdlib, Git or Local — and, optionally, which Version is acceptable.

Version, LanguageVersion, Description and Documentation read the same way on the package and on one of its dependencies.

FormattingExcludes is unrelated to dependencies and may sit on any declaration; zirric fmt reads it to decide which paths to leave alone.

Contents

• Unions — Source
• Attributes — Description, Documentation, FormattingExcludes, Git, LanguageVersion, Local, Package, Stdlib, Version

---

Unions

Source

`cave/manifest.zirr:50`

union Source {
	Stdlib
	Git
	Local
}

The type of dependency: standard library, Git, or local.

Cases

---

Attributes

Description

`cave/manifest.zirr:38`

attr Description {
	desc: String
}

Describes the package or dependency in one line.

Fields

---

Documentation

`cave/manifest.zirr:44`

attr Documentation {
	url: String
}

Links to the documentation of the package or dependency.

Fields

---

FormattingExcludes

`cave/manifest.zirr:9`

attr FormattingExcludes {
	patterns: [String]
}

Excludes paths from zirric fmt and from editor formatting.
Patterns are relative to the package root: * matches within one segment, ** matches any number of segments.

Fields

---

Git

`cave/manifest.zirr:64`

attr Git {
	url: String
}

Declares the Git repository of the package, or marks a field as a Git dependency.
On a dependency the field name represents the import name of the dependency in this package.

Fields

---

LanguageVersion

`cave/manifest.zirr:28`

attr LanguageVersion {
	predicate: String
}

Declares which Zirric versions the package or dependency can be built with.

Fields

---

Local

`cave/manifest.zirr:70`

attr Local {
	path: String
}

Marks a field as a local dependency with a path.

Fields

---

Package

`cave/manifest.zirr:5`

attr Package

Marks the current data structure as the package manifest.
Its attributes describe the package itself, its fields declare the dependencies.

---

Stdlib

`cave/manifest.zirr:57`

attr Stdlib {
	name: String
}

Marks the current data structure as a standard library dependency.

Fields

---

Version

`cave/manifest.zirr:15`

attr Version {
	predicate: String
}

Declares the version of the package, or the version predicate a dependency accepts.

Fields