Fix linting

Author: Racer159

src/internal/packager/template/template.go

@@ -23,6 +23,7 @@ const (
 	depMarkerNew = "DATA_INJECTION_MARKER"
 )
 
+// GetZarfVariableConfig gets a variable configuration specific to Zarf
 func GetZarfVariableConfig() *variables.VariableConfig {
 	return variables.New(
 		"zarf",

src/pkg/actions/actions.go

@@ -212,7 +212,7 @@ func (ac *ActionRunner) ConvertWaitToCmd(wait ActionWait, timeout *int) (string,
 }
 
 // actionCmdMutation performs some basic string mutations to make commands more useful.
-func (ac *ActionRunner) actionCmdMutation(cmd string, shellPref exec.ExecShell) (string, error) {
+func (ac *ActionRunner) actionCmdMutation(cmd string, shellPref exec.Shell) (string, error) {
 	// Try to patch the zarf binary path in case the name isn't exactly "./zarf".
 	cmd = strings.ReplaceAll(cmd, fmt.Sprintf("./%s ", ac.commandName), ac.commandPath+" ")
 
@@ -278,7 +278,7 @@ func (ac *ActionRunner) actionMergeDefaults(def ActionDefaults, a Action, vars m
 }
 
 // execAction executes the built command in a shell
-func (ac *ActionRunner) execAction(ctx context.Context, cfg ActionDefaults, cmd string, shellPref exec.ExecShell, spinner Spinner) (string, error) {
+func (ac *ActionRunner) execAction(ctx context.Context, cfg ActionDefaults, cmd string, shellPref exec.Shell, spinner Spinner) (string, error) {
 	shell, shellArgs := exec.GetOSShell(shellPref)
 
 	ac.logger(fmt.Sprintf("Running command in %s: %s", shell, cmd))

src/pkg/actions/types.go

@@ -23,12 +23,12 @@ type ActionSet struct {
 
 // ActionDefaults sets the default configs for child actions
 type ActionDefaults struct {
-	Mute            bool           `json:"mute,omitempty" jsonschema:"description=Hide the output of commands during execution (default false)"`
-	MaxTotalSeconds int            `json:"maxTotalSeconds,omitempty" jsonschema:"description=Default timeout in seconds for commands (default to 0, no timeout)"`
-	MaxRetries      int            `json:"maxRetries,omitempty" jsonschema:"description=Retry commands given number of times if they fail (default 0)"`
-	Dir             string         `json:"dir,omitempty" jsonschema:"description=Working directory for commands (default CWD)"`
-	Env             []string       `json:"env,omitempty" jsonschema:"description=Additional environment variables for commands"`
-	Shell           exec.ExecShell `json:"shell,omitempty" jsonschema:"description=(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"`
+	Mute            bool       `json:"mute,omitempty" jsonschema:"description=Hide the output of commands during execution (default false)"`
+	MaxTotalSeconds int        `json:"maxTotalSeconds,omitempty" jsonschema:"description=Default timeout in seconds for commands (default to 0, no timeout)"`
+	MaxRetries      int        `json:"maxRetries,omitempty" jsonschema:"description=Retry commands given number of times if they fail (default 0)"`
+	Dir             string     `json:"dir,omitempty" jsonschema:"description=Working directory for commands (default CWD)"`
+	Env             []string   `json:"env,omitempty" jsonschema:"description=Additional environment variables for commands"`
+	Shell           exec.Shell `json:"shell,omitempty" jsonschema:"description=(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"`
 }
 
 // Action represents a single action to run
@@ -39,7 +39,7 @@ type Action struct {
 	Dir                   *string              `json:"dir,omitempty" jsonschema:"description=The working directory to run the command in (default is CWD)"`
 	Env                   []string             `json:"env,omitempty" jsonschema:"description=Additional environment variables to set for the command"`
 	Cmd                   string               `json:"cmd,omitempty" jsonschema:"description=The command to run. Must specify either cmd or wait for the action to do anything."`
-	Shell                 *exec.ExecShell      `json:"shell,omitempty" jsonschema:"description=(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"`
+	Shell                 *exec.Shell          `json:"shell,omitempty" jsonschema:"description=(cmd only) Indicates a preference for a shell for the provided cmd to be executed in on supported operating systems"`
 	DeprecatedSetVariable string               `json:"setVariable,omitempty" jsonschema:"description=[Deprecated] (replaced by setVariables) (onDeploy/cmd only) The name of a variable to update with the output of the command. This variable will be available to all remaining actions and components in the package. This will be removed in Zarf v1.0.0,pattern=^[A-Z0-9_]+$"`
 	SetVariables          []variables.Variable `json:"setVariables,omitempty" jsonschema:"description=(onDeploy/cmd only) An array of variables to update with the output of the command. These variables will be available to all remaining actions and components in the package."`
 	Description           string               `json:"description,omitempty" jsonschema:"description=Description of the action to be displayed during package execution instead of the command"`
@@ -67,6 +67,7 @@ type ActionWaitNetwork struct {
 	Code     int    `json:"code,omitempty" jsonschema:"description=The HTTP status code to wait for if using http or https,example=200,example=404"`
 }
 
+// Validate validates an Action struct instantiation
 func (action Action) Validate() error {
 	// Validate SetVariable
 	for _, variable := range action.SetVariables {

src/pkg/cluster/data.go

@@ -47,7 +47,7 @@ func (c *Cluster) HandleDataInjection(wg *sync.WaitGroup, data types.ZarfDataInj
 	}
 
 	// Get the OS shell to execute commands in
-	shell, shellArgs := exec.GetOSShell(exec.ExecShell{Windows: "cmd"})
+	shell, shellArgs := exec.GetOSShell(exec.Shell{Windows: "cmd"})
 
 	if _, _, err := exec.Cmd(shell, append(shellArgs, "tar --version")...); err != nil {
 		message.WarnErr(err, "Unable to execute tar on this system.  Please ensure it is installed and on your $PATH.")

src/pkg/utils/exec/exec.go

@@ -27,8 +27,8 @@ type Config struct {
 	Stderr         io.Writer
 }
 
-// ExecShell represents the desired shell to use for a given command
-type ExecShell struct {
+// Shell represents the desired shell to use for a given command
+type Shell struct {
 	Windows string `json:"windows,omitempty" jsonschema:"description=(default 'powershell') Indicates a preference for the shell to use on Windows systems (note that choosing 'cmd' will turn off migrations like touch -> New-Item),example=powershell,example=cmd,example=pwsh,example=sh,example=bash,example=gsh"`
 	Linux   string `json:"linux,omitempty" jsonschema:"description=(default 'sh') Indicates a preference for the shell to use on Linux systems,example=sh,example=bash,example=fish,example=zsh,example=pwsh"`
 	Darwin  string `json:"darwin,omitempty" jsonschema:"description=(default 'sh') Indicates a preference for the shell to use on macOS systems,example=sh,example=bash,example=fish,example=zsh,example=pwsh"`
@@ -153,7 +153,7 @@ func LaunchURL(url string) error {
 }
 
 // GetOSShell returns the shell and shellArgs based on the current OS
-func GetOSShell(shellPref ExecShell) (string, []string) {
+func GetOSShell(shellPref Shell) (string, []string) {
 	var shell string
 	var shellArgs []string
 	powershellShellArgs := []string{"-Command", "$ErrorActionPreference = 'Stop';"}

src/pkg/utils/wait.go

@@ -78,7 +78,7 @@ func ExecuteWait(waitTimeout, waitNamespace, condition, kind, identifier string,
 	spinner := message.NewProgressSpinner(existMsg)
 
 	// Get the OS shell to execute commands in
-	shell, shellArgs := exec.GetOSShell(exec.ExecShell{Windows: "cmd"})
+	shell, shellArgs := exec.GetOSShell(exec.Shell{Windows: "cmd"})
 
 	defer spinner.Stop()