convmoji

A simple cli tool to commit Conventional Commits.

Requirements

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:

$ convmoji [OPTIONS] DESCRIPTION [COMMIT_TYPE]

Arguments:

• DESCRIPTION: Commit message, as in 'git commit -m "..."' [required]
• [COMMIT_TYPE]: Either of [feat, fix, docs, style, refactor, perf, test, build, ci, chore] [default: feat]

Options:

• -s, --scope TEXT: Scope for commit (any string) [default: ]
• -b, --body TEXT: Body message for commit [default: ]
• -f, --foot TEXT: Footer message (formatted two blank lines below body) [default: ]
• --breaking-changes, --bc TEXT: Specially formatted message to show changes might break previous versions [default: ]
• --amend: Execute commit with --amend [default: False]
• --no-verify: Execute commit with --no-verify [default: False]
• --co-authored_by, --co TEXT: A string of authors formatted like: --co-authored-by ' ' --co-authored-by ' '
• --debug: Debug mode (does not execute commit) [default: False]
• --info: Prompt convmoji info (does not execute commit)
• --version: Prompt convmoji version (does not execute commit)
• --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.