omni-commit-tool v1.2.0

Omni commit tool

Creating a commit made easy.

Section Links

• Install
• Uninstall
• Usage
  • Commit Steps
  • Options
  • Setting

Install

npm i -g omni-commit-tool

Uninstall

npm i -g omni-commit-tool

Usage

oc

Use oc to replace git commit -m for the commit message

Omni commit tool will generate commit in the following format:

[Jira issue] type (category): message

// example
[OCPD-1260] 💡 feat(test): commit test

You can ignore the Jira issue and category to generate a simple commit:

type: message

// example
💡 feat: commit test

Commit Steps

1. Choose the desired commit type

2. Enter your commit message

3. Decide whether to tag a Jira issue

   3.1 If choosing yes, input the Jira issue number.

4. Enter the commit category if applicable

5. Your commit is now complete

Options

      --version  Show version number
  -b, --blank    Create blank commit
  -r, --revert   Create revert commit
  -s, --setting  Set config
  -c, --config   Show config path
  -t, --types    Show commit type list path
      --help     Show help

Setting

To access the setting panel, use the following command:

oc --setting

Use emoji

Control emoji is prepended on the commit message

Set Jira prefix

Change Jira prefix on tag Jira issues

Set Jira format

Change Jira format on tag Jira issues, {{prefix}} and {{issueId}} is required

Config path

You can find the config path by running oc --config and use an editor to edit it

Commit types path

You can find the config path by running oc --types and use an editor to edit it

Default list

Inspired by cz-cli and OwlTing/cz