forked from commitizen-tools/commitizen
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathcli.py
More file actions
219 lines (208 loc) · 7.61 KB
/
Copy pathcli.py
File metadata and controls
219 lines (208 loc) · 7.61 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
import argparse
import logging
import sys
import warnings
from decli import cli
from commitizen import commands, config, out
logger = logging.getLogger(__name__)
data = {
"prog": "cz",
"description": (
"Commitizen is a cli tool to generate conventional commits.\n"
"For more information about the topic go to "
"https://conventionalcommits.org/"
),
"formatter_class": argparse.RawDescriptionHelpFormatter,
"arguments": [
{"name": "--debug", "action": "store_true", "help": "use debug mode"},
{
"name": ["-n", "--name"],
"help": "use the given commitizen (default: cz_conventional_commits)",
},
{
"name": ["--version"],
"action": "store_true",
"help": "get the version of the installed commitizen",
},
],
"subcommands": {
"title": "commands",
# TODO: Add this constraint back in 2.0
# "required": True,
"commands": [
{
"name": "ls",
"help": "show available commitizens",
"func": commands.ListCz,
},
{
"name": ["commit", "c"],
"help": "create new commit",
"func": commands.Commit,
"arguments": [
{
"name": ["--retry"],
"action": "store_true",
"help": "retry last commit",
},
{
"name": "--dry-run",
"action": "store_true",
"help": "show output to stdout, no commit, no modified files",
},
],
},
{
"name": "example",
"help": "show commit example",
"func": commands.Example,
},
{
"name": "info",
"help": "show information about the cz",
"func": commands.Info,
},
{"name": "schema", "help": "show commit schema", "func": commands.Schema},
{
"name": "bump",
"help": "bump semantic version based on the git log",
"func": commands.Bump,
"arguments": [
{
"name": "--dry-run",
"action": "store_true",
"help": "show output to stdout, no commit, no modified files",
},
{
"name": "--files-only",
"action": "store_true",
"help": "bump version in the files from the config",
},
{
"name": "--yes",
"action": "store_true",
"help": "accept automatically questions done",
},
{
"name": "--tag-format",
"help": (
"the format used to tag the commit and read it, "
"use it in existing projects, "
"wrap around simple quotes"
),
},
{
"name": "--bump-message",
"help": (
"template used to create the release commmit, "
"useful when working with CI"
),
},
{
"name": ["--prerelease", "-pr"],
"help": "choose type of prerelease",
"choices": ["alpha", "beta", "rc"],
},
{
"name": ["--increment"],
"help": "manually specify the desired increment",
"choices": ["MAJOR", "MINOR", "PATCH"],
},
],
},
{
"name": ["version"],
"help": (
"get the version of the installed commitizen or the current project"
" (default: installed commitizen)"
),
"func": commands.Version,
"arguments": [
{
"name": ["-p", "--project"],
"help": "get the version of the current project",
"action": "store_true",
"exclusive_group": "group1",
},
{
"name": ["-c", "--commitizen"],
"help": "get the version of the installed commitizen",
"action": "store_true",
"exclusive_group": "group1",
},
{
"name": ["-v", "--verbose"],
"help": (
"get the version of both the installed commitizen "
"and the current project"
),
"action": "store_true",
"exclusive_group": "group1",
},
],
},
{
"name": ["check"],
"help": "validates that a commit message matches the commitizen schema",
"func": commands.Check,
"arguments": [
{
"name": "--commit-msg-file",
"help": (
"ask for the name of the temporal file that contains "
"the commit message. "
"Using it in a git hook script: MSG_FILE=$1"
),
"exclusive_group": "group1",
},
{
"name": "--rev-range",
"help": "a range of git rev to check. e.g, master..HEAD",
"exclusive_group": "group1",
},
],
},
{
"name": ["init"],
"help": "init commitizen configuration",
"func": commands.Init,
},
],
},
}
def main():
conf = config.read_cfg()
parser = cli(data)
# Show help if no arg provided
if len(sys.argv) == 1:
parser.print_help(sys.stderr)
raise SystemExit()
# This is for the command required constraint in 2.0
try:
args = parser.parse_args()
except TypeError:
out.error("Command is required")
raise SystemExit()
if args.name:
conf.update({"name": args.name})
elif not args.name and not conf.path:
conf.update({"name": "cz_conventional_commits"})
if args.version:
warnings.warn(
"'cz --version' will be deprecated in next major version. "
"Please use 'cz version' command from your scripts"
)
args.func = commands.Version
if args.debug:
warnings.warn(
"Debug will be deprecated in next major version. "
"Please remove it from your scripts"
)
logging.getLogger("commitizen").setLevel(logging.DEBUG)
# TODO: This try block can be removed after command is required in 2.0
# Handle the case that argument is given, but no command is provided
try:
args.func(conf, vars(args))()
except AttributeError:
out.error("Command is required")
raise SystemExit()