FilterRule class

Filter Rule is the main dart class to implement a filter rule and it return the content of the match that will be put in the changelog.

The interface give the possibility to the end user to specified the type of changelog patter that the commit body can contains

Constructors

FilterRule({required String nameSection, String? exactMatch, RegExp? regex, String? headerExactMatch, RegExp? headerRegex, bool strict = false})

exactMatch → String?: The exact match need to be specified and it can contains a prefix for example
final
hashCode → int: The hash code for this object.
no setterinherited
headerExactMatch → String?: if not null we make a check on the header too by exact match we keep the commit if header and body match are satisfied.
final
headerRegex → RegExp?: if not null the filter rule take into count the regex if the exact match fails, and the commit it keep in the section only if the header and body will match.
final
nameSection → String: The name of te section that is generated in the changelog from this filter rule
final
regex → RegExp?: If the exactMatch can fails it is possible specify a regex, if it match the content of the match it is specified in the commit info
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
strict → bool: If true, The check between header and body need to be strict this mean that the check on the header and the body must be satisfied. if false (as default), if the header it is not matching but the body yes, the commit is checked anyway
final

match({required CommitInfo commitInfo}) → String?: match is a function that apply the match logic to return the content to put in the changelog, and if no match was found the null is returned.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited