conform

Documentation

Overview

Package conform implements output to .conform.yaml.

Index

• type Compiler
• type Output
  • func NewOutput() *Output
  • func (o *Output) Compile(compiler Compiler) error
  • func (o *Output) Enable()
  • func (o *Output) Filenames() []string
  • func (o *Output) GenerateFile(filename string, w io.Writer) error
  • func (o *Output) SetGPGSignatureCheck(enable bool)
  • func (o *Output) SetGitHubOrganization(org string)
  • func (o *Output) SetLicenseCheck(enable bool)
  • func (o *Output) SetLicensePolicySpecs(licensePolicySpecs []licensepolicy.Spec)
  • func (o *Output) SetMaximumOfOneCommit(enable bool)
  • func (o *Output) SetScopes(scopes []string)
  • func (o *Output) SetTypes(types []string)

Types

type Compiler

type Compiler interface {
	CompileConform(*Output) error
}

Compiler is implemented by project blocks which support .conform.yaml generate.

type Output

type Output struct {
	output.FileAdapter
	// contains filtered or unexported fields
}

Output implements .conform.yaml generation.

func NewOutput

func NewOutput() *Output

NewOutput creates new conform.yaml output.

func (*Output) Compile

func (o *Output) Compile(compiler Compiler) error

Compile implements output.TypedWriter interface.

func (*Output) Enable

func (o *Output) Enable()

Enable should be called to enable config generation.

func (*Output) Filenames

func (o *Output) Filenames() []string

Filenames implements output.FileWriter interface.

func (*Output) GenerateFile

func (o *Output) GenerateFile(filename string, w io.Writer) error

GenerateFile implements output.FileWriter interface.

func (*Output) SetGPGSignatureCheck

func (o *Output) SetGPGSignatureCheck(enable bool)

SetGPGSignatureCheck enables GPG signature check.

func (*Output) SetGitHubOrganization

func (o *Output) SetGitHubOrganization(org string)

SetGitHubOrganization scopes GPG identity check to the GitHub organization.

func (*Output) SetLicenseCheck

func (o *Output) SetLicenseCheck(enable bool)

SetLicenseCheck enables license check.

func (*Output) SetLicensePolicySpecs

func (o *Output) SetLicensePolicySpecs(licensePolicySpecs []licensepolicy.Spec)

SetLicensePolicySpecs sets the license policy specs.

func (*Output) SetMaximumOfOneCommit

func (o *Output) SetMaximumOfOneCommit(enable bool)

SetMaximumOfOneCommit enables single commit check.

func (*Output) SetScopes

func (o *Output) SetScopes(scopes []string)

SetScopes sets the conventional commit scopes.

func (*Output) SetTypes

func (o *Output) SetTypes(types []string)

SetTypes sets the conventional commit types.