Class: Git::Lint::Analyzers::CommitSubjectSuffix

Inherits:
Abstract
  • Object
show all
Defined in:
lib/git/lint/analyzers/commit_subject_suffix.rb

Constant Summary

Constants inherited from Abstract

Abstract::ISSUE_LINE_OFFSET, Abstract::LEVELS

Instance Attribute Summary

Attributes inherited from Abstract

#commit

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Abstract

build_issue_line, descendants, #enabled?, #error?, id, inherited, #initialize, #invalid?, label, #severity, #warning?

Constructor Details

This class inherits a constructor from Git::Lint::Analyzers::Abstract

Class Method Details

.defaultsObject



7
8
9
10
11
12
13
14
15
16
17
# File 'lib/git/lint/analyzers/commit_subject_suffix.rb', line 7

def self.defaults
  {
    enabled: true,
    severity: :error,
    excludes: [
      "\\.",
      "\\?",
      "\\!"
    ]
  }
end

Instance Method Details

#issueObject



25
26
27
28
29
# File 'lib/git/lint/analyzers/commit_subject_suffix.rb', line 25

def issue
  return {} if valid?

  {hint: %(Avoid: #{filter_list.to_hint}.)}
end

#valid?Boolean

Returns:

  • (Boolean)


19
20
21
22
23
# File 'lib/git/lint/analyzers/commit_subject_suffix.rb', line 19

def valid?
  return true if filter_list.empty?

  !commit.subject.match?(/#{Regexp.union filter_list.to_regexp}\Z/)
end