name | string | Yes | | The registry's name. Where the registry is a group, it is the word typed on the command line before its commands |
|---|
path | path | No | | The directory holding the registry's document, relative to the directory of the registry or application declaration that names it; an entry naming a registry document has to state one. At the top of a registry document, it moves the directory its nested registries are resolved from |
|---|
filename | string | No | "registry.yml" | The registry document's file name within path (default: registry.yml) |
|---|
description | string | No | | What the registry holds, for a reader of the document. Nothing prints it: a group's listing prints help |
|---|
help | string | No | | The group's help, printed beside its name in a listing of the application's commands and carried into the application's index. Read only where the registry is a group |
|---|
asGroup | boolean | No | | true makes the registry a group: its commands are invoked as <app> <name> <command>. Absent or false, its commands are invoked where its parent's are, with no name added -- except that a registry whose entry in an application's declaration nests others is a group, and so is each registry under it |
|---|
audience | enum one of public, internal | No | | Who the commands under this registry are released to, public or internal. Absent, it is the audience of the registry holding this one, and at the top the application's, which its manifest module states. A registry may say it where a parent names it or at the top of its own document; saying both differently is refused. Stated public under an internal parent, it is refused, by name. |
|---|
sourcePath | path | No | | The registry document this entry resolves to, set as an application's registries are loaded and written in no document |
|---|
commands | list[registryCommand] | No | [] | The commands this registry declares. Empty rather than absent where it declares none: a registry with no commands of its own is an ordinary shape -- a grouping node whose children are registries -- and nothing here distinguishes the two, so every consumer was coalescing the null away. |
|---|
registries | list[registryDefinition] | No | [] | The registries nested below this one. Empty rather than absent for the same reason commands is: a leaf registry declares none, and no consumer asks whether the field was written. |
|---|