/
versionCommandOptions.ts
204 lines (203 loc) · 6.38 KB
/
versionCommandOptions.ts
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
export const versionCommandOptions = {
'allow-branch': {
describe: 'Specify which branches to allow versioning from.',
group: 'Version Command Options:',
type: 'array',
},
amend: {
describe: 'Amend the existing commit, instead of generating a new one.',
group: 'Version Command Options:',
type: 'boolean',
},
'conventional-commits': {
describe: 'Use conventional-changelog to determine version bump and generate CHANGELOG.',
group: 'Version Command Options:',
type: 'boolean',
},
'conventional-graduate': {
describe: 'Version currently prereleased packages to a non-prerelease version.',
group: 'Version Command Options:',
// type must remain ambiguous because it is overloaded (boolean _or_ string _or_ array)
},
'conventional-prerelease': {
describe: 'Version changed packages as prereleases when using --conventional-commits.',
group: 'Version Command Options:',
// type must remain ambiguous because it is overloaded (boolean _or_ string _or_ array)
},
'changelog-header-message': {
describe: 'Add a custom message at the top of your "changelog.md" which is located in the root of your project. This option only works when using --conventional-commits.',
group: 'Version Command Options:',
requiresArg: true,
type: 'string'
},
'changelog-version-message': {
describe: 'Add a custom message as a prefix to each new version in your "changelog.md" which is located in the root of your project. This option only works when using --conventional-commits.',
group: 'Version Command Options:',
requiresArg: true,
type: 'string'
},
'changelog-preset': {
describe: 'Custom conventional-changelog preset.',
group: 'Version Command Options:',
type: 'string',
requiresArg: true,
defaultDescription: 'angular',
},
exact: {
describe: 'Specify cross-dependency version numbers exactly rather than with a caret (^).',
group: 'Version Command Options:',
type: 'boolean',
},
'force-publish': {
describe: 'Always include targeted packages in versioning operations, skipping default logic.',
group: 'Version Command Options:',
// type must remain ambiguous because it is overloaded (boolean _or_ string _or_ array)
},
'git-dry-run': {
describe: 'Displays the process command that would be performed without executing it.',
group: 'Version Command Options:',
type: 'boolean',
},
'git-remote': {
describe: 'Push git changes to the specified remote.',
group: 'Version Command Options:',
type: 'string',
requiresArg: true,
defaultDescription: 'origin',
},
'create-release': {
describe: 'Create an official GitHub or GitLab release for every version.',
group: 'Version Command Options:',
type: 'string',
choices: ['gitlab', 'github'],
},
'ignore-changes': {
describe: [
'Ignore changes in files matched by glob(s) when detecting changed packages.',
'Pass --no-ignore-changes to completely disable.',
].join('\n'),
group: 'Version Command Options:',
type: 'array',
},
'ignore-scripts': {
describe: 'Disable all lifecycle scripts',
group: 'Version Command Options:',
type: 'boolean',
},
'include-merged-tags': {
describe: 'Include tags from merged branches when detecting changed packages.',
group: 'Version Command Options:',
type: 'boolean',
},
m: {
describe: 'Use a custom commit message when creating the version commit.',
group: 'Version Command Options:',
alias: 'message',
type: 'string',
requiresArg: true,
},
'no-changelog': {
describe: 'Do not generate CHANGELOG.md files when using --conventional-commits.',
group: 'Version Command Options:',
type: 'boolean',
},
changelog: {
// proxy for --no-changelog
hidden: true,
type: 'boolean',
},
'no-commit-hooks': {
describe: 'Do not run git commit hooks when committing version changes.',
group: 'Version Command Options:',
type: 'boolean',
},
'commit-hooks': {
// proxy for --no-commit-hooks
hidden: true,
type: 'boolean',
},
'no-git-tag-version': {
describe: 'Do not commit or tag version changes.',
group: 'Version Command Options:',
type: 'boolean',
},
'git-tag-version': {
// proxy for --no-git-tag-version
hidden: true,
type: 'boolean',
},
// TODO: (major) make --no-granular-pathspec the default
'no-granular-pathspec': {
describe: 'Do not stage changes file-by-file, but globally.',
group: 'Version Command Options:',
type: 'boolean',
},
'granular-pathspec': {
// proxy for --no-granular-pathspec
hidden: true,
// describe: 'Stage changes file-by-file, not globally.',
group: 'Version Command Options:',
type: 'boolean',
},
// TODO: (major) make --no-private the default
'no-private': {
describe: 'Do not version private packages.',
group: 'Version Command Options:',
type: 'boolean',
},
private: {
// proxy for --no-private
hidden: true,
type: 'boolean',
},
'no-push': {
describe: 'Do not push tagged commit to git remote.',
group: 'Version Command Options:',
type: 'boolean',
},
push: {
// proxy for --no-push
hidden: true,
type: 'boolean',
},
// preid is copied into ../publish/command because a whitelist for one option isn't worth it
preid: {
describe: 'Specify the prerelease identifier when versioning a prerelease',
group: 'Version Command Options:',
type: 'string',
requiresArg: true,
defaultDescription: 'alpha',
},
'sign-git-commit': {
describe: 'Pass the `--gpg-sign` flag to `git commit`.',
group: 'Version Command Options:',
type: 'boolean',
},
'signoff-git-commit': {
describe: 'Pass the `--signoff` flag to `git commit`.',
type: 'boolean',
},
'sign-git-tag': {
describe: 'Pass the `--sign` flag to `git tag`.',
group: 'Version Command Options:',
type: 'boolean',
},
'force-git-tag': {
describe: 'Pass the `--force` flag to `git tag`.',
group: 'Version Command Options:',
type: 'boolean',
},
'tag-version-prefix': {
describe: 'Customize the tag prefix. To remove entirely, pass an empty string.',
group: 'Version Command Options:',
type: 'string',
requiresArg: true,
defaultDescription: 'v',
},
y: {
describe: 'Skip all confirmation prompts.',
group: 'Version Command Options:',
alias: 'yes',
type: 'boolean',
},
};