GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — GitHub - MichaelCurrin/auto-commit-msg: A VS Code extension to generate a smart commit message based on file changes

BranchesTags
Open more actions menu

Latest commit

 

History

1,524 Commits
1,524 Commits

Folders and files

NameName
Last commit message
Last commit date
.github/workflows
.github/workflows
 
 
.vscode
.vscode
 
 
bin
bin
 
 
docs
docs
 
 
hooks
hooks
 
 
images
images
 
 
shell
shell
 
 
src
src
 
 
.editorconfig
.editorconfig
 
 
.eslintrc.cjs
.eslintrc.cjs
 
 
.gitignore
.gitignore
 
 
.nvmrc
.nvmrc
 
 
.prettierrc.json
.prettierrc.json
 
 
.vscodeignore
.vscodeignore
 
 
CONTRIBUTING.md
CONTRIBUTING.md
 
 
LICENSE
LICENSE
 
 
Makefile
Makefile
 
 
README.md
README.md
 
 
package-lock.json
package-lock.json
 
 
package.json
package.json
 
 
tsconfig.json
tsconfig.json
 
 
tslint.json
tslint.json
 
 

Repository files navigation

Auto Commit Message ⚙️ 🧙‍♂️ ✉️

A VS Code extension and CLI tool to generate a smart commit message based on file changes (without AI)

Made with JavaScript Node CI CodeQL License Contributions - welcome maintained - yes

Logo

Getting started | Features | Screenshots | Documentation

Preview

Starting from an empty commit message, the extension created a recommended message and populated it inside the Git pane of VS Code:

sample screenshot of chore

Getting started

How to install and run the extension in VS Code.

docs - Getting started

Install the CLI tool quick and easy so you are not tied to the IDE - see CLI docs.

Features

Just click the extension's one button in the Git pane.

This is what the extension can do:

  • Look at any staged changes files, otherwise falls back to all unstaged changes.
  • Generate a commit message (based on rules and templates, no AI). You edit the message before comitting.
    • It can describe a variety of changes - when a file is added, removed, moved, renamed, etc. ,
    • Can handle multiple files at once and count the files.
    • Based on paths and extensions, infers a Conventional Commit prefix type e.g. feat, chore, ci, build, build(deps), docs.

See more info on the Features page in the docs.

Comparison with other extensions

Other extensions usually require some manual input, such as selecting prefix type from a droplist or writing a commit message by hand along with other form parameters.

This extension takes zero parameters. Just click a button.

Why not generate a commit message with AI?

This extension does not use AI. With the explosion of AI tools, you can find alternatives to this extension which use do AI - see notes here under AI tools.

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:

feat

If you updated a build-related file:

build

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

docs

If you renamed a file:

rename

Documentation

Guides for installing and using the pre-built extension and for developers to build from source code.

view - Documentation

Contributing

See the Contributing guide.

License

Released under MIT by @MichaelCurrin.

See the Credit doc for more info.

About

A VS Code extension to generate a smart commit message based on file changes

marketplace.visualstudio.com/items?itemName=MichaelCurrin.auto-commit-msg

Topics

autoautomationcommitcommit-messagecommit-message-formattergenerategit-commitgit-commit-messagesnodejstypescriptvscodevscode-extension

Resources

Readme
MIT license

Contributing

Contributing
Activity

Stars

165 stars

Watchers

3 watching

Forks

15 forks
Report repository

Releases

Used by

Contributors

Languages

You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.