🖋 inkan

Use this CLI to help format your git commit messages consistently with less effort via pre-provided templates! 🤩

There are two default templates provided:

1. Simple Commit Template

2. Conventional Commit Template

You can also create your own Custom Templates by following the Custom Template Guide.

Simple Commit Template

inkan config set default

-  ✨ feat        Adds new functionality.
-  🐛 bug         Fix that resolves an unintended issue.
-  🧪 test        Improves or adds existing tests related to the code base.
-  🧹 refactor    Improvement of code/structure without adding new functionality.
- 📖 docs         Change or update to documentation (i.e README's, code comments, etc).
-  📦 deps        Version update or migration to a new dependency.
-  ⚠️ break        Breaking change that may break a downstream application or service.
-  📋 chore       Regular code maintenance.
-  🏭 ci          Changes to CI configuration files and scripts.

Example Commit format:

• [{ticket_num}] ❓ {message}

Template Context:

• ticket_num ticket / issue number related to the branch.
• message commit message.

Conventional Commit Standard Templates

inkan config set conventional

- ✨ feat        Adds new functionality.
- ⛑ fix         Fix that resolves an unintended issue (i.e. bug).
- 🧪 test        Improves or adds existing tests related to the code base.
- 🧹 refactor    Improvement of code/structure without adding new functionality.
- 📖 docs        Change or update to documentation (i.e README's, code comments, etc).
- 🔨 build       Changes that affect the build system or external dependencies.
- 📋 chore       Regular code maintenance.
- 🏭 ci          Changes to CI configuration files and scripts.
- 🏎 perf        Improvement of code performance (i.e. speed, memory, etc).
- 🕺 style       Formatting updates, lint fixes, etc. (i.e. missing semi colons).

Commit format:

• {type}({scope}): {message}

Template commit context:

• ticket_num ticket / issuer number related to the branch.
• message subject message.
• scope Short description of a section of the codebase the commit relates to.

⏳ Install Binary

cargo install inkan

curl -sS https://raw.githubusercontent.com/xsv24/inkan/main/scripts/install.sh | sh

curl -sS https://raw.githubusercontent.com/xsv24/inkan/main/scripts/install.sh | sudo sh -s - -b /usr/local/bin

curl -sS https://raw.githubusercontent.com/xsv24/inkan/main/scripts/install.sh | sh

🏎️💨 Getting Started

inkan --help

# Checkout a new branch & add optional context params.
inkan checkout fix-parser
  --ticket TICKET-123 \
  --scope parser \
  --link "http://ticket-manager/TICKET-123"

# Select a registered config containing templates to use.
inkan config set

# View currently available templates on chosen config.
inkan templates

# Commit some changes.
inkan commit bug -m "Fix up parser"
inkan commit chore

🎟️ Checkout command

Creates a new branch or checks out an existing branch attaching the following optional context parameters for use in future commit templates.

• ticket_num Issue number related to the branch.
• link Link to to the related issue.
• scope Short description of a section of the codebase the commit relates to.

When it's time to commit your changes any provided context params (i.e.ticket_number) will be injected into each commit message for you automatically! 😄 It does this by a simple template string injection.

Examples:

inkan checkout my-branch --ticket TICKET-123

inkan checkout my-branch \
  -t TICKET-123 \
  --scope parser \
  --link "http://ticket-manager/TICKET-123"

Most likely your ticket / issue will only have one branch associated to it. In this case you can use the following shorthand 👌

inkan checkout TICKET-123

The checkout command also makes use of a simple customizable template which can be configured within a template config that defaults to the following format.

branch:
  content: {branch_name}-{ticket_num}

🔗 Context command

Create or update context params linked to the current checked out branch.

• ticket_num Issue number related to the branch.
• link Link to to the related issue.
• scope Short description of a section of the codebase the commit relates to.

This is handy if you forgot to add context via the inkan checkout command or if you want to update the context for future commits.

When it's time to commit your changes any provided context params (i.e.ticket_number) will be injected into each commit message for you automatically! 😄 It does this by a simple template string injection.

inkan context \
  --ticket TICKET-123 \
  --scope parser \
  --link "http://ticket-manager/TICKET-123"

🚀 Commit command

Commits any staged changes and builds an editable commit message by injecting any context set parameters from the checkout or context commands into a chosen template (i.e. bug).

inkan commit bug

Example template:

[{ticket_num}] 🐛 {message} → [TICKET-123] 🐛 Fix

☑ Templates command

Lists currently available commit templates. To add your own, refer to the Custom Commit Template guide.

inkan templates

- bug | Fix that resolves an unintended issue
- ...

⚙️ Configuration

The default template will be set as active initially but you can switch between the provided configurations and any added custom templates via the config set command.

inkan config set

ℹ️ It's not recommend to alter the default template files as they could be replaced / updated on new releases.

Instead, copy & paste the desired default template, save it somewhere, and add it to the CLI as shown in the persist configuration guide.

Custom templates

Creating your own templates can be done simply by creating your own configuration file .inkan.yml.

Here's an example of a custom template called custom

version: 1
commit:
  templates:
    custom:
      description: My custom commit template 🎸
      content: |
        {ticket_num} 🤘 {message}

Your custom configuration / templates can be provided to the CLI in one of the following ways:

• Provide a config file path via --config option.
• Create a .inkan.yml config file within your git repositories root directory.
• Use a config file previously added / linked via config add subcommand as highlighted in the persist configuration guide.

Persist Configuration

Persisting / linking your own config file can be done by providing the file path to your config file and a reference name.

inkan config add $CONFIG_NAME $CONFIG_PATH

You can add multiple config files and switch between them via set command.

inkan config set $CONFIG_NAME

or

# Select prompt for available configurations
inkan config set 

> ? Configuration:  
  ➜ default
    conventional
    custom

To ensure your template has been loaded simply run the command below 👇 to see a list of the currently configured templates.

inkan templates

- custom | My custom commit template 🎸
- ...

Then when your ready to commit your changes use your custom template and your done! 🪂

inkan commit custom \
 --ticket TICKET-123 \
 --message "Dang!"

[TICKET-123] 🤘 Dang!

TODO

• Prompts for commit message, link and so forth
• [] Clean up configuration templates
• [] PR template with checkbox automation
• [] Shell completion scripts
• [] Prompts for other commands