-
Notifications
You must be signed in to change notification settings - Fork 9.3k
/
printer.js
99 lines (90 loc) · 2.02 KB
/
printer.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
/**
* @license
* Copyright 2016 Google LLC
* SPDX-License-Identifier: Apache-2.0
*/
import fs from 'fs';
import log from 'lighthouse-logger';
/**
* An enumeration of acceptable output modes:
* 'json': JSON formatted results
* 'html': An HTML report
* 'csv': CSV formatted results
* @type {LH.Util.SelfMap<LH.OutputMode>}
*/
const OutputMode = {
json: 'json',
html: 'html',
csv: 'csv',
};
/**
* Verify output path to use, either stdout or a file path.
* @param {string} path
* @return {string}
*/
function checkOutputPath(path) {
if (!path) {
log.warn('Printer', 'No output path set; using stdout');
return 'stdout';
}
return path;
}
/**
* Writes the output to stdout.
* @param {string} output
* @return {Promise<void>}
*/
function writeToStdout(output) {
return new Promise(resolve => {
// small delay to avoid race with debug() logs
setTimeout(_ => {
process.stdout.write(`${output}\n`);
resolve();
}, 50);
});
}
/**
* Writes the output to a file.
* @param {string} filePath
* @param {string} output
* @param {LH.OutputMode} outputMode
* @return {Promise<void>}
*/
function writeFile(filePath, output, outputMode) {
return new Promise((resolve, reject) => {
// TODO: make this mkdir to the filePath.
fs.writeFile(filePath, output, (err) => {
if (err) {
return reject(err);
}
log.log('Printer', `${OutputMode[outputMode]} output written to ${filePath}`);
resolve();
});
});
}
/**
* Writes the output.
* @param {string} output
* @param {LH.OutputMode} mode
* @param {string} path
* @return {Promise<void>}
*/
async function write(output, mode, path) {
const outputPath = checkOutputPath(path);
return outputPath === 'stdout' ?
writeToStdout(output) :
writeFile(outputPath, output, mode);
}
/**
* Returns a list of valid output options.
* @return {Array<string>}
*/
function getValidOutputOptions() {
return Object.keys(OutputMode);
}
export {
checkOutputPath,
write,
OutputMode,
getValidOutputOptions,
};