Doc system test

project-lifecycle map

Project lifecycle: map

domain/

  • Create - cyanprint create adds a template to a folder, or upgrades or reruns it when the folder already has it; one command, three modes.
  • File clash record (stub) - One entry in the state file's file_conflicts list - a path two templates wrote in the last layering pass, how it was settled, every writer.
  • Managed files (stub) - The sorted list of paths the stacked templates make, kept per template record and as one union in the state file; see the state file format.
  • State file - The .cyan_state.yaml file - the only record of a project - its fields, who writes each one, and the rules a reader can rely on.
  • Update - cyanprint update moves every stacked template in a folder to its newest (or a picked) version, reusing saved answers and asking only new questions.

architecture/

  • Batch run - The one run behind create and update - run every template spec twice, stack each list, merge once, write, save state, run commands - and how it fails safely.
  • Template stacking - How several templates installed into one folder are each replayed and laid on top of each other on the user's machine, oldest first.

implementation/

  • Created folder cleanup - A headless create that stops before done removes exactly the folders it created, so a pending question leaves the disk as it was.
  • Git dirty check (stub) - Update checks git status first - dirty asks to proceed or fails headless; no git warns and runs; --force skips. Create never checks.
  • Output paths - kept off this public page (security-related)
  • Post-template commands - How the shell commands templates list are collected from every current template tree and run in the folder after the files are written.
  • Three-way merge - How create and update fold new template output into a folder the user has edited, in one git merge of whole file sets, with a rebuilt base.