Skip to content

Latest commit

 

History

History
133 lines (93 loc) · 3.5 KB

README.zh-CN.md

File metadata and controls

133 lines (93 loc) · 3.5 KB
Raw

English | 简体中文 | Português Brasileiro | Português Europeu | 日本語 | 한국어

报告问题 · 功能需求

VSCode 中用于 Git 提交信息的 Gitmoji 工具

💻 扩展截图

📦 安装扩展

  1. 首先打开 Visual Studio Code；
  2. 使用 Ctrl+Shift+X 组合键打开「扩展」标签；
  3. 输入 Gitmoji 寻找此扩展；
  4. 点击 安装 按钮，然后点击 启用 按钮即可。

提示：也可以直接在 Marketplace 中找到 Gitmoji，然后点击 Install 即可。

🔨 配置扩展

表情符号输出类型

  • outputType - 配置表情符号的输出类型（默认为 emoji 模式）。

emoji 模式的例子：

emoji

code 模式的例子：

code

示例配置：

{
  "gitmoji.outputType": "emoji"
}

提示：如果在 Gitlab 或者 Coding 中使用，需要选择「code」模式；如果在 GitHub 中使用，可以随意选择「emoji」或「code」模式。

添加自定义表情符号

  • addCustomEmoji - 添加自定义表情符号。

示例配置：

{
  "gitmoji.addCustomEmoji": [
    {
      "emoji": "🧵",
      "code": ":thread:",
      "description": "添加或更新与多线程或并发相关的代码"
    },
    {
      "emoji": "🦺",
      "code": ":safety_vest:",
      "description": "添加或更新与验证相关的代码"
    }
  ]
}

仅使用自定义表情符号

  • onlyUseCustomEmoji - 仅使用自定义添加的表情符号，而不使用扩展中自带的表情符号（该功能默认关闭）。

示例配置：

{
  "gitmoji.onlyUseCustomEmoji": true
}

通过简码搜索表情符号

  • showEmojiCode - 开启通过简码搜索表情符号功能（该功能默认关闭）。

示例配置：

{
  "gitmoji.showEmojiCode": true
}

在消息最后插入表情符号

  • asSuffix - 开启在消息最后插入标签符号的功能（该功能默认关闭）。

示例配置：

{
  "gitmoji.asSuffix": true
}

🤝 参与共建

我们欢迎所有的贡献，你可以将任何想法作为 Pull requests 或 Issues 提交，顺颂商祺！

📃 开源许可

项目基于 MIT 许可证发布，详细说明请参阅 LICENCE 文件。