libdctlint

package

v0.0.0-...-d529551 Latest Latest Go to latest Published: Apr 2, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/Domain-Connect/dc-template-linter

Links

Open Source Insights

Documentation ¶

Overview ¶

Package libdctlint provides a library to check/lint Domain Connect service provider template.

Check results are communicated to humans with zerolog messages, that one is recommended to configure in software calling this library.

Constants ¶

View Source

const (
	TypeNS         uint16 = 2
	TypeCNAME      uint16 = 5
	TypeNULL       uint16 = 10
	TypeTXT        uint16 = 16
	TypeSRV        uint16 = 33
	TypeTLSA       uint16 = 52
	TypeSMIMEA     uint16 = 53
	TypeOPENPGPKEY uint16 = 61
	TypeSVCB       uint16 = 64
	TypeHTTPS      uint16 = 65
	TypeURI        uint16 = 256
)

View Source

const MaxTTL = (1 << 31) - 1 // 2147483647

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Conf ¶

type Conf struct {
	// contains filtered or unexported fields
}

Conf holds template checking instructions. The field type FileName must be updated each time CheckTemplate() is called to match with the bufio.Reader argument.

func NewConf ¶

func NewConf() *Conf

NewConf will create template check configuration.

func (*Conf) CheckTemplate ¶

func (conf *Conf) CheckTemplate(f *bufio.Reader) exitvals.CheckSeverity

CheckTemplate takes bufio.Reader as an argument and will run template checks according to the Conf configuration. Please remember to set conf.fileName appropriately before calling this function to avoid confusing results.

func (*Conf) GetAndCheckTemplate ¶

func (conf *Conf) GetAndCheckTemplate(f *bufio.Reader) (internal.Template, exitvals.CheckSeverity)

GetAndCheckTemplate is used in dctweb. Do not use applications outside of this project.

func (*Conf) SetCheckLogos ¶

func (c *Conf) SetCheckLogos(b bool) *Conf

func (*Conf) SetCloudflare ¶

func (c *Conf) SetCloudflare(b bool) *Conf

func (*Conf) SetFilename ¶

func (c *Conf) SetFilename(fn string) *Conf

func (*Conf) SetIncrement ¶

func (c *Conf) SetIncrement(b bool) *Conf

func (*Conf) SetInplace ¶

func (c *Conf) SetInplace(b bool) *Conf

func (*Conf) SetLogger ¶

func (c *Conf) SetLogger(l zerolog.Logger) *Conf

func (*Conf) SetPrettyPrint ¶

func (c *Conf) SetPrettyPrint(b bool) *Conf

func (*Conf) SetTTL ¶

func (c *Conf) SetTTL(t uint) *Conf

Source Files ¶

View all Source files

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