simpletag

package
v3.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 13, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package simpletag implements a simple tag validator.

Index

Constants

View Source
const Name = "simpletag"

Name is the validators name.

Variables

This section is empty.

Functions

This section is empty.

Types

type Validator

type Validator struct{}

Validator checks if the commit message summary starts with a tag in square brackets followed by a description. The tag should be either - a single '*' or - completely lowercase letters or numbers, at least 2 characters long, other allowed characters are: '|', '-' and spaces. The tag can also contain multiple categories separated by '|', for example: [feat|fix]. The description should start with an uppercase letter or number, should be not to short and should not end with a punctuation.

func NewValidator

func NewValidator(_options map[string]string) (*Validator, error)

NewValidator create a new simpletag validator.

func (*Validator) Validate

func (v *Validator) Validate(commit *object.Commit) gitcc.Result

Validate validates a commit.

Jump to

Keyboard shortcuts

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