@favoloso/常规变换log-emoji

Emojis 支持的常规更改日志 QQ

软件包没有运行时间依赖性 .

所需资源

• conventional-changelog v8+和 (中文(简体) ) conventional-recommended-bump 五维+ (即说. @release-it/conventional-changelog v12+ 和 (简体中文) release-it (原始内容存档于2018-09-21). v21+.
• 节点.js v22+(由上述工具要求).

旧工具( Handlebars ) conventional-changelog-writer v8及以下)由v0.10.x支持.

安装

yarn add --dev @favoloso/conventional-changelog-emoji

或者说

npm install --save-dev @favoloso/conventional-changelog-emoji

使用量

conventional-changelog -p @favoloso/emoji -i CHANGELOG.md -s

用法为 release-it

你用得着 常规变化日志 插件 与 @favoloso/emoji 预设.

"release-it": {
  "plugins": {
    "@release-it/conventional-changelog": {
      "preset": "@favoloso/emoji",
      "infile": "CHANGELOG.md"
    }
  }
}

Lint( 并固定) 发送消息

此软件包提供了额外的 bin 脚本 emoji-commit-lint。 。 。 .

脚本 提示和最终更改,来自传统常规更改日志 格式(即:. feat: Add a magic feature)到相应的emoji(即. ✨ Add a magic feature, (中文(简体) ), 检查并应用正确的外壳(即:. lower-case) 和更多,按配置 以 线条规则。 。 。 .

要使用、安装和初始化 嘘

yarn add --dev husky
yarn husky init

现在添加 .husky/commit-msg 钩:

HUSKY_GIT_PARAMS="$1" npx emoji-commit-lint

现在,linter会检查你的承诺。 任何承诺,如 <type>: <msg> 将自动 与相关的情感转变。 见 可用的 Emojis 见可用 类型。 。 。 .

配置

软件包是按原样工作的,但其行为可能按照以下选项定制.

说明: 配置从当前目录开始搜索到用户家, 地点如下( 第一个发现获胜 ): favolosoEmoji 属性在 package.json, (中文(简体) ), .favolosoEmojirc (杰森语), .favolosoEmojirc.json, (中文(简体) ), .favolosoEmojirc.js, (中文(简体) ), favolosoEmoji.config.js。 。 。 . YAML 文件 (% 1).favolosoEmojirc, (中文(简体) ), .favolosoEmojirc.yaml, (中文(简体) ), .favolosoEmojirc.yml)不再被支持:请将其转换为JSON.

• emojis (默认 : {}(中文(简体) )

  允许您自定义常规更改类型的对象( 如 可用的 Emojis 页:1.

  您应该提供对象, 其中键是 type 您想要编辑(或添加),而值是 更新配置。 如果已有配置, 配置将会与正本合并 .

  见 自定义 Emoji 维基页面 详细情况.

• rules (默认 : {}(中文(简体) )

  允许自定义linter 规则 . 见 线条规则 维基页面 详细情况.

• showEmojiPerCommit (默认 : false(中文(简体) )

  在变更日志中,显示每个承诺的emoji. 在默认模式( E)false),将emojis从承诺中省去,只有标题中包含它们(即. 🐛 Bug Fixes(中文(简体) )

• minorForBreakingInDevelopment (默认 : true(中文(简体) )

  开发过程中的突破性变化将被视为 小声 改为 主要 凸起 (参见 光谱) (中文(简体) ).

  4. 主要版本0 (0.y.z)是用于初始开发. 随时都可能改变 公众API不应被视为稳定.

• language (默认 : en(中文(简体) )

  允许翻译输入组标题 CHANGELOG.md (即说. 🐛 Bug Fixes)和插件中的信息. 可用语文: en, (中文(简体) ), it

软件包中的示例配置

{
  "favolosoEmoji": {
    "showEmojiPerCommit": false
  }
}

可用的 Emojis