Linter Rules

Default configuration is provided as blueprint:

{
  rules: {
    "emoji-from-type": true,
    "emoji-known": true,
    "emoji-require": true,
    "spaces-between": true,
    "header-full-stop": false,
    "header-max-length": false,
    "subject-case": [2, { case: "sentence-case" }],
    "subject-require": true,
    "body-leading-blank": true
  }
}

Configuration style

• Rules may be enabled as errors setting them to true (equivalent to 2)
• Rules may be enabled as warnings (logs but do not throw) using [1, { arg: ... } ]. If no args are needed, [1] is sufficient.
• Rules may be disabled entirely (ignore) using false (equivalent to 0

List of available rules

emoji-from-type

Replaces conventional commit types (i.e. fix) with emojis.

"emoji-from-type": true

emoji-require

Ensures emoji is provided.

"emoji-require": true

emoji-known

Ensures emoji is an allowed one, given the emoji configuration.

"emoji-known": true,

header-full-stop

Force or disable full stop for the header.

Args:

• never: true to enforce missing full stop.

"header-full-stop": [2, { never: true }]

header-max-length

Limits max header length.

Args:

• max: Number maximum header length in characters

"header-max-length": [2, { max: 72 }]

spaces-between

Only one space allowed between Emoji and Subject.

"spaces-between": true

subject-require

Ensures a Subject is added.

"subject-require": true

subject-case

Allow only defined case in Subject, i.e. if sentence-case is set and message is 🛠 my Improvement, commit will be rewritten as 🛠 My improvement.

Args:

• case: May be one of sentence-case, lower-case, upper-case

"subject-case": [2, { case: 'lower-case' }]