Class CommitMessageRule

CommitMessageRule checks all commits title according to a regular expression and an optional max size.

returns: return a RuleResult object

Hierarchy

Rule
- CommitMessageRule

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new CommitMessageRule(googleAnalytics: Visitor): CommitMessageRule

Overrides Rule.constructor
- Defined in rules/commitMessage.rule.ts:35
Parameters
- googleAnalytics: Visitor
Returns CommitMessageRule

Properties

enabled

enabled: boolean

events

events: GitEventEnum[] = [GitEventEnum.Push]

Private googleAnalytics

googleAnalytics: Visitor

name

name: string

onBoth

onBoth: OnSuccessError[]

onError

onError: OnSuccessError[]

onSuccess

onSuccess: OnSuccessError[]

options

options: CommitMessageOptions

Methods

displayRule

displayRule(): void

Inherited from Rule.displayRule
- Defined in rules/rule.class.ts:30
Display each rule's properties

Returns void

isEnabled

isEnabled(webhook: Webhook, ruleConfig: any): false

Inherited from Rule.isEnabled
- Defined in rules/rule.class.ts:46
Check if the rule can be apply to the received webhook, according to the ruleConfig

Parameters
- webhook: Webhook
- ruleConfig: any
Returns false

validate

validate(webhook: Webhook, ruleConfig: CommitMessageRule, ruleResults?: RuleResult[]): Promise<RuleResult>

Overrides Rule.validate
- Defined in rules/commitMessage.rule.ts:44
Parameters
- webhook: Webhook
- ruleConfig: CommitMessageRule
- Optional ruleResults: RuleResult[]
Returns Promise<RuleResult>

Generated using TypeDoc