Doc system test

UL

Words: authoring

Namespace: durian.cloud/cyanprint/authoring

Writing the artifacts - templates, template groups, processors, plugins, conflict resolvers - with the SDKs and cyan.yaml

WordMeaning
TemplateAn artifact that asks questions and returns a Cyan; it ships a template image (the script) and a blob image (the files).
Template groupA template with no images that only lists other templates and resolvers; it makes no files of its own.
ProcessorAn artifact that reads selected template files and writes transformed files into its own output folder.
PluginAn artifact that edits a template's merged output folder after its processors ran.
Conflict resolverAn artifact that merges every version of one file into one file, for example two package.json files.
CyanA template's final answer - the processors (with globs and config) and plugins (with config) to run on its files.
Cyan globA file selection in a Cyan - root, glob, excludes, and mode template (hand to the processor) or copy (copy as is).
cyan.yamlAn artifact's config file - name, metadata, and for a template its processors, plugins, templates, resolvers and commands.
InquirerThe SDK object a template script asks its questions with.
Determinism helperd.get(key, make) in the SDK - makes a value once and returns the same value on every replay of one run.
SDK serverThe HTTP server an SDK wraps around an author's function - port 5550 template, 5551 processor, 5552 plugin, 5553 resolver.
Artifact testcyanprint test - run an artifact on saved inputs and compare with saved snapshots.
Trycyanprint try - run an unpublished template or template group through a local coordinator.
Image buildcyanprint build - build an artifact's Docker images with buildx.

Template

An artifact that asks questions and returns a Cyan; it ships a template image (the script) and a blob image (the files).

  • Do not say: blueprint, scaffold
  • See: Template group, Cyan

Example script: StartTemplateWithLambda(async (i, d) => ({ processors: [...], plugins: [] })).

Template group

A template with no images that only lists other templates and resolvers; it makes no files of its own.

  • Also called: group template
  • Do not say: meta-template

Pushed with cyanprint push group. In the registry it is a template whose versions have no images.

Processor

An artifact that reads selected template files and writes transformed files into its own output folder.

  • Do not say: transformer, templater

Example: atomi/eta fills {{NAME}} placeholders in every file the Cyan glob selects.

Plugin

An artifact that edits a template's merged output folder after its processors ran.

  • Do not say: hook, post-processor

Example: a formatter that runs over the whole merged folder.

Conflict resolver

An artifact that merges every version of one file into one file, for example two package.json files.

  • Also called: resolver, file resolver
  • Do not say: merger
  • See: Processor output merge, Dependency layering

Code names: Resolver (registry), ConflictFileResolver (CLI), ICyanResolver (SDK). "Resolver" alone means this. The CLI type DependencyResolver is a different thing; docs call it dependency flattening.

Cyan

A template's final answer - the processors (with globs and config) and plugins (with config) to run on its files.

  • Do not say: plan, output
  • See: Cyan glob

Cyan glob

A file selection in a Cyan - root, glob, excludes, and mode template (hand to the processor) or copy (copy as is).

  • Do not say: glob

cyan.yaml

An artifact's config file - name, metadata, and for a template its processors, plugins, templates, resolvers and commands.

Inquirer

The SDK object a template script asks its questions with.

Determinism helper

d.get(key, make) in the SDK - makes a value once and returns the same value on every replay of one run.

  • Do not say: pin, seed
  • See: Deterministic state

SDK server

The HTTP server an SDK wraps around an author's function - port 5550 template, 5551 processor, 5552 plugin, 5553 resolver.

Artifact test

cyanprint test - run an artifact on saved inputs and compare with saved snapshots.

  • Do not say: test

Try

cyanprint try - run an unpublished template or template group through a local coordinator.

Image build

cyanprint build - build an artifact's Docker images with buildx.

  • Do not say: build