internal

Documentation

Overview

Package internal contains internal functions for reading input YAML file.

Index

• type Check
• type Doc
  • func ReadDoc() (Doc, error)

Types

type Check

type Check struct {
	Risk        string   `yaml:"risk"`
	Short       string   `yaml:"short"`
	Description string   `yaml:"description"`
	Tags        string   `yaml:"tags"`
	Remediation []string `yaml:"remediation"`
	Name        string   `yaml:"-"`
	URL         string   `yaml:"-"`
}

Check stores a check's information. nolint:govet

type Doc

type Doc struct {
	InternalChecks map[string]Check `yaml:"checks"`
}

Doc stores the documentation for all checks.

func ReadDoc

func ReadDoc() (Doc, error)

ReadDoc reads documentation from the `checks.yaml` file.