Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var DebuggerFlags = []cli.Flag{}
var IoOverrideFlags = []cli.Flag{ newRedirectFlag("stdinFromFile", os.O_RDONLY, &os.Stdin, "os.Stdin", "input from file"), newRedirectFlag("stdoutToFile", os.O_WRONLY|os.O_TRUNC|os.O_CREATE, &os.Stdout, "os.Stdout", "output to file"), newRedirectFlag("stderrToFile", os.O_WRONLY|os.O_TRUNC|os.O_CREATE, &os.Stderr, "os.Stderr", "output to file"), }
var PackageProps = packageprops.Props{ WASMWASI: packageprops.WASMBlocked, WASMJS: packageprops.WASMBlocked, WASMFreestanding: packageprops.WASMBlocked, }
PackageProps records this package's curated properties (ADR-0080). Seeded by `boxer code analysis golang wasmsurvey props generate`; curate by hand. The same group's `props verify` reconciles it.
var WaitForDebugger = env.NewBool(env.Spec{ Name: "BOXER_WAIT_FOR_DEBUGGER", Description: "execution of program waits until an attached debugger is detected (linux only)", Category: env.CategoryDev, CliFlagName: "waitForDebugger", })
WaitForDebugger gates a Linux-only "block until ptrace tracer attached" loop in the CLI Action. The env var is registered on every platform so the registry is uniform; the cli.Flag is only attached on Linux.
Functions ¶
func NewCliCommand ¶
func WriteEntryPointsTable ¶ added in v0.0.20
func WriteEntryPointsTable(w io.Writer, audits []EntryPointAudit)
WriteEntryPointsTable renders audits as the aligned table the CLI and the composite gate both print.
Types ¶
type EntryPointAudit ¶ added in v0.0.20
EntryPointAudit is one `package main` measured against the three checks CODINGSTANDARDS.md "Entry Points" requires.
Baselined records whether the package is grandfathered, not whether it passes; a baselined package with all three checks true is simply Conformant.
func AuditEntryPointsE ¶ added in v0.0.20
func AuditEntryPointsE(ctx context.Context, cfg EntryPointsConfig) (audits []EntryPointAudit, err error)
AuditEntryPointsE loads every package under cfg.Root and measures each `package main` against the entry-point standard.
Results are sorted by import path so callers render a stable table. The audit is reported, not enforced: deciding what a failure costs belongs to the caller, which is what lets the CLI, the composite gate and a consuming repository share one implementation.
func (EntryPointAudit) Conformant ¶ added in v0.0.20
func (inst EntryPointAudit) Conformant() (ok bool)
func (EntryPointAudit) Failing ¶ added in v0.0.20
func (inst EntryPointAudit) Failing() (bad bool)
Failing reports whether this entry point should fail a strict audit — not conformant and not grandfathered.
type EntryPointsConfig ¶ added in v0.0.20
EntryPointsConfig parameterises AuditEntryPointsE.
Root is the directory packages are loaded from; BaselinePath, when non-empty, names a file of grandfathered package import paths (see [loadBaseline]).