Skip to content

规则

¥Rules

body-full-stop

  • 条件:bodyvalue 结尾

    ¥condition: body ends with value

  • 规则:never

    ¥rule: never

  • value

    text
    '.'

body-leading-blank

  • 条件:body 以空行开头

    ¥condition: body begins with blank line

  • 规则:always

    ¥rule: always

body-empty

  • 条件:body 为空

    ¥condition: body is empty

  • 规则:never

    ¥rule: never

body-max-length

  • 条件:body 包含 value 个或更少个字符

    ¥condition: body has value or less characters

  • 规则:always

    ¥rule: always

  • value

    text
    Infinity

body-max-line-length

  • 条件:body 行包含 value 个或更少的字符。

    ¥condition: body lines has value or less characters

  • 规则:always

    ¥rule: always

  • value

    text
    Infinity

body-min-length

  • 条件:body 包含 value 个或更多个字符

    ¥condition: body has value or more characters

  • 规则:always

    ¥rule: always

  • value

    text
    0

body-case

  • 条件:body 位于 value 的 case 中

    ¥condition: body is in case value

  • 规则:always

    ¥rule: always

  • value

    text
    'lower-case'
  • 可能的值

    ¥possible values

    js
    [
      "lower-case", // default
      "upper-case", // UPPERCASE
      "camel-case", // camelCase
      "kebab-case", // kebab-case
      "pascal-case", // PascalCase
      "sentence-case", // Sentence case
      "snake-case", // snake_case
      "start-case", // Start Case
    ];
  • 条件:footer 以空行开头

    ¥condition: footer begins with blank line

  • 规则:always

    ¥rule: always

  • 条件:footer 为空

    ¥condition: footer is empty

  • 规则:never

    ¥rule: never

  • 条件:footer 包含 value 个或更少个字符

    ¥condition: footer has value or less characters

  • 规则:always

    ¥rule: always

  • value

    text
    Infinity
  • 条件:footer 行包含 value 个或更少的字符。

    ¥condition: footer lines has value or less characters

  • 规则:always

    ¥rule: always

  • value

    text
    Infinity
  • 条件:footer 包含 value 个或更多个字符

    ¥condition: footer has value or more characters

  • 规则:always

    ¥rule: always

  • value

    text
    0

header-case

  • 条件:header 位于 value 的 case 中

    ¥condition: header is in case value

  • 规则:always

    ¥rule: always

  • value

    text
    'lower-case'
  • 可能的值

    ¥possible values

    js
    [
      "lower-case", // default
      "upper-case", // UPPERCASE
      "camel-case", // camelCase
      "kebab-case", // kebab-case
      "pascal-case", // PascalCase
      "sentence-case", // Sentence case
      "snake-case", // snake_case
      "start-case", // Start Case
    ];

header-full-stop

  • 条件:headervalue 结尾

    ¥condition: header ends with value

  • 规则:never

    ¥rule: never

  • value

    text
    '.'

header-max-length

  • 条件:header 包含 value 个或更少个字符

    ¥condition: header has value or less characters

  • 规则:always

    ¥rule: always

  • value

    text
    72

header-min-length

  • 条件:header 包含 value 个或更多个字符

    ¥condition: header has value or more characters

  • 规则:always

    ¥rule: always

  • value

    text
    0

header-trim

  • 条件:header 行首和/或尾随不能有空格。

    ¥condition: header must not have initial and / or trailing whitespaces

  • 规则:always

    ¥rule: always

references-empty

  • 条件:references 至少包含一个条目

    ¥condition: references has at least one entry

  • 规则:never

    ¥rule: never

scope-enum

  • 条件:scope 位于值中

    ¥condition: scope is found in value

  • 规则:always

    ¥rule: always

  • value

    text
    []

NOTE

  • 如果消息中未提供作用域或值 > 为空数组,则此规则始终有效。

    ¥This rule always passes if no scopes are provided in the message or the value > is an empty array.

  • 设置为 always 时,所有消息范围都必须在值中找到。

    ¥When set to always, all message scopes must be found in the value.

  • 设置为 never 时,任何消息范围都无法在值中找到。

    ¥When set to never, none of the message scopes can be found in the value.

