A simple cli tool to commit Conventional Commits with emojis.
Project description
convmoji
A simple cli tool to commit Conventional Commits.
Install
pip install convmoji
convmoji --help
Examples
A conventianal commit
convmoji "epic feature added" feat
One with a scope
convmoji "epic feature added" feat --scope somescope
# ✨: epic feature added
With some options
convmoji "epic feature added" feat --scope somescope --amend --no-verify
# ✨(somescope): epic feature added --amend --no-verify
With more textual information
convmoji "epic feature added" feat --scope somescope \
--body "more body information" --foot "more footer information"
# ✨(somescope): epic feature added
#
# more body information
#
# more footer information
Inform people about breaking changes
convmoji "epic feature added" feat --scope somescope \
--body "more body information" --footer "more footer information" \
--breaking-changes "breaks somthing"
# ✨‼️(somescope): epic feature added
#
# more body information
#
# BREAKING CHANGE: breaks somthing
# more footer information
If you want to see what to does without performing the action, run it with
--debug
Commit types
For details on commit types see conventional commits specification.
feat
: ✨fix
: 🐛docs
: 📚style
: 💎refactor
: 🔨perf
: 🚀test
: 🚨build
: 📦ci
: 👷chore
: 🔧
convmoji --help
Usage:
$ [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
Commands:
commit
info
commit
Usage:
$ commit [OPTIONS] DESCRIPTION COMMIT_TYPE [SCOPE] [BODY] [FOOTER]
Arguments:
DESCRIPTION
: Commit message, as in 'git commit -m "..."' [required]COMMIT_TYPE
: Either of [feat, fix, docs, style, refactor, perf, test, build, ci, chore] [required][SCOPE]
: Scope for commit (any string) [default: ][BODY]
: Body message for commit [default: ][FOOTER]
: Footer message (formatted two blank lines below body) [default: ]
Options:
--breaking-changes TEXT
: Specially formatted message to show changes might break previous versions [default: ]-a, --amend
: Execute commit with --amend [default: False]--no-verify, --nv
: Execute commit with --no-verify [default: False]--co-authored_by, --co TEXT
: A string of authors formatted like: --co-authored-by '<User user@no-reply> ' --co-authored-by '<User2 user2@no-reply>'--debug / --no-debug
: [default: False]--help
: Show this message and exit.
info
Usage:
$ info [OPTIONS]
Options:
--help
: Show this message and exit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
convmoji-0.1.2.tar.gz
(5.7 kB
view hashes)