czg 0.0.12 → 1.3.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +83 -4
- package/bin/index.js +161 -161
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,11 +1,57 @@
|
|
|
1
|
-
|
|
1
|
+
<h1 align="center">czg</h1>
|
|
2
2
|
|
|
3
3
|
> Interactive Commitizen CLI that generate standardized commit messages
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
<p align="center">
|
|
6
|
+
<a href="https://www.npmjs.com/package/cz-git">
|
|
7
|
+
<img style="display:inline-block;margin:0.2em;" alt="npm" src="https://img.shields.io/npm/v/cz-git?style=flat-square&logo=npm">
|
|
8
|
+
</a>
|
|
9
|
+
<a target="_blank" href="https://github.com/Zhengqbbb/cz-git">
|
|
10
|
+
<img style="display:inline-block;margin:0.2em;" alt="GitHub Repo stars" src="https://img.shields.io/github/stars/zhengqbbb/cz-git?style=social">
|
|
11
|
+
</a>
|
|
12
|
+
</p>
|
|
13
|
+
|
|
14
|
+
<p align="center">
|
|
15
|
+
<a href="https://github.com/Zhengqbbb/cz-git">Github</a>
|
|
16
|
+
|
|
|
17
|
+
<a href="https://cz-git.qbenben.com/cli/install.html">Installation</a>
|
|
18
|
+
|
|
|
19
|
+
<a href="https://cz-git.qbenben.com/cli/">Website</a>
|
|
20
|
+
|
|
|
21
|
+
<a href="https://cz-git.qbenben.com/zh/cli/">简体中文文档</a>
|
|
22
|
+
</p>
|
|
23
|
+
|
|
24
|
+
<br/>
|
|
25
|
+
<br/>
|
|
26
|
+
|
|
27
|
+
- **Lightweight** : Zero Dependencies (1.3MB)
|
|
28
|
+
- **Simpler and Faster** : No plugin, No adapter, No extra steps, You can use `npx` | `npm script` | `global install`... quick start CLI in your any project
|
|
29
|
+
- **Highly Customizable** : Internally contains the core of cz-git. Extend all the features of cz-git. Same behavior, Same configuration loader... You can customize the commit CLI according to your need
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
## Quick start
|
|
34
|
+
1. Now try it out, use `npx czg` in **your any projects**
|
|
35
|
+
2. And then, let's try to simply configure it.
|
|
36
|
+
Create a `.czrc` file in the project root directory
|
|
37
|
+
|
|
38
|
+
```json
|
|
39
|
+
{
|
|
40
|
+
"scopes": [
|
|
41
|
+
"hello",
|
|
42
|
+
"world"
|
|
43
|
+
]
|
|
44
|
+
}
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
> **Note**
|
|
48
|
+
> More information about configure file and options. See → [Config](https://cz-git.qbenben.com/config/)
|
|
49
|
+
|
|
50
|
+
## Features and Help
|
|
51
|
+
|
|
6
52
|
|
|
7
53
|
```sh
|
|
8
|
-
$
|
|
54
|
+
$ czg --help
|
|
9
55
|
NAME:
|
|
10
56
|
czg - Interactive Commitizen CLI that generate standardized commit messages
|
|
11
57
|
|
|
@@ -18,7 +64,7 @@ SYNOPSIS:
|
|
|
18
64
|
|
|
19
65
|
SUBCOMMAND:
|
|
20
66
|
break Turn on BREAKING CHANGE mode, Add ! mark on header
|
|
21
|
-
emoji Turn on emoji mode
|
|
67
|
+
emoji Turn on output message with emoji mode
|
|
22
68
|
checkbox Turn on scope checkbox mode
|
|
23
69
|
|
|
24
70
|
OPTIONS:
|
|
@@ -35,3 +81,36 @@ EXAMPLES:
|
|
|
35
81
|
Extends 'git commit' command and options.
|
|
36
82
|
See 'git commit --help' for more information.
|
|
37
83
|
```
|
|
84
|
+
|
|
85
|
+
## Installation
|
|
86
|
+
|
|
87
|
+
```
|
|
88
|
+
npm install -g czg
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
[⇒ Get Started](https://cz-git.qbenben.com/cli/install.html)
|
|
92
|
+
|
|
93
|
+
## Configure Template
|
|
94
|
+
|
|
95
|
+
[⇒ Configure Template](https://cz-git.qbenben.com/config/)
|
|
96
|
+
|
|
97
|
+
## Options
|
|
98
|
+
|
|
99
|
+
[⇒ Show Related](https://cz-git.qbenben.com/config/show.html)
|
|
100
|
+
|
|
101
|
+
[⇒ Engineering Related](https://cz-git.qbenben.com/config/engineer.html)
|
|
102
|
+
|
|
103
|
+
## Recipes
|
|
104
|
+
|
|
105
|
+
[⇒ Recipes](https://cz-git.qbenben.com/recipes/)
|
|
106
|
+
|
|
107
|
+
## FAQ
|
|
108
|
+
|
|
109
|
+
[⇒ FAQ](https://cz-git.qbenben.com/faq/)
|
|
110
|
+
|
|
111
|
+
## LICENSE
|
|
112
|
+
|
|
113
|
+
MIT
|
|
114
|
+
Copyright (c) 2022-present Qiubin Zheng <zhengqbbb@gmail.com> (https://github.com/Zhengqbbb)
|
|
115
|
+
|
|
116
|
+
> I just do my best to make thing well, Could you give a [star ⭐](https://github.com/Zhengqbbb/cz-git) to encourage me ?
|