Stratum Contexts

Some Stratum constructs reuse the same contexts as described in Details > Contexts:

• Bases receive an Options Context
• Templates receive a Template Context with refinements described in Stratum Template Configurations

Other Stratum constructs do not reuse Bingo’s existing contexts:

• Blocks generally receive a Block Context
  • A specialized Intake Context is used for specific intake APIs
• Presets don’t have their own contexts

Block Contexts

The Context object provided to the produce, setup, and transition properties of Blocks.

addons

Any Block Addons that have been provided by other Blocks.

For example, this Gitignore Block defines an ignores Addon that other Blocks can use to add to its created .gitignore file:

import { base } from "./base";

export const blockGitignore = base.createBlock({
  addons: {
    ignores: z.array(z.string()).default([]),
  },
  produce({ addons }) {
    return {
      files: {
        ".gitignore": ["/node_modules", ...addons.ignores].join("\n"),
      },
    };
  },
});

options

User-provided values as described by the parent Base.

Bases fill in option values before running Blocks. Each Block created by a Base will run with the same set of options.

For example, this Base defines a repository option, which the Block then prints as a package.json property:

import { createBase } from "bingo-stratum";

export const base = createBase({
  options: {
    repository: z.string(),
  },
});

export const blockPackageJson = createBlock({
  produce({ options }) {
    return {
      files: {
        "package.json": JSON.stringify({ name: options.repository }),
      },
    };
  },
});

Intake Contexts

The Context object provided to the intake properties of Blocks.

files

Any existing files on disk as a bingo-fs CreatedDirectory, if running in transition mode.

Files in the directory are stored as [string, CreatedFileMetatdata?] tuples

For example, this Block reads in existing npm ignore lines from an .npmignore file if it exists:

import { z } from "zod";

import { base } from "./base";

export const blockNpmignore = base.createBlock({
  addons: {
    ignores: z.array(z.string()).optional(),
  },
  intake({ files }) {
    return {
      ignores: files[".npmignore"]?.split("\n").filter(Boolean),
    };
  },
  async produce({ addons }) {
    return {
      files: {
        ".npmignore": [...addons.ignores, ""].join("\n"),
      },
    };
  },
});