constants

Documentation

Index

• Constants
• Variables

Constants

const (
	// GlobalConfigPath is the identifier for the global path of the config file.
	// This file is located in user folder '~/fisherman.yaml'.
	GlobalConfigPath = "GlobalConfigPath"
	// LocalConfigPath is the identifier for the local path of the config file.
	// This configuration file is located in the .git folder of the repository.
	// This file will not be included in the repository index.
	LocalConfigPath = "LocalConfigPath"
	// RepoConfigPath is the identifier for the repository level path of the config file.
	// This configuration file is located in the repository and it will be included in the repository index.
	RepoConfigPath = "RepoConfigPath"
	// HookName is constant for identification name of current hook in template.
	HookName = "HookName"
)

const (
	// UserEmailVariable is global UserEmail constant name.
	UserEmailVariable = "UserEmail"
	// UserNameVariable is global UserName constant name.
	UserNameVariable = "UserName"
	// FishermanVersionVariable is global FishermanVersion constant name.
	FishermanVersionVariable = "FishermanVersion"
	// CwdVariable is global CWD constant name.
	CwdVariable = "CWD"
	// BranchNameVariable is global BranchName constant name.
	BranchNameVariable = "BranchName"
	// TagVariable is global TagName constant name.
	TagVariable = "TagName"
	// OsVariable is global operation system constant name.
	OsVariable = "OS"
)

const AppName = "fisherman"

AppName is a binary file name.

const ConfigurationDocksURL = "https://fisherman.netlify.app/docs"

ConfigurationDocksURL is url to main docs page.

const ConfigurationFilesDocksURL = "https://fisherman.netlify.app/docs/configuration/configuration-files"

ConfigurationFilesDocksURL is url to configuration files page.

const ConfigurationInheritanceURL = "https://fisherman.netlify.app/docs/configuration/configuration-files#configuration-file-inheritance"

ConfigurationInheritanceURL is url to configuration inheritance page.

Variables

var (
	ApplypatchMsgHook        = "applypatch-msg"
	PreApplypatchHook        = "pre-applypatch"
	PostApplypatchHook       = "post-applypatch"
	PreCommitHook            = "pre-commit"
	PreMergeCommitHook       = "pre-merge-commit"
	PrepareCommitMsgHook     = "prepare-commit-msg"
	CommitMsgHook            = "commit-msg"
	PostCommitHook           = "post-commit"
	PreRebaseHook            = "pre-rebase"
	PostCheckoutHook         = "post-checkout"
	PostMergeHook            = "post-merge"
	PrePushHook              = "pre-push"
	PreReceiveHook           = "pre-receive"
	UpdateHook               = "update"
	ProcReceiveHook          = "proc-receive"
	PostReceiveHook          = "post-receive"
	PostUpdateHook           = "post-update"
	ReferenceTransactionHook = "reference-transaction"
	PushToCheckoutHook       = "push-to-checkout"
	PreAutoGcHook            = "pre-auto-gc"
	PostRewriteHook          = "post-rewrite"
	SendemailValidateHook    = "sendemail-validate"
	FsmonitorWatchmanHook    = "fsmonitor-watchman"
	P4ChangelistHook         = "p4-changelist"
	P4PrepareChangelistHook  = "p4-prepare-changelist"
	P4PostChangelistHook     = "p4-post-changelist"
	P4PreSubmitHook          = "p4-pre-submit"
	PostIndexChangeHook      = "post-index-change"
)

var AppConfigNames = []string{
	".fisherman.yaml",
	".fisherman.yml",
}

AppConfigNames is allowed config names.

var HookHeader = `` /* 335-byte string literal not displayed */

HookHeader is a graphic with hook and configuration information.

var HooksNames = []string{
	ApplypatchMsgHook,
	PreApplypatchHook,
	PostApplypatchHook,
	PreCommitHook,
	PreMergeCommitHook,
	PrepareCommitMsgHook,
	CommitMsgHook,
	PostCommitHook,
	PreRebaseHook,
	PostCheckoutHook,
	PostMergeHook,
	PrePushHook,
	PreReceiveHook,
	UpdateHook,
	ProcReceiveHook,
	PostReceiveHook,
	PostUpdateHook,
	ReferenceTransactionHook,
	PushToCheckoutHook,
	PreAutoGcHook,
	PostRewriteHook,
	SendemailValidateHook,
	FsmonitorWatchmanHook,
	P4ChangelistHook,
	P4PrepareChangelistHook,
	P4PostChangelistHook,
	P4PreSubmitHook,
	PostIndexChangeHook,
}

HooksNames is list on supported hooks.

var Logo = `` /* 533-byte string literal not displayed */

Logo is a logotype of fisherman.

var Version = "x.x.x"

Version is version string of binary.