https://github.com/alejandrosuero/commitizen.nvim

Neovim plugin that emulates commitizen CLI tool to keep those commits following the conventional commit rules
https://github.com/alejandrosuero/commitizen.nvim

Last synced: 2 months ago
JSON representation

Neovim plugin that emulates commitizen CLI tool to keep those commits following the conventional commit rules

• Host: GitHub
• URL: https://github.com/alejandrosuero/commitizen.nvim
• Owner: AlejandroSuero
• License: mit
• Created: 2024-06-16T20:14:09.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-06-18T10:36:24.000Z (6 months ago)
• Last Synced: 2024-06-18T20:26:17.747Z (6 months ago)
• Language: Lua
• Size: 19.5 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

# commitizen.nvim

This Neovim plugin allows you to emulate the [commitizen](https://github.com/commitizen-tools/commitizen) CLI tool for commit messages.



> [!WARNING]

>

> This plugin requires Neovim v0.9.0 or higher.

## TODO

- [ ] Create UI to create a commit message.

  - [x] Select type of change (`feat:`, `fix:`, `docs:`, etc.).

  - [ ] Select scope of change (e.g. `feat(scope):`).

  - [ ] Ask if is a breaking change.

    - [ ] If yes, ask if you want to use the `!` character (e.g. `feat(scope)!:`).

    - [ ] If yes, add `BREAKING CHANGE` to the commit body.

  - [ ] Ask for a commit message (e.g. `feat(scope): commit message`).

  - [ ] Ask for a commit body (e.g. `feat(scope): commit message\n\nBody of the commit message.`).

- [ ] Create a `:Commitizen` command that will open a prompt to create a commit.

(back to top)


[stars-shield]: https://img.shields.io/github/stars/AlejandroSuero/commitizen.nvim.svg?style=for-the-badge

[stars-url]: https://github.com/AlejandroSuero/commitizen.nvim/stargazers

[issues-shield]: https://img.shields.io/github/issues/AlejandroSuero/commitizen.nvim.svg?style=for-the-badge

[issues-url]: https://github.com/AlejandroSuero/commitizen.nvim/issues

[license-shield]: https://img.shields.io/github/license/AlejandroSuero/commitizen.nvim.svg?style=for-the-badge

[license-url]: https://github.com/AlejandroSuero/commitizen.nvim/blob/main/LICENSE