globalflagcov

Documentation

Overview

Package globalflagcov computes which persistent global CLI flags (commands.Flags) are referenced transitively from each cobra command's RunE handler.

Index

• type FlagSet
• type Row
  • func Report(moduleRoot string) ([]Row, error)

Types

type FlagSet

type FlagSet struct {
	JSON    bool
	DryRun  bool
	Yes     bool
	Force   bool
	Verbose bool
}

FlagSet records whether each global persistent flag is read on some path from the handler.

type Row

type Row struct {
	// Path is space-separated from the second segment (e.g. "workflow status"), excluding "da".
	Path string
	// Handler is the runtime symbol for the RunE func (or closure).
	Handler string
	// Flags is transitive coverage through same-package calls.
	Flags FlagSet
	// Notes is non-empty when analysis was partial (e.g. unresolved closure).
	Notes string
}

Row is one CLI command path and observed global-flag coverage.

func Report

func Report(moduleRoot string) ([]Row, error)

Report generates coverage rows for every command with a RunE (or Run) on the default root tree.