Auto Commit Message ⚙️ 🧙‍♂️ ✉️

A VS Code extension that writes commit messages for you

Getting started | Features | Sample screenshots | Docs

Preview

Getting started

This guide shows you how to download a pre-built extension from GitHub Releases and then install it in VS Code (you can't find it on the extension marketplace yet).

Release disclaimer

• This application is still in pre-release stage.
• But... it is still functional and I use it daily, so please use it too if you want.
• There are just some finishing touches still, like making a new logo, releasing the package on the marketplace (so you can install it without downloading from releases page) and cleaning up the docs. It can become version 1.0.0 around then.
• There are also a bunch of issues I want to work through to extend functionality to make the extension smarter.

Features

See more info on the Features page in the docs.

• Simmply click the extension button in the Git pane.
• Reads the state of files in your Git repo or staged files
• Generates a commit message, which you can use or edit
• Describes a variety of changes - when file is added, removed, moved, renamed...
• Handles multiple files at once.
• Infers a Conventional Commit category where possible - e.g. feat, ci, build.
• Suitable for development in a variety of languages and tools - it can recognize a range of files based on path and extension, such as related to CI, configs, dependency or docs.

Sample usage

Here are some screenshots of what messages the extension generates, based on changed files.

If you created a new file and staged it.

If you updated a build-related file.

If updated a file in docs/ or a README.md anywhere.

If you renamed a file.

About

A VS Code extension which gives you smart commit message suggestions. For the times where all your need it a simple message.

It looks at the path of a file that changed and how it changed, then pushes the commit message to the Git pane in VS Code. You can edit or erase the message if you don't like.

It can make a message to describe a change for a single file to be committed. Including create, update, remove, rename and move - along with the filename. Or, the path, like for a move. See the tests.

It many cases it can also provide an appropriate conventional commit prefix label for you. It can't separate features and bug fixes but it can identify changes to docs, CI files and config files.

Don't use this tool all the time - remember to write explanatory messages when it matters.

Documentation

License

Released under MIT by @MichaelCurrin.

See Credit section the docs for more info.