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

A command line tool to query source code from your current Python env

wxc wxc (pronounced "which") allows you to inspect source code in your Python environment from the command line. It is based on the inspect module fro

13 Nov 08, 2022

A python Ethereum utilities command-line tool.

peth-cli A python Ethereum utilities command-line tool. After wasting the all day trying to install seth and failed, I took another day to write this.

55 Nov 15, 2022

(BionicLambda Universal SHell) A simple shell made in Python. Docs and possible C port incoming.

blush 😳 (BionicLambda Universal SHell) A simple shell made in Python. Docs and possible C port incoming. Note: The Linux executables were made on Ubu

3 Jun 30, 2021

CLI para o projeto Compilado (Newsletter e Podcast do Código Fonte TV)

Compilado CLI Automatização de tarefas através de linha de comando para a geração de assets para episódios do Compilado, a newsletter e podcast do can

18 Nov 21, 2022

A simple cli tool to commit Conventional Commits

convmoji A simple cli tool to commit Conventional Commits. Requirements Install pip install convmoji convmoji --help Examples A conventianal commit co

3 Jul 04, 2022

Generate folder trees directly from the terminal.

Dir Tree Artist 🎨 🌲 Intro Easily view folder structure, with parameters to sieve out what you want. Choose to exclude files from being viewed (.git,

0 May 17, 2022

Open a file in your locally running Visual Studio Code instance from arbitrary terminal connections.

code-connect Open a file in your locally running Visual Studio Code instance from arbitrary terminal connections. Motivation VS Code supports opening

56 Nov 19, 2022

Python3 library for multimedia functions at the command terminal

TERMINEDIA This is a Python library allowing using a text-terminal as a low-resolution graphics output, along with keyboard realtime reading, and a co

89 Dec 17, 2022

img-proof (IPA) provides a command line utility to test images in the Public Cloud

overview img-proof (IPA) provides a command line utility to test images in the Public Cloud (AWS, Azure, GCE, etc.). With img-proof you can now test c

13 Jan 07, 2022

Phishing-Detective is a command line application for Windows 10 built to detect a phishing site from two url's

Phishing-Detective Phishing-Detective is a command line application for Windows 10 built to detect a phishing site from two url's How it works A simpl

2 Jun 23, 2022

Juniper Command System is a Micro CLI Tool that allows you to manage your files, launch applications, as well as providing extra tools for OS Management.

1 Feb 02, 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

A command line tool to query source code from your current Python env

A python Ethereum utilities command-line tool.

(BionicLambda Universal SHell) A simple shell made in Python. Docs and possible C port incoming.

CLI para o projeto Compilado (Newsletter e Podcast do Código Fonte TV)

A simple cli tool to commit Conventional Commits

Generate folder trees directly from the terminal.

Open a file in your locally running Visual Studio Code instance from arbitrary terminal connections.

Python3 library for multimedia functions at the command terminal

img-proof (IPA) provides a command line utility to test images in the Public Cloud

Phishing-Detective is a command line application for Windows 10 built to detect a phishing site from two url's

Juniper Command System is a Micro CLI Tool that allows you to manage your files, launch applications, as well as providing extra tools for OS Management.

Wordle-solver - A tool that helps people who struggle with vocabulary to enjoy the famous game of WORDLE

Analysis of a daily word game "Wordle"

Interact with Replit remotely with the Replit CLI

A Multipurpose bot with many Commands made using Pycord

Conditional Transformer Language Model for Controllable Generation

Command Line Based Todo Script

Pyrdle - Play Wordle in the CLI. Write an algorithm to play Wordle for you. Ruin all of the fun you've been having

A simple note taker CLI program written in python

CLI helper to install Github releases on your system.