utils

package

v0.17.9 Latest Latest Go to latest Published: Aug 20, 2025 License: MIT Imports: 12 Imported by: 1

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/daveshanley/vacuum

Links

Open Source Insights

Documentation ¶

Index ¶

func BuildEndNode(node *yaml.Node) *yaml.Node
func CreateCustomHTTPClient(config HTTPClientConfig) (*http.Client, error)
func CreateRemoteURLHandler(client *http.Client) func(url string) (*http.Response, error)
func RenderMarkdownTable(headers []string, rows [][]string) string
func ShouldUseCustomHTTPClient(config HTTPClientConfig) bool
func SuppliedOrDefault(supplied, original string) string
type HTTPClientConfig
type LintFileRequest

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BuildEndNode ¶ added in v0.9.0

func BuildEndNode(node *yaml.Node) *yaml.Node

BuildEndNode will return a new yaml.Node with the same line as the input node, but with a column that is the sum of the input node's column and the length of the input node's value.

func CreateCustomHTTPClient ¶ added in v0.17.8

func CreateCustomHTTPClient(config HTTPClientConfig) (*http.Client, error)

CreateCustomHTTPClient creates an HTTP client with custom TLS configuration for certificate-based authentication and custom CA certificates.

func CreateRemoteURLHandler ¶ added in v0.17.8

func CreateRemoteURLHandler(client *http.Client) func(url string) (*http.Response, error)

CreateRemoteURLHandler creates a RemoteURLHandler function for use with libopenapi that uses the provided HTTP client for all remote requests.

func RenderMarkdownTable ¶ added in v0.16.15

func RenderMarkdownTable(headers []string, rows [][]string) string

RenderMarkdownTable builds a Markdown table from headers and rows.

func ShouldUseCustomHTTPClient ¶ added in v0.17.8

func ShouldUseCustomHTTPClient(config HTTPClientConfig) bool

ShouldUseCustomHTTPClient returns true if any TLS-related configuration is provided

func SuppliedOrDefault ¶ added in v0.7.0

func SuppliedOrDefault(supplied, original string) string

Types ¶

type HTTPClientConfig ¶ added in v0.17.8

type HTTPClientConfig struct {
	CertFile string
	KeyFile  string
	CAFile   string
	Insecure bool
}

HTTPClientConfig holds configuration for creating a custom HTTP client

type LintFileRequest ¶ added in v0.9.0

type LintFileRequest struct {
	FileName                 string
	BaseFlag                 string
	MultiFile                bool
	Remote                   bool
	SkipCheckFlag            bool
	Silent                   bool
	DetailsFlag              bool
	TimeFlag                 bool
	NoMessageFlag            bool
	ExtensionRefs            bool
	AllResultsFlag           bool
	FailSeverityFlag         string
	CategoryFlag             string
	SnippetsFlag             bool
	ErrorsFlag               bool
	TotalFiles               int
	FileIndex                int
	TimeoutFlag              int
	IgnoreArrayCircleRef     bool
	IgnorePolymorphCircleRef bool
	NoClip                   bool
	IgnoredResults           model.IgnoredItems
	DefaultRuleSets          rulesets.RuleSets
	SelectedRS               *rulesets.RuleSet
	Functions                map[string]model.RuleFunction
	Lock                     *sync.Mutex
	Logger                   *slog.Logger
	PipelineOutput           bool
	ShowRules                bool
	HTTPClientConfig         HTTPClientConfig
}

Source Files ¶

View all Source files

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