-
Notifications
You must be signed in to change notification settings - Fork 914
/
cli.js
executable file
Β·347 lines (308 loc) Β· 8.23 KB
/
cli.js
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
#!/usr/bin/env node
require('babel-polyfill'); // eslint-disable-line import/no-unassigned-import
const load = require('@commitlint/load');
const lint = require('@commitlint/lint');
const read = require('@commitlint/read');
const meow = require('meow');
const {merge, pick, isFunction} = require('lodash');
const stdin = require('get-stdin');
const resolveFrom = require('resolve-from');
const resolveGlobal = require('resolve-global');
const pkg = require('../package');
const help = require('./help');
const flags = {
color: {
alias: 'c',
default: true,
description: 'toggle colored output',
type: 'boolean'
},
config: {
alias: 'g',
default: null,
description: 'path to the config file',
type: 'string'
},
cwd: {
alias: 'd',
default: process.cwd(),
description: 'directory to execute in',
type: 'string'
},
edit: {
alias: 'e',
default: false,
description:
'read last commit message from the specified file or fallbacks to ./.git/COMMIT_EDITMSG',
type: 'string'
},
env: {
alias: 'E',
default: null,
description:
'check message in the file at path given by environment variable value',
type: 'string'
},
extends: {
alias: 'x',
description: 'array of shareable configurations to extend',
type: 'string'
},
help: {
alias: 'h',
type: 'boolean',
description: 'display this help message'
},
from: {
alias: 'f',
default: null,
description: 'lower end of the commit range to lint; applies if edit=false',
type: 'string'
},
format: {
alias: 'o',
default: null,
description: 'output format of the results',
type: 'string'
},
'parser-preset': {
alias: 'p',
description: 'configuration preset to use for conventional-commits-parser',
type: 'string'
},
quiet: {
alias: 'q',
default: false,
description: 'toggle console output',
type: 'boolean'
},
to: {
alias: 't',
default: null,
description: 'upper end of the commit range to lint; applies if edit=false',
type: 'string'
},
version: {
alias: 'v',
type: 'boolean',
description: 'display version information'
},
verbose: {
alias: 'V',
type: 'boolean',
description: 'enable verbose output for reports without problems'
}
};
const cli = meow({
description: `${pkg.name}@${pkg.version} - ${pkg.description}`,
flags,
help: `[input] reads from stdin if --edit, --env, --from and --to are omitted\n${help(
flags
)}`,
unknown(arg) {
throw new Error(`unknown flags: ${arg}`);
}
});
main(cli).catch(err =>
setTimeout(() => {
if (err.type === pkg.name) {
process.exit(1);
}
throw err;
})
);
async function main(options) {
const raw = options.input;
const flags = normalizeFlags(options.flags);
const fromStdin = checkFromStdin(raw, flags);
const range = pick(flags, 'edit', 'from', 'to');
const input = await (fromStdin ? stdin() : read(range, {cwd: flags.cwd}));
const messages = (Array.isArray(input) ? input : [input])
.filter(message => typeof message === 'string')
.filter(message => message.trim() !== '')
.filter(Boolean);
if (messages.length === 0 && !checkFromRepository(flags)) {
const err = new Error(
'[input] is required: supply via stdin, or --env or --edit or --from and --to'
);
err.type = pkg.name;
console.log(`${cli.help}\n`);
console.log(err.message);
throw err;
}
const loadOpts = {cwd: flags.cwd, file: flags.config};
const loaded = await load(getSeed(flags), loadOpts);
const parserOpts = selectParserOpts(loaded.parserPreset);
const opts = {
parserOpts: {},
plugins: {},
ignores: []
};
if (parserOpts) {
opts.parserOpts = parserOpts;
}
if (loaded.plugins) {
opts.plugins = loaded.plugins;
}
if (loaded.ignores) {
opts.ignores = loaded.ignores;
}
const format = loadFormatter(loaded, flags);
// Strip comments if reading from `.git/COMMIT_EDIT_MSG`
if (range.edit) {
opts.parserOpts.commentChar = '#';
}
const results = await Promise.all(
messages.map(message => lint(message, loaded.rules, opts))
);
if (Object.keys(loaded.rules).length === 0) {
let input = '';
if (results.length !== 0) {
const originalInput = results[0].input;
input = originalInput;
}
results.splice(0, results.length, {
valid: false,
errors: [
{
level: 2,
valid: false,
name: 'empty-rules',
message: [
'Please add rules to your `commitlint.config.js`',
' - Getting started guide: https://git.io/fhHij',
' - Example config: https://git.io/fhHip'
].join('\n')
}
],
warnings: [],
input
});
}
const report = results.reduce(
(info, result) => {
info.valid = result.valid ? info.valid : false;
info.errorCount += result.errors.length;
info.warningCount += result.warnings.length;
info.results.push(result);
return info;
},
{
valid: true,
errorCount: 0,
warningCount: 0,
results: []
}
);
const output = format(report, {
color: flags.color,
verbose: flags.verbose,
helpUrl:
'https://github.com/conventional-changelog/commitlint/#what-is-commitlint'
});
if (!flags.quiet && output !== '') {
console.log(output);
}
if (!report.valid) {
const err = new Error(output);
err.type = pkg.name;
throw err;
}
}
function checkFromStdin(input, flags) {
return input.length === 0 && !checkFromRepository(flags);
}
function checkFromRepository(flags) {
return checkFromHistory(flags) || checkFromEdit(flags);
}
function checkFromEdit(flags) {
return Boolean(flags.edit) || flags.env;
}
function checkFromHistory(flags) {
return typeof flags.from === 'string' || typeof flags.to === 'string';
}
function normalizeFlags(flags) {
const edit = getEditValue(flags);
return merge({}, flags, {edit, e: edit});
}
function getEditValue(flags) {
if (flags.env) {
if (!(flags.env in process.env)) {
throw new Error(
`Recieved '${
flags.env
}' as value for -E | --env, but environment variable '${
flags.env
}' is not available globally`
);
}
return process.env[flags.env];
}
const {edit} = flags;
// If the edit flag is set but empty (i.e '-e') we default
// to .git/COMMIT_EDITMSG
if (edit === '') {
return true;
}
if (typeof edit === 'boolean') {
return edit;
}
// The recommended method to specify -e with husky was `commitlint -e $HUSKY_GIT_PARAMS`
// This does not work properly with win32 systems, where env variable declarations
// use a different syntax
// See https://github.com/conventional-changelog/commitlint/issues/103 for details
// This has been superceded by the `-E GIT_PARAMS` / `-E HUSKY_GIT_PARAMS`
const isGitParams = edit === '$GIT_PARAMS' || edit === '%GIT_PARAMS%';
const isHuskyParams =
edit === '$HUSKY_GIT_PARAMS' || edit === '%HUSKY_GIT_PARAMS%';
if (isGitParams || isHuskyParams) {
console.warn(`Using environment variable syntax (${edit}) in -e |\
--edit is deprecated. Use '{-E|--env} HUSKY_GIT_PARAMS instead'`);
if (isGitParams && 'GIT_PARAMS' in process.env) {
return process.env.GIT_PARAMS;
}
if ('HUSKY_GIT_PARAMS' in process.env) {
return process.env.HUSKY_GIT_PARAMS;
}
throw new Error(
`Received ${edit} as value for -e | --edit, but GIT_PARAMS or HUSKY_GIT_PARAMS are not available globally.`
);
}
return edit;
}
function getSeed(seed) {
const e = Array.isArray(seed.extends) ? seed.extends : [seed.extends];
const n = e.filter(i => typeof i === 'string');
return n.length > 0
? {extends: n, parserPreset: seed.parserPreset}
: {parserPreset: seed.parserPreset};
}
function selectParserOpts(parserPreset) {
if (typeof parserPreset !== 'object') {
return undefined;
}
if (typeof parserPreset.parserOpts !== 'object') {
return undefined;
}
return parserPreset.parserOpts;
}
function loadFormatter(config, flags) {
const moduleName = flags.format || config.formatter || '@commitlint/format';
const modulePath =
resolveFrom.silent(__dirname, moduleName) ||
resolveFrom.silent(flags.cwd, moduleName) ||
resolveGlobal.silent(moduleName);
if (modulePath) {
const moduleInstance = require(modulePath);
if (isFunction(moduleInstance.default)) {
return moduleInstance.default;
}
return moduleInstance;
}
throw new Error(`Using format ${moduleName}, but cannot find the module.`);
}
// Catch unhandled rejections globally
process.on('unhandledRejection', (reason, promise) => {
console.log('Unhandled Rejection at: Promise ', promise, ' reason: ', reason);
throw reason;
});