stencil

Documentation

Overview

Package stencil implements the stencil command, which is essentially a thing wrapper around the codegen package which does most of the heavy lifting.

Index

• type Command
  • func NewCommand(log slogext.Logger, s *configuration.Manifest, dryRun bool) *Command
  • func (c *Command) Run(ctx context.Context) error
  • func (c *Command) Upgrade(ctx context.Context) error

Types

type Command

type Command struct {
	// contains filtered or unexported fields
}

Command is a thin wrapper around the codegen package that implements the "stencil" command. It is responsible for fetching dependencies, rendering templates, and writing files to disk using the underlying codegen package.

func NewCommand

func NewCommand(log slogext.Logger, s *configuration.Manifest, dryRun bool) *Command

NewCommand creates a new stencil command

func (*Command) Run

func (c *Command) Run(ctx context.Context) error

Run fetches dependencies of the root modules and builds the layered filesystem, after that GenerateFiles is called to actually walk the filesystem and render the templates. This step also does minimal post-processing of the dependencies manifests

func (*Command) Upgrade

func (c *Command) Upgrade(ctx context.Context) error

Upgrade checks for upgrades to the modules in the project and upgrades them if necessary. If no lockfile is present, it will log a message and return without doing anything.