Doc system test

authoring map

Authoring: map

How artifact authors write templates, template groups, processors, plugins and conflict resolvers, and check them before push.

domain/

feature

  • Artifact reference - How cyan.yaml and the CLI write a reference to another artifact: username/name or username/name:version.
  • Artifact test - cyanprint test: run a template, processor, plugin or resolver against saved inputs and compare its output with saved snapshots.
  • Conflict resolver - An artifact that merges several versions of one file into one, such as two package.json files.
  • Cyan glob - A file selection in a Cyan: root, glob, excludes, and a mode - template (hand files to the processor) or copy (copy bytes as they are).
  • cyan.yaml - The artifact's config file: identity and metadata, and for a template its processors, plugins, templates (with preset answers), resolvers and commands.
  • Cyan - A template's final answer: the list of processors (with globs and config) and plugins (with config) to run.
  • Determinism helper - The SDK's d.get(key, make): the way a template makes a random or time value that stays the same across replays.
  • Dev config - The dev section of cyan.yaml: try a template whose script runs on your machine at a URL, with files from a local blob folder.
  • Image build - cyanprint build: build an artifact's Docker images with buildx.
  • Inquirer - The SDK object a template script asks questions with: text, password, select, checkbox, confirm, date.
  • Plugin - An artifact that edits the merged output folder of a template after its processors ran.
  • Processor - An artifact that reads selected template files and writes transformed files into its own output folder.
  • Template group - A template with no images: it only lists other templates (with preset answers) and resolvers, and makes no files itself.
  • Template - An artifact that asks questions and returns a Cyan: which processors and plugins to run on its files.
  • Test config - The test.cyan.yaml file: the cases an artifact test runs - answers or inputs, expected output folder, optional commands.
  • Try - cyanprint try: run an unpublished local template, or template group, through a local coordinator before pushing.

architecture/

surface

  • SDK servers - How each SDK (Node, Python, .NET) wraps an author's function in an HTTP server, one fixed port per artifact kind.

implementation/

algorithm

  • Env substitution - How ${VAR} and ${VAR:-default} are filled in the build and dev sections of cyan.yaml.
  • Snapshot comparison - How an artifact test compares actual output with the saved snapshot folder.
  • Test init - How cyanprint test init walks a template's question tree to write test cases and first snapshots.
  • Try run - How cyanprint try runs a local template: a stand-in template version, a local template container, and output written without a merge.