4 releases (stable)
1.0.2 | Jul 25, 2024 |
---|---|
0.2.0 | Jul 24, 2024 |
#78 in Template engine
140 downloads per month
43KB
1K
SLoC
Simple commits
A little CLI written in rust to improve your dirty commits into conventional ones.
👀 Demo (coming soon)
✨ Features
- Fully conventional commits
- Auto-commit
- Custom templates
- Written in rust
📥 Installation (not available yet)
Install it using cargo!
cargo install simple-commits
🛠 Configuration
in your ~/$CONFIG_FOLDER
create a sc
directory with a config.toml
inside.
[!TIP]
mkdir ~/$CONFIG_FOLDER/sc && touch ~/$CONFIG_FOLDER/sc/config.toml
and use this template to configure it as you want.
# The scopes
scopes = ["app", "lib", "docs"]
[git]
# By default the skip preview flag is setted to false because we know
# It's a dangerous action.
skip_preview = true
skip_emoji = true
# Customize your commit template as you want
commit_template = ["git", "commit", "-m", "{{message}}", "&&", "git", "push"]
💻 Usage
To use it you just need to run one command. 😍
sc
or if you prefer to want to use flags:
flags | Description |
---|---|
-p | --skip-preview |
⚠️ Skips the preview step (Dangerous) |
-e | --skip-emoji |
Skips the emoji step |
-c | --commit-template |
Command to run after generate commit message |
--config |
Set the config path |
Dependencies
~7–16MB
~168K SLoC