-
Notifications
You must be signed in to change notification settings - Fork 3.9k
/
prettify.js
176 lines (165 loc) · 5.1 KB
/
prettify.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
/**
* Copyright 2019 The AMP HTML Authors. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS-IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @fileoverview This file implements the `gulp prettify` task, which uses
* prettier to check (and optionally fix) the formatting in a variety of
* non-JS files in the repo. (JS files are separately checked by `gulp lint`,
* which uses eslint.)
*/
'use strict';
const argv = require('minimist')(process.argv.slice(2));
const globby = require('globby');
const log = require('fancy-log');
const path = require('path');
const {getFilesChanged, logOnSameLine} = require('../common/utils');
const {getOutput} = require('../common/exec');
const {green, cyan, red, yellow} = require('ansi-colors');
const {highlight} = require('cli-highlight');
const {isTravisBuild} = require('../common/travis');
const {maybeUpdatePackages} = require('./update-packages');
const {prettifyGlobs} = require('../test-configs/config');
const rootDir = path.dirname(path.dirname(__dirname));
const prettierCmd = 'node_modules/.bin/prettier';
/**
* Prettier exit codes. See https://prettier.io/docs/en/cli.html#exit-codes
* @enum {number}
*/
const PrettierResult = {
SUCCESS: 0,
FAILURE: 1,
ERROR: 2,
};
/**
* Logs the list of files that will be checked.
*
* @param {!Array<string>} files
*/
function logFiles(files) {
if (!isTravisBuild()) {
log(green('INFO: ') + 'Prettifying the following files:');
files.forEach(file => {
log(cyan(path.relative(rootDir, file)));
});
}
}
/**
* Checks files for formatting (and optionally fixes them) with Prettier.
*/
async function prettify() {
maybeUpdatePackages();
let filesToCheck;
if (argv.files) {
filesToCheck = globby.sync(argv.files.split(','));
logFiles(filesToCheck);
} else if (argv.local_changes) {
filesToCheck = getFilesChanged(prettifyGlobs);
if (filesToCheck.length == 0) {
log(green('INFO: ') + 'No prettifiable files in this PR');
return;
} else {
logFiles(filesToCheck);
}
} else {
filesToCheck = globby.sync(prettifyGlobs);
}
runPrettify(filesToCheck);
}
/**
* Runs prettier on the given list of files. Returns the cumulative result to
* the `gulp` process via process.exitCode so all files can be checked / fixed.
*
* @param {!Array<string>} filesToCheck
*/
function runPrettify(filesToCheck) {
if (!isTravisBuild()) {
log(green('Starting checks...'));
}
filesToCheck.forEach(file => {
checkFile(path.relative(rootDir, file));
});
if (process.exitCode == 1) {
logOnSameLine(red('ERROR: ') + 'Found errors in one or more files.');
if (!argv.fix) {
log(
yellow('NOTE 1:'),
'You may be able to automatically fix some errors by running',
cyan('gulp prettify --local_changes --fix'),
'from your local branch.'
);
log(
yellow('NOTE 2:'),
'Since this is a destructive operation (that edits your files',
'in-place), make sure you commit before running the command.'
);
}
} else {
if (!isTravisBuild()) {
logOnSameLine(green('SUCCESS: ') + 'No formatting errors found.');
}
}
}
/**
* Fixes the formatting of a single file
* @param {string} file
*/
function fixFile(file) {
const fixCmd = `${prettierCmd} --write ${file}`;
const fixResult = getOutput(fixCmd);
if (fixResult.status == PrettierResult.SUCCESS) {
logOnSameLine(green('Fixed: ') + file + '\n');
} else {
logOnSameLine(red('Could not fix: ') + file);
console.log(highlight(fixResult.stderr, {ignoreIllegals: true}), '\n');
process.exitCode = 1;
}
}
/**
* Checks and optionally fixes the formatting of a single file.
* @param {string} file
*/
function checkFile(file) {
const checkCmd = `${prettierCmd} --list-different ${file}`;
const checkResult = getOutput(checkCmd);
if (checkResult.status == PrettierResult.SUCCESS) {
if (!isTravisBuild()) {
logOnSameLine(green('Checked: ') + file);
}
} else if (checkResult.status == PrettierResult.FAILURE) {
if (argv.fix) {
fixFile(file);
} else {
logOnSameLine(red('Found errors in: ') + file + '\n');
process.exitCode = 1;
}
} else {
logOnSameLine(red('Could not parse: ') + file);
console.log(
highlight(checkResult.stderr.trim(), {ignoreIllegals: true}),
'\n'
);
process.exitCode = 1;
}
}
module.exports = {
prettify,
};
prettify.description =
'Checks several non-JS files in the repo for formatting using prettier';
prettify.flags = {
'files': ' Checks only the specified files',
'local_changes': ' Checks just the files changed in the local branch',
'fix': ' Fixes formatting errors',
};