Documentation
¶
Overview ¶
Package scaffold generates a new C4Stack app. It only ever creates a new directory; it never writes into an existing one.
Index ¶
Constants ¶
View Source
const FrameworkModule = "github.com/coolapso/c4stack"
FrameworkModule is the module path apps require.
View Source
const GoVersion = "1.26.0"
GoVersion is the go directive generated apps start with.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Options ¶
type Options struct {
// Dir is the directory to create. It must not exist.
Dir string
// Name is the app's name: lowercase letters, digits and hyphens, starting with a
// letter. It names the binary and derives the environment variable prefix.
Name string
// Module is the Go module path. Zero means Name.
Module string
// Version is the C4Stack release to pin, such as v0.1.0. It is ignored with Local.
Version string
// Local is the path of a C4Stack checkout to build against during development. The
// app then gets a replace directive and includes the checkout's shared Taskfile.
Local string
}
Options describe the app to generate.
Source Files
Click to show internal directories.
Click to hide internal directories.