angularcommit

Documentation

Overview

Package angularcommit analyzes angular-style commit messages

https://gist.github.com/stephenparish/9941e89d80e2bc58a153#format-of-the-commit-message https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#

Index

• Variables
• type Analyzer
  • func New() *Analyzer
  • func NewWithOptions(options *Options) *Analyzer
  • func (analyzer *Analyzer) Analyze(commit *semrel.Commit) ([]semrel.Change, error)
  • func (analyzer *Analyzer) Lint(message string) []error
• type Change
  • func (commit *Change) BumpLevel() semrel.BumpLevel
  • func (commit *Change) Category() string
  • func (commit *Change) PreReleased() bool
• type Options

Variables

var (

	// DefaultOptions for angular commit Analyzer
	DefaultOptions = &Options{
		ChoreTypes:   []string{"chore", "docs", "test"},
		FixTypes:     []string{"fix", "refactor", "perf", "style"},
		FeatureTypes: []string{"feat"},
		BreakingChangeMarkers: []string{
			`BREAKING\s+CHANGE:`,
			`BREAKING\s+CHANGE`,
			`BREAKING:`,
		},
	}
)

Types

type Analyzer

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

Analyzer is a semrel.Analyzer instance that parses commits according to angularjs commit conventions

func New

func New() *Analyzer

New initializes Analyzer with DefaultOptions

func NewWithOptions

func NewWithOptions(options *Options) *Analyzer

NewWithOptions initializes Analyzer with options provided

func (*Analyzer) Analyze

func (analyzer *Analyzer) Analyze(commit *semrel.Commit) ([]semrel.Change, error)

Analyze implements semrel.Analyzer interface for angularcommit.Analyzer

func (*Analyzer) Lint

func (analyzer *Analyzer) Lint(message string) []error

Lint checks if message is fomatted according to rules specified in analyzer. Currently only checs the format of head line and that type is found.

type Change

type Change struct {
	CommitType      string
	Scope           string
	Subject         string
	BreakingMessage string
	Hash            string
	// contains filtered or unexported fields
}

Change captures commit message analysis

func (*Change) BumpLevel

func (commit *Change) BumpLevel() semrel.BumpLevel

BumpLevel implements semrel.Change interface

func (*Change) Category

func (commit *Change) Category() string

Category implements semrel.Change interface

func (*Change) PreReleased

func (commit *Change) PreReleased() bool

PreReleased implements semrel.Change interface

type Options

type Options struct {
	ChoreTypes            []string
	FixTypes              []string
	FeatureTypes          []string
	BreakingChangeMarkers []string
}

Options control how angular commit analyzer behaves