constants

Documentation

Index

• Constants
• type ResourceType

Constants

const (
	// DefaultStandardsFolder is the folder where to store standards.
	DefaultStandardsFolder = "standards"
	// DefaultCertificationsFolder is the folder where to store certifications.
	DefaultCertificationsFolder = "certifications"
	// DefaultComponentsFolder is the folder where to store components.
	DefaultComponentsFolder = "components"
	// DefaultDestination is the root folder where to store standards, certifications, and components.
	DefaultDestination = "opencontrols"
	// DefaultConfigYaml is the file name for the file to find config details
	DefaultConfigYaml = "opencontrol.yaml"
	// DefaultOpenControlsFolder is the folder containing opencontrol content
	DefaultOpenControlsFolder = "opencontrols"
	// DefaultExportsFolder is the folder for docs exports
	DefaultExportsFolder = "exports"
	// DefaultMarkdownFolder is the folder containing markdown content
	DefaultMarkdownFolder = "markdowns"
	// DefaultJSONFile is the file to store combined JSON
	DefaultJSONFile = DefaultDestination + "/opencontrol.json"
	// DefaultOutputFormat is the default format for general output
	DefaultOutputFormat = "json"
	// DefaultKeySeparator is the default separator for keys when flattening structure
	DefaultKeySeparator = ":"
)

const (
	// ErrMissingVersion reports that the schema version cannot be found.
	ErrMissingVersion = "Schema Version can not be found."
	// ErrComponentFileDNE is raised when a component file does not exists
	ErrComponentFileDNE = "Component files does not exist"
)

const (
	// WarningNoInformationAvailable is a warning to indicate that no information was found. Typically this will be
	// used when a template is being filled in and there is no information found for a particular section.
	WarningNoInformationAvailable = "No information available for component"
)

Types

type ResourceType

type ResourceType string

ResourceType is a type to help tell when it should be of only types of resources.

const (
	// Standards is the placeholder for the resource type of standards
	Standards ResourceType = "Standards"
	// Certifications is the placeholder for the resource type of certifications
	Certifications ResourceType = "Certifications"
	// Components is the placeholder for the resource type of components
	Components ResourceType = "Components"
)