commitizen-cli - npm Package Compare versions

Comparing version 1.3.1 to 2.0.0

package.json

 {
   "name": "commitizen-cli",
-  "version": "1.3.1",
+  "version": "2.0.0",
   "description": "Command-line interface tool that helps enforce standardized commit message formats in Git repositories.",
@@ -53,2 +53,3 @@ "type": "module",
     "@types/dedent": "^0.7.0",
+    "@types/ini": "^1.3.31",
     "@types/lodash": "^4.14.196",
@@ -71,2 +72,3 @@ "@types/node": "^20.2.5",
     "dedent": "^0.7.0",
+    "ini": "^4.1.1",
     "kolorist": "^1.8.0",
@@ -73,0 +75,0 @@ "lodash": "^4.17.21"

README.md

@@ -1,2 +0,8 @@
-# Commitizen CLI
+<p align="center">
+  <img 
+    src="./assets/logo-banner.png"
+    alt="Commitizen CLI"
+    style="width:100%;"
+  />
+</p>
 
@@ -18,2 +24,4 @@ ![build](https://github.com/iamando/commitizen-cli/workflows/build/badge.svg)
 - **Ticket Support**: Set ticket reference to your commit messages to link directly the changes with your task.
+- **Specific Pattern**: Commit pattern is flexible and customisable to provide a better commit message convention.
+- **Configuration Support**: Get or Set specific configuration like pattern config.
 
@@ -50,2 +58,30 @@ ## Installation
 
+## Configuration
+
+Pattern is defined like this: ':type(:ticket): :commit'
+
+- `:type`: Type of commit (feature, bugfix, documentation, ...)
+- `:ticket`: Reference of ticket (if ticket is defined)
+- `:commit`: Commit message
+
+Get or Set configuration directly to save specific config, use:
+
+```shell
+commitizen-cli config get PATTERN
+```
+
+```shell
+commitizen-cli config set PATTERN='specific pattern'
+```
+
+or using the minified command:
+
+```shell
+cocli config get PATTERN
+```
+
+```shell
+cocli config set PATTERN='specific pattern'
+```
+
 ### Update
@@ -52,0 +88,0 @@

No alert changes

Improved metrics

Total package byte prevSize

17979

increased by42.17%

Lines of code

425

increased by66.67%

Number of lines in readme file

110

increased by48.65%

Worsened metrics

Dependency count

7

increased by16.67%

Dev dependency count

13

increased by8.33%

Dependency changes

• + Addedini@^4.1.1

• + Addedini@4.1.3(transitive)