gitmoji 在 Rust 中

这是 gitmoji-cli 的一个基于 Rust 的有争议版本。

A gitmoji 交互式客户端，用于在提交信息中使用 gitmojis。

安装

获取最新的二进制文件：这里

如果你已经安装了 Rust 工具链，可以使用以下命令安装：

检查你是否具有依赖项

# macOS (Homebrew)
$ brew install openssl@3

# macOS (MacPorts)
$ sudo port install openssl

# macOS (pkgsrc)
$ sudo pkgin install openssl

# Arch Linux
$ sudo pacman -S pkg-config openssl

# Debian and Ubuntu
$ sudo apt-get install pkg-config libssl-dev

# Fedora
$ sudo dnf install pkg-config perl-FindBin openssl-devel

# Alpine Linux
$ apk add pkgconfig openssl-dev

# openSUSE
$ sudo zypper in libopenssl-devel

源码

然后运行 cargo install

cargo install gitmoji-rs

用法

gitmoji help 或 gitmoji --help

提供 CLI 帮助。

❯ gitmoji help
gitmoji-rs 0.1.0
Igor Laborie <[email protected]>
A gitmoji client for using emojis on commit messages

USAGE:
    gitmoji [OPTIONS] <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -v, --verbose    Verbose mode
    -V, --version    Print version information

SUBCOMMANDS:
    commit    Interactively commit using the prompts
    help      Print this message or the help of the given subcommand(s)
    init      Setup gitmoji preferences
    list      List all available gitmojis
    search    Search gitmojis
    update    Sync emoji list with the repository

注意，您也可以请求特定子命令的帮助，尝试 gitmoji help init

gitmoji init

交互式初始化配置

❯ gitmoji init
✔ Enable automatic "git add ." · no
✔ Select how emojis should be used in commits · 😄
✔ Enable signed commits · no
✔ Enable scope prompt · no
✔ Set gitmojis api url · https://gitmoji.dev/api/gitmojis

注意，您也可以不进行交互生成默认配置，可以使用 gitmoji init --default。

gitmoji commit

交互式创建 git 提交

❯ gitmoji commit
✔ Pick your flavor · 🚀 :rocket: rocket - Deploy stuff.
✔ Enter the commit title · Initial version
✔ Enter the commit message: · Adding require feature for a basic usage (init, update, list, search, and commit)
[main f4525b2] :rocket: Initial version
 12 files changed, 213 insertions(+), 78 deletions(-)
 create mode 100644 .github/workflows/bloat.yaml
 create mode 100644 .github/workflows/lint.yaml
 rename .github/workflows/{ci.yaml => tests.yaml} (51%)
 create mode 100644 CHANGELOG.md
 create mode 100644 README.md

注意，它内部使用 git 命令。

gitmoji update

根据提供的 API URL 更新 gitmojis 列表。

❯ gitmoji update
🎨    :art:   Improve structure / format of the code.
⚡️    :zap:    Improve performance.
🔥    :fire:    Remove code or files.
🐛    :bug:    Fix a bug.
🚑️    :ambulance:    Critical hotfix.
✨    :sparkles:    Introduce new features.
📝    :memo:    Add or update documentation.
🚀    :rocket:    Deploy stuff.
💄    :lipstick:    Add or update the UI and style files.
🎉    :tada:    Begin a project.
...

gitmoji list

列出可用的 gitmojis。

❯ gitmoji list
🎨    :art:    Improve structure / format of the code.
⚡️    :zap:    Improve performance.
🔥    :fire:    Remove code or files.
🐛    :bug:    Fix a bug.
🚑️    :ambulance:    Critical hotfix.
✨    :sparkles:    Introduce new features.
📝    :memo:    Add or update documentation.
🚀    :rocket:    Deploy stuff.
💄    :lipstick:    Add or update the UI and style files.
🎉    :tada:    Begin a project.
...

gitmoji search

搜索 gitmoji

❯ gitmoji search bug
🐛    :bug:    Fix a bug.
🏗️    :building_construction:    Make architectural changes.
👔    :necktie:    Add or update business logic

缺少的功能

由于一个错误，我们目前还不能将其用作 git 钩。

见 问题 #1，欢迎提供帮助

许可证

此操作在 MIT 许可证的条款下分发，有关详细信息，请参阅 LICENSE。

贡献和支持

欢迎任何贡献！