scope-case

  • 条件:scope 位于 value 的 case 中

    ¥condition: scope is in case value

  • 规则:always

    ¥rule: always

  • value

    text
    'lower-case'
  • 可能的值

    ¥possible values

js
[
  "lower-case", // default
  "upper-case", // UPPERCASE
  "camel-case", // camelCase
  "kebab-case", // kebab-case
  "pascal-case", // PascalCase
  "sentence-case", // Sentence case
  "snake-case", // snake_case
  "start-case", // Start Case
];

scope-empty

  • 条件:scope 为空

    ¥condition: scope is empty

  • 规则:never

    ¥rule: never

scope-max-length

  • 条件:scope 包含 value 个或更少个字符

    ¥condition: scope has value or less characters

  • 规则:always

    ¥rule: always

  • value

text
Infinity

scope-min-length

  • 条件:scope 包含 value 个或更多个字符

    ¥condition: scope has value or more characters

  • 规则:always

    ¥rule: always

  • value

text
0

subject-case

  • 条件:subject 位于 value 的 case 中

    ¥condition: subject is in case value

  • 规则:always

    ¥rule: always

  • value

js
["sentence-case", "start-case", "pascal-case", "upper-case"];
  • 可能的值

    ¥possible values

js
[
  "lower-case", // lower case
  "upper-case", // UPPERCASE
  "camel-case", // camelCase
  "kebab-case", // kebab-case
  "pascal-case", // PascalCase
  "sentence-case", // Sentence case
  "snake-case", // snake_case
  "start-case", // Start Case
];

subject-empty

  • 条件:subject 为空

    ¥condition: subject is empty

  • 规则:never

    ¥rule: never

subject-full-stop

  • 条件:subjectvalue 结尾

    ¥condition: subject ends with value

  • 规则:never

    ¥rule: never

  • value

text
'.'

subject-max-length

  • 条件:subject 包含 value 个或更少个字符

    ¥condition: subject has value or less characters

  • 规则:always

    ¥rule: always

  • value

text
Infinity

subject-min-length

  • 条件:subject 包含 value 个或更多个字符

    ¥condition: subject has value or more characters

  • 规则:always

    ¥rule: always

  • value

text
0

subject-exclamation-mark

  • 条件:subject: 标记前有一个感叹号

    ¥condition: subject has exclamation before the : marker

  • 规则:never

    ¥rule: never

type-enum

  • 条件:type 位于值中

    ¥condition: type is found in value

  • 规则:always

    ¥rule: always

  • value

    js
    [
      "build",
      "chore",
      "ci",
      "docs",
      "feat",
      "fix",
      "perf",
      "refactor",
      "revert",
      "style",
      "test",
    ];

type-case

  • 描述:type 位于 value 的 case 中

    ¥description: type is in case value

  • 规则:always

    ¥rule: always

  • value

    text
    'lower-case'
  • 可能的值

    ¥possible values

    js
    [
      "lower-case", // default
      "upper-case", // UPPERCASE
      "camel-case", // camelCase
      "kebab-case", // kebab-case
      "pascal-case", // PascalCase
      "sentence-case", // Sentence case
      "snake-case", // snake_case
      "start-case", // Start Case
    ];

type-empty

  • 条件:type 为空

    ¥condition: type is empty

  • 规则:never

    ¥rule: never

type-max-length

  • 条件:type 包含 value 个或更少个字符

    ¥condition: type has value or less characters

  • 规则:always

    ¥rule: always

  • value

    text
    Infinity

type-min-length

  • 条件:type 包含 value 个或更多个字符

    ¥condition: type has value or more characters

  • 规则:always

    ¥rule: always

  • value

    text
    0

signed-off-by

  • 条件:message 包含 value

    ¥condition: message has value

  • 规则:always

    ¥rule: always

  • value

    text
    'Signed-off-by:'

trailer-exists

  • 条件:message 包含尾随 value

    ¥condition: message has trailer value

  • 规则:always

    ¥rule: always

  • value

    text
    'Signed-off-by:'