subject

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Sep 19, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package subject provides the configuration of the commit message subject, including its description and task integration, and the functional options to build the config.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Config

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

Config represents the configuration of the commit message subject.

func NewConfig

func NewConfig(opts ...Option) Config

NewConfig creates a new subject config with the provided functional options.

func (Config) Description

func (c Config) Description() description.Config

Description returns the configuration of the subject description text.

func (Config) Task

func (c Config) Task() task.Config

Task returns the configuration for task integration.

type Option

type Option func(*Config)

Option is a functional option that modifies the subject config on its creation.

func WithDescription

func WithDescription(desc description.Config) Option

WithDescription sets the description configuration for the subject config.

func WithTask

func WithTask(cfg task.Config) Option

WithTask sets the task integration configuration.

Directories

Path Synopsis
Package description provides the configuration of the commit message subject description, including its length interval and the functional options to build the config.
Package description provides the configuration of the commit message subject description, including its length interval and the functional options to build the config.

Jump to

Keyboard shortcuts

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