Build
codecov
code style: black
PyPI version

convmoji

A simple cli tool to commit Conventional Commits.

Install

pip install convmoji
convmoji --help

Usage

convmoji --help

Usage: convmoji [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
  -a, --amend                     Execute commit with --amend
  --no-verify, --nv               Execute commit with --no-verify
  --co-authored_by, --co TEXT     A string of authors formatted like:
                                  --co-authored-by '<User [email protected]> '
                                  --co-authored-by '<User2 [email protected]>'
  --debug / --no-debug            [default: no-debug]
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.
  --help                          Show this message and exit.

Examples

A conventianal commit

convmoji "epic feature added" feat

One with a scope

convmoji "epic feature added" feat somescope
# ✨: epic feature added

With some options

convmoji "epic feature added" feat somescope --amend --no-verify
# ✨(somescope): epic feature added --amend --no-verify

With more textual information

convmoji "epic feature added" feat somescope \
  "more body information" "more footer information"
# ✨(somescope): epic feature added
# 
# more body information
# 
# more footer information

Inform people about breaking changes

convmoji "epic feature added" feat somescope \ 
  "more body information" "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: ?

GitHub

https://github.com/KnowKit/convmoji