Report Bug · Request Feature

😳 Tool for gitmoji commits linked to an issues

This is a fork 🍴 of seatonjiang's gitmoji-vscode

💻 Screenshot

📦 Install

1. Open Visual Studio Code.
2. Press Ctrl+Shift+X to open the Extensions tab.
3. Type gitmoji-linked-commits to find the extension.
4. Click the Install button, then the Enable button.

🔨 Configuration

Configure branch task pattern

• branchTaskPattern - Configure regexp pattern to extract task id from branch name. Default is [a-zA-Z]+/(\d+)-.* in UI and "[a-zA-Z]+/(\\d+)-.*" in JSON.

Sample configuration:

• Redmine (extracts 12345 from branch in format feat/12345-some-feature)

{
    "gitmoji-linked-commits.branchTaskPattern": "[a-zA-Z]+/(\\d+)-.*"
}

• Clickup (extracts CU-ASDASD from branch in format feat/CU-ASDASD-some-feature)

{
    "gitmoji-linked-commits.branchTaskPattern": "[a-zA-Z]+/(CU-\\w+)-.*"
}

❕ When you're setting branch task pattern in settings UI, instead of setting it directly in JSON, you don't need to escape back slash char with \ and [a-zA-Z]+/(CU-\w+)-.* is perfectly valid pattern then.

Configure task prefix

• descriptionTaskPrefix - Configure prefix of task id in commit description. Default is "#".

Sample configuration:

{
    "gitmoji-linked-commits.descriptionTaskPrefix": ""
}

Select output type

• outputType - Configure the type of emoji output as needed. Default is emoji

Sample configuration:

{
    "gitmoji-linked-commits.outputType": "emoji"
}

Notice: If you use Gitlab, type emoji, if you use Github, you can type code or emoji.

Add configurable additionnal emojis

• additionalEmojis - Add configurable additionnal emojis.

Sample configuration:

{
    "gitmoji-linked-commits.additionalEmojis": [
        {
            "emoji": "🐛",
            "code": ":bug:",
            "description": "Fix a bug."
        },
        {
            "emoji": "🚑",
            "code": ":ambulance:",
            "description": "Critical hotfix."
        }
    ]
}

Only use your additionnal emojis

• onlyUseAdditionalEmojis - Use your additional emojis instead the ones from the extension.

Sample configuration:

{
    "gitmoji-linked-commits.onlyUseAdditionalEmojis": true
}

Search gitmoji by emoji code

• showEmojiCode - Enable searching gitmojis by emoji code (example: ambulance will return hotfix).

Sample configuration:

{
    "gitmoji-linked-commits.showEmojiCode": true
}

🤝 Contributing

We welcome all contributions. You can submit any ideas as pull requests or as issues, have a good time! :)

📃 License

The project is released under the MIT License, see the LICENCE file for details.