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

Microsoft Azure CLI - Azure Command-Line Interface

A great cloud needs great tools; we're excited to introduce Azure CLI, our next generation multi-platform command line experience for Azure.

3.4k Dec 30, 2022

Zecwallet-Python is a simple wrapper around the Zecwallet Command Line LightClient written in Python

A wrapper around Zecwallet Command Line LightClient, written in Python Table of Contents About Installation Usage Examples About Zecw

2 Sep 06, 2022

This is an app for creating your own color scheme for Termux!

Termux Terminal Theme Creator [WIP] If you need help on how to use the program, you can either create a GitHub issue or join this temporary Discord se

3 Dec 31, 2022

A Hikari command handler for people who love ducks.

duckari A Hikari command handler made with love by ducks. Currently Duckari is work in progress. Documentation is WIP. The wiki is no longer used as d

2 Oct 09, 2022

Simple command line tool to train and deploy your machine learning models with AWS SageMaker

metamaker Simple command line tool to train and deploy your machine learning models with AWS SageMaker Features metamaker enables you to: Build a dock

5 Jan 09, 2022

An interactive cheatsheet tool for the command-line

navi An interactive cheatsheet tool for the command-line. navi allows you to browse through cheatsheets (that you may write yourself or download from

12.2k Dec 31, 2022

cmdpxl: a totally practical command-line image editor

476 Jan 07, 2023

Bear-Shell is a shell based in the terminal or command prompt.

Bear-Shell is a shell based in the terminal or command prompt. You can navigate files, run python files, create files via the BearUtils text editor, and a lot more coming up!

6 Dec 25, 2021

Python3 command-line tool for the inference of Boolean rules and pathway analysis on omics data

BONITA-Python3 BONITA was originally written in Python 2 and tested with Python 2-compatible packages. This version of the packages ports BONITA to Py

1 Dec 22, 2021

Use case: quick JSON processing/restructuring with jq without terminal

alfred-jq Alfred workflow to conveniently process JQ on clipboard based on a jq query Also available at: packal/jq Use case: quick JSON processing/res

5 Sep 30, 2022

A library for creating text-based graphs in the terminal

tplot is a Python package for creating text-based graphs. Useful for visualizing data to the terminal or log files.

164 Dec 14, 2022

A minimal todo list for your terminal.

todo A minimal todo list for your terminal. Installation Run the following command. pip install git+https://github.com/piero-vic/todo.git Usage todo

7 Aug 08, 2022

lazy_table - a python-tabulate wrapper for producing tables from generators

A python-tabulate wrapper for producing tables from generators. Motivation lazy_table is useful when (i) each row of your table is generated by a poss

52 Nov 12, 2022

Todo list console based application. Todo's save to a seperate file.

1 Dec 24, 2021

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

S1SuperTimeline A command line tool that creates a super timeline from SentinelOne's Deep Visibility data What does it do? The script accepts a S1QL q

2 Feb 08, 2022

This is a repository for collecting global custom management extensions for the Django Framework.

Django Extensions Django Extensions is a collection of custom extensions for the Django Framework. Getting Started The easiest way to figure out what

6k Jan 03, 2023

A simple CLI productivity tool to quickly display the syntax of a desired piece of code

Iforgor Iforgor is a customisable and easy to use command line tool to manage code samples. It's a good way to quickly get your hand on syntax you don

21 Jan 03, 2023

AthenaCLI is a CLI tool for AWS Athena service that can do auto-completion and syntax highlighting.

Introduction AthenaCLI is a command line interface (CLI) for the Athena service that can do auto-completion and syntax highlighting, and is a proud me

192 Jan 07, 2023

A simple command line tool for changing the icons of folders or files on MacOS.

Mac OS File Icon Changer Description A small and simple script to quickly change large amounts or a few files and folders icons to easily customize th

3 Jan 02, 2023

A startpage configured aesthetically with terminal-esque link formatting

Terminal-y Startpage Setup Clone the repository, then make an unformatted.txt file following the specifications in example.txt. Run format.py Open ind

13 May 01, 2022