Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/MichaelCurrin/auto-commit-msg
A VS Code extension to generate a smart commit message based on file changes
https://github.com/MichaelCurrin/auto-commit-msg
auto automation commit commit-message commit-message-formatter generate git-commit git-commit-messages nodejs typescript vscode vscode-extension
Last synced: 3 months ago
JSON representation
A VS Code extension to generate a smart commit message based on file changes
- Host: GitHub
- URL: https://github.com/MichaelCurrin/auto-commit-msg
- Owner: MichaelCurrin
- License: mit
- Created: 2020-06-07T20:22:38.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T10:00:28.000Z (6 months ago)
- Last Synced: 2024-10-12T19:36:38.460Z (4 months ago)
- Topics: auto, automation, commit, commit-message, commit-message-formatter, generate, git-commit, git-commit-messages, nodejs, typescript, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://marketplace.visualstudio.com/items?itemName=MichaelCurrin.auto-commit-msg
- Size: 1.71 MB
- Stars: 128
- Watchers: 5
- Forks: 13
- Open Issues: 56
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Auto Commit Message ⚙️ 🧙♂️ ✉️
> A VS Code extension to generate a smart commit message based on file changes[](https://github.com/MichaelCurrin/auto-commit-msg/actions?query=workflow:"Node+CI")
[](https://github.com/MichaelCurrin/auto-commit-msg/actions?query=workflow%3ACodeQL)
[](#license "Go to License section")
[](/CONTRIBUTING.md "View contributing doc")



## Preview
Starting from an empty commit message, the extension created a recommended message and populated it inside the Git pane of VS Code:
![]()
## Getting started
How to install and run the extension in VS Code.
[](/docs/quickstart.md)
## 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, which you can use or edit.
- It can describe a variety of changes - when a file is added, removed, moved, renamed, etc.
- Can handle multiple files at once.
- 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](/docs/features.md) 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.
With the explosion of AI tools, you can find alternatives to this extension which use AI - see [AI tools](/docs/other/ai-tools.md)
## 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:
![]()
## Documentation
Guides for installing and using the pre-built extension and for developers to build from source code.
[](/docs/)
## Contributing
See the [Contributing](/CONTRIBUTING.md) guide.
## License
Released under [MIT](/LICENSE) by [@MichaelCurrin](https://github.com/MichaelCurrin).
See the [Credit](/docs/other/credit.md) doc for more info.