A simple cli tool to commit Conventional Commits

Last update: Jul 04, 2022

Overview

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.

A simple Python CLI tool that draws routes/paths on a given map.

Map Router A simple Python CLI tool that draws routes/paths on a given map. Index Installation Usage Docs Why? License Support Installation Coming soo

1 Nov 7, 2021

Hack-All is a simple CLI tool that helps ethical-hackers to make a reverse connection without knowing the target device in use is it computer or phone

Hack-All is a simple CLI tool that helps ethical-hackers to make a reverse connection without knowing the target device in use is it computer

5 Nov 22, 2022

A Simple Python CLI Lockpicking Tool

Cryptex a simple CLI lockpicking tool What can it do: Encode / Decode Hex Encode / Decode Base64 Break Randomly :D Requirements: Python3 Linux as your

23 Jul 4, 2022

Proman is a simple tool for managing projects through cli.

proman proman is a project manager. It helps you manage your projects from a terminal. The features are listed below. Installation Step 1: Download or

2 Dec 6, 2021

A simple CLI tool for getting region-specific status of Logz.io components.

About A simple CLI tool for checking the current status of Logz.io components per region. Built With Python 3 The following packeges (see requirements

1 Dec 11, 2021

A simple and easy-to-use CLI parse tool.

1 Mar 4, 2022

Notion-cli-list-manager - A simple command-line tool for managing Notion databases

A simple command-line tool for managing Notion List databases. ✨

75 Dec 4, 2022

A simple CLI tool for converting logs from Poker Now games to other formats

🂡 Poker Now Log Converter 🂡 A command line utility for converting logs from Poker Now games to other formats. Introduction Poker Now is a free onlin

6 Dec 23, 2022

Ssl-tool - A simple interactive CLI wrapper around openssl to make creation and installation of self-signed certs easy

What's this? A simple interactive CLI wrapper around openssl to make self-signin

9 May 17, 2022

Comments

error handling

Return a proper error code for unknown conv-tags (emoji is not mappable when using wrong tag)

Since 0.1.7 also:

? Your commit message (required)                                                                                      

Cancelled by user

Traceback (most recent call last):
  File "/usr/local/bin/convmoji", line 8, in <module>
    sys.exit(app())
  File "/usr/local/lib/python3.10/site-packages/typer/main.py", line 214, in __call__
    return get_command(self)(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1128, in __call__
    return self.main(*args, **kwargs)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1052, in main
    with self.make_context(prog_name, args, **extra) as ctx:
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 914, in make_context
    self.parse_args(ctx, args)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 1370, in parse_args
    value, args = param.handle_parse_result(ctx, opts, args)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 2347, in handle_parse_result
    value = self.process_value(ctx, value)
  File "/usr/local/lib/python3.10/site-packages/click/core.py", line 2309, in process_value
    value = self.callback(ctx, self, value)
  File "/usr/local/lib/python3.10/site-packages/typer/main.py", line 802, in wrapper
    return callback(**use_params)  # type: ignore
  File "/usr/local/lib/python3.10/site-packages/convmoji/commit.py", line 136, in interactive_mode
    answers["type"] = answers["type"].split(":")[0]
KeyError: 'type'

enhancement

opened by arrrrrmin 1

Releases(v0.1.7)

v0.1.7(Mar 18, 2022)

✨(interactive-mode): Interactive mode with -i

-i will cause convmoji to ask questions using 'questionary'

convmoji -i
? Your commit message (required) hello
? Choose a type (default is '✨:feat') (Use arrow keys)
   ✨:feat
   🐛:fix
   📚:docs
   💎:style
   🔨:refactor
   🚀:perf
 » 🚨:test
   📦:build
   👷:ci
   🔧:chore
...

Full Changelog: https://github.com/KnowKit/convmoji/compare/v0.1.6...v0.1.7

Source code(tar.gz)
Source code(zip)

v0.1.6(Mar 12, 2022)
Adds an option --show-scopes to show scopes used in previouse commits.

Full Changelog: https://github.com/KnowKit/convmoji/compare/v0.1.5...v0.1.6
Source code(tar.gz)
Source code(zip)
v0.1.5(Feb 24, 2022)
What's Changed

✨: add new option print by @defel in https://github.com/KnowKit/convmoji/pull/3

New Contributors

@defel made their first contribution in https://github.com/KnowKit/convmoji/pull/3

Full Changelog: https://github.com/KnowKit/convmoji/compare/v0.1.4...v0.1.5
Source code(tar.gz)
Source code(zip)

Owner

GitHub Repository

Redial is a simple shell application that manages your SSH sessions on Unix terminal.

redial redial is a simple shell application that manages your SSH sessions on Unix terminal. What's New 0.7 (19.12.2019) Basic support for adding ssh

186 Oct 28, 2022

gcp-doctor - Diagnostics for Google Cloud Platform

gcp-doctor is a command-line diagnostics tool for GCP customers. It finds and helps to fix common issues in Google Cloud Platform projects. It is used to test projects against a wide range of best-pr

185 Dec 20, 2022

dotfilery, configuration, environment settings, automation, etc.

┌┬┐┌─┐┌─┐┌─┐┬ ┬┌┬┐┬ ┬┬┌─┐ │││├┤ │ ┬├─┤│ │ │ ├─┤││ :: bits & bobs, dots & things. ┴ ┴└─┘└─┘┴ ┴┴─┘┴ ┴ ┴ ┴┴└─┘ @megalithic 🚀 Instal

89 Dec 25, 2022

pypinfo is a simple CLI to access PyPI download statistics via Google's BigQuery.

pypinfo: View PyPI download statistics with ease. pypinfo is a simple CLI to access PyPI download statistics via Google's BigQuery. Installation pypin

351 Dec 26, 2022

Container images for portable development environments

Docker Dev Spin up a container to develop from anywhere! To run, just: docker run -ti aghost7/nodejs-dev:boron tmux new Alternatively, if on Linux: p

163 Dec 22, 2022

Customisable pharmacokinetic model accessible via bash CLI allowing for variable dose calculations as well as intravenous and subcutaneous administration calculations

Pharmacokinetic Modelling Group Project A PharmacoKinetic (PK) modelling function for analysis of injected solute dynamics over time, developed by Gro

1 Oct 24, 2021

🕰 The command line tool for scheduling Python scripts

hickory is a simple command line tool for scheduling Python scripts.

146 Dec 07, 2022

A simple CLI based any Download Tool, that find files and let you stream or download thorugh WebTorrent CLI or Aria or any command tool

Privateer A simple CLI based any Download Tool, that find files and let you stream or download thorugh WebTorrent CLI or Aria or any command tool How

2 Apr 04, 2022

A simple cli tool to commit Conventional Commits

Related tags

Overview

convmoji

Requirements

Install

Examples

Commit types

convmoji --help

You might also like...

A simple Python CLI tool that draws routes/paths on a given map.

Hack-All is a simple CLI tool that helps ethical-hackers to make a reverse connection without knowing the target device in use is it computer or phone

A Simple Python CLI Lockpicking Tool

Proman is a simple tool for managing projects through cli.

A simple CLI tool for getting region-specific status of Logz.io components.

A simple and easy-to-use CLI parse tool.

Notion-cli-list-manager - A simple command-line tool for managing Notion databases

A simple CLI tool for converting logs from Poker Now games to other formats

Ssl-tool - A simple interactive CLI wrapper around openssl to make creation and installation of self-signed certs easy

Comments

error handling

Releases(v0.1.7)

v0.1.7(Mar 18, 2022)

✨(interactive-mode): Interactive mode with -i

v0.1.6(Mar 12, 2022)

v0.1.5(Feb 24, 2022)

What's Changed

New Contributors

Owner

Redial is a simple shell application that manages your SSH sessions on Unix terminal.

gcp-doctor - Diagnostics for Google Cloud Platform

dotfilery, configuration, environment settings, automation, etc.

pypinfo is a simple CLI to access PyPI download statistics via Google's BigQuery.

Container images for portable development environments

Customisable pharmacokinetic model accessible via bash CLI allowing for variable dose calculations as well as intravenous and subcutaneous administration calculations

🕰 The command line tool for scheduling Python scripts

A simple CLI based any Download Tool, that find files and let you stream or download thorugh WebTorrent CLI or Aria or any command tool

CPOST is a CLI tool to assist with the proper sizing of Clara Deploy pipelines

A project designed to make taking notes easier than ever - by doing it all on command line

Python library & console tool for controlling Xiaomi smart appliances

Command-line tool for looking up colors and palettes.

Booky - A command line utility for bookmarking files on your terminal!

Wik is use to get information about anything on the shell using Wikipedia.

Command-line interface to PyPI Stats API to get download stats for Python packages

🐍 Python CLI tool to get public information from a GitHub account

Dart Version Manager CLI implemented with Python and Typer.

Python3 library for multimedia functions at the command terminal

A command line tool that creates a super timeline from SentinelOne's Deep Visibility data

Chopper: An Automated Security Headers Analyzer