翻译:

可分享 commitlint 配置执行 角质承诺公约 财务报告和审定财务报表 Jira 智能提交语法基于 @ commitlint/ config- angular。 。 。 .

使用方式 翻译:, (中文(简体) ), @ commitlint/ cli (中文(简体) )。 。 。 .

开始

npm install --save-dev @dgc-org/commitlint-config-conventional-changelog-for-jira @commitlint/cli
echo "module.exports = {extends: ['@dgc-org/commitlint-config-conventional-changelog-for-jira']};" > commitlint.config.js

禁用承诺

在某些情况下,如果能够跳过闪烁,例如当无法进入Jira或不得不在GitOps做下流的事情时,也许有用。 如果满足了其中任一条件,此配置将完全跳过嵌入过程:

• 提交信件开头 WIP:,比如说. WIP: the office is burning down, need to save my work
• 环境变量 COMMITLINT_DISABLE 设置为 true (对大小写不敏感)或 1

这种机制只应在没有替代办法的情况下使用,而不应忽略可修复的验证故障.

规则

问题

下述规则被认为是: @dgc-org/commitlint-config-conventional-changelog-for-jira 并在未满足时生成非零退出代码. 咨询 文件/规则 用于列出现有规则.

类型

• 条件数字 : type 以数值显示
• 规则数字 : always
• 价值

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

echo "foo: some message" # fails
echo "fix: some message" # passes

类型大小写

• 说明数字 : type 发生时 value
• 规则数字 : always
• 价值

'lowerCase'

echo "FIX: some message" # fails
echo "fix: some message" # passes

类型空

• 条件数字 : type 为空
• 规则数字 : never

echo ": some message" # fails
echo "fix: some message" # passes

范围

• 条件数字 : scope 发生时 value
• 规则数字 : always

'lowerCase'

echo "fix(SCOPE): some message" # fails
echo "fix(scope): some message" # passes

主题

• 条件数字 : subject 在其中一种情况下 ['sentence-case', 'start-case', 'pascal-case', 'upper-case']
• 规则数字 : never

echo "fix(SCOPE): Some message" # fails
echo "fix(SCOPE): Some Message" # fails
echo "fix(SCOPE): SomeMessage" # fails
echo "fix(SCOPE): SOMEMESSAGE" # fails
echo "fix(scope): some message" # passes
echo "fix(scope): some Message" # passes

主题空出

• 条件数字 : subject 为空
• 规则数字 : never

echo "fix:" # fails
echo "fix: some message" # passes

主题全站

• 条件数字 : subject 结尾 value
• 规则数字 : never
• 价值

'.'

echo "fix: some message." # fails
echo "fix: some message" # passes

头-最大长

• 条件数字 : header 已经 value 或小于字符
• 规则数字 : always
• 价值

72

echo "fix: some message that is way too long and breaks the line max-length by several characters" # fails
echo "fix: some message" # passes

警告

以下规则被视为警告 @dgc-org/commitlint-config-conventional-changelog-for-jira 当警告未满足时,将打印它.

身体领先

• 条件: 以空白行开头的正文
• 规则数字 : always