validate

Documentation

Overview

Package validate provides validation logic for checking over a local knowledge base.

Index

• func NewFilenameValidator() filenameValidator
• type Error
  • func (e Error) Error() string
• type Validator

Functions

func NewFilenameValidator

func NewFilenameValidator() filenameValidator

NewFilenameValidator returns a filenameValidator type.

Types

type Error

type Error uint8

Error allows for sentinel errors via enums.

const (
	// ErrFailedRegexMatch is a sentinel error for when the check fails due to
	// regexp.MatchString returning an error, commonly caused by an invalid regex
	// pattern.
	ErrFailedRegexMatch Error = iota

	// ErrInsufficientNumberOfFilenameParts is a sentinel error for when the check
	//  fails due to the filename not having at least one part.
	ErrInsufficientNumberOfFilenameParts

	// ErrInvalidFilenameFormat is a sentinel error for when the check fails due
	// to a note filename using the incorrect format.
	ErrInvalidFilenameFormat

	// ErrMissingMarkdownFileExtension is a sentinel error for when the check
	// fails due to the filename not ending with the ".md" markdown file
	// extension.
	ErrMissingMarkdownFileExtension

	// ErrUnrecognisedBaseSchemaType is a sentinel error for when the check fails
	// due to the filename using a base schema type which is not valid/known.
	ErrUnrecognisedBaseSchemaType
)

func (Error) Error

func (e Error) Error() string

Error implements the errors.Error interface.

type Validator

type Validator interface {
	Validate(filename string, filenameWithoutExtension string) []error
}

Validator is an interface for all validator types to derive from, it allows validation logic to be separate from the model.