https://github.com/keyweeusr/conventional
A collection of minor modes supporting Conventional syntax.
https://github.com/keyweeusr/conventional
convention conventional conventional-comments conventional-commits elisp emacs emacs-package minor-mode
Last synced: 12 months ago
JSON representation
A collection of minor modes supporting Conventional syntax.
- Host: GitHub
- URL: https://github.com/keyweeusr/conventional
- Owner: KeyWeeUsr
- License: gpl-3.0
- Created: 2025-06-15T23:23:20.000Z (12 months ago)
- Default Branch: master
- Last Pushed: 2025-06-24T06:38:47.000Z (12 months ago)
- Last Synced: 2025-06-24T07:32:23.914Z (12 months ago)
- Topics: convention, conventional, conventional-comments, conventional-commits, elisp, emacs, emacs-package, minor-mode
- Language: Emacs Lisp
- Homepage:
- Size: 64.5 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# conventional
[![Buy me a coffee][bmc-badge]][bmc-link]
[![Liberapay][lp-badge]][lp-link]
[![PayPal][ppl-badge]][ppl-link]
A collection of minor modes supporting Conventional syntax.
Currently available:
* [conventional: comments][comments]
* [Conventional Commits][commits]
## How to
Clone and install manually, then simply:
* `M-x conventional-comments-mode`
* `M-x conventional-commits-mode`
### Enable for commit editing in Emacs
With `EDITOR` environment variable or [git `core.editor`][git-editor] set up
for Emacs a temporary file is available for editors external to `git` for
convenient commit message writing. Normally it's `./.git/COMMIT_EDITMSG` and in
ncombination with `find-file-hook` one can listen for buffer's name and enable
the mode for conventional commits like this:
```emacs-lisp
(add-hook
'find-file-hook
(lambda (&rest _)
(conventional-comments-mode)
(when (string= (file-name-base buffer-file-name) "COMMIT_EDITMSG")
(conventional-commits-mode))))
```
[bmc-badge]: https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee
[bmc-link]: https://www.buymeacoffee.com/peterbadida
[ppl-badge]: https://img.shields.io/badge/-paypal-grey?logo=paypal
[ppl-link]: https://paypal.me/peterbadida
[lp-badge]: https://img.shields.io/badge/-liberapay-grey?logo=liberapay
[lp-link]: https://liberapay.com/keyweeusr
[comments]: https://conventionalcomments.org
[commits]: https://www.conventionalcommits.org
[git-editor]: https://git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_editor