cz-git

cz-git

GitHub   |   Installation   |   Website   |   简体中文文档

Introduction

A support OpenAI, and more engineered, lightweight, customizable, standard output format commitizen adapter.

What is commitizen: A Node.js-based git commit command-line tool that assists in generating standardized commit messages.

What is an adapter: Replace the interactive plugin for the commitizen command line tool.

Feature

• 🤖 OpenAI support. Let the AI generate your git commit message description.
• 💪 Just to be a lazy man !!! Friendly command line tool, Supports search and selection on the command line, reducing spelling errors.
• ⚡️ Lightweight, Highly Customizable, but the output format follows the standard Conventional Commits specification.
• 🔨 Better for monorepo engineering and commitlint project to give relevant verification information to the command line.
• ✅ Support commit with emoji ｜ Better linking with issuePrefix for issue

⇒ Why cz-git

$ npm i -D cz-git
+ cz-git          (1.75 MB)
added 1 package in 0.552s

Usage

「cz-git」 requires Node >=v12.20

⇒ Get Started

Configure Template

⇒ Configure Template

Options

⇒ Show Related

⇒ Engineering Related

Recipes

⇒ Recipes

FAQ

⇒ FAQ

Projects using cz-git

Nx	Element Plus	Ant Design Vue	TDesign-Vue-Next
Vben-Admin	Vue3-Antd-Admin	Geeker-Admin	iDux
Vuepress-Theme-Hope	Vuepress-Theme-Gungnir

LICENSE

MIT Copyright (c) 2022-present Qiubin Zheng [e-mail] (https://github.com/Zhengqbbb)

I just try my best to make thing well. Could you give a star ⭐ to encourage me 🤗 If possible, can to be my 💖 Sponsor 💖 to support my work

Changelog

1.10.0 (2024-09-28)

Bug Fixes

• cli: upgrade commitlint version to resolve config extension issue (#187) (dee8b44), closes #186

Features

• cz-git,cli: add aiModel option to support multiple OpenAI models (#185) (241577b), closes #180
• cz-git: add env CZ_EDITOR to change editor during confirm (#174) (0fad291)

Performance Improvements

• cli: remove fs-extra. bundle size -100KB (79a7833)