cli

package
v1.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 24, 2025 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package cli allows a CLI tool to be linted from the host or in a container

Index

Constants

This section is empty.

Variables

View Source
var Version = "latest"

Version used to match img tags with crie versions

Functions

This section is empty.

Types

type LintCli added in v0.20.0

type LintCli struct {
	Type           string        `json:"type" yaml:"type" jsonschema:"enum=cli" jsonschema_description:"the most common linter type, a cli tool"`
	Exec           exec.Instance `json:"exec" yaml:"exec" jsonschema_required:"true" jsonschema_description:"settings for the command to run" `
	Img            string        `json:"img,omitempty" yaml:"img,omitempty" jsonschema_description:"the container image to pull and use"`
	TagCrieVersion bool          `` /* 154-byte string literal not displayed */
	// contains filtered or unexported fields
}

LintCli defines a predefined command to run against a file

func (*LintCli) Cleanup added in v0.20.0

func (e *LintCli) Cleanup(group *sync.WaitGroup)

Cleanup removes any additional resources created in the process

func (*LintCli) MaxConcurrency added in v0.20.0

func (e *LintCli) MaxConcurrency() int

MaxConcurrency returns the max concurrency name

func (*LintCli) Name added in v0.20.0

func (e *LintCli) Name() string

Name returns the command name

func (*LintCli) Run added in v0.20.0

func (e *LintCli) Run(filePath string, rep chan linter.Report)

Run does the work required to lint the given filepath

func (*LintCli) WillRun added in v0.20.0

func (e *LintCli) WillRun() error

WillRun does preflight checks for the 'Run'

Directories

Path Synopsis
Package exec allows for a CLI tool to be executed in different contexts
Package exec allows for a CLI tool to be executed in different contexts

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL