-
Notifications
You must be signed in to change notification settings - Fork 2k
/
test-style.js
320 lines (290 loc) · 8.84 KB
/
test-style.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
'use strict';
const fs = require('fs');
const path = require('path');
const url = require('url');
const chalk = require('chalk');
const { platform } = require('os');
/** Determines if the OS is Windows */
const IS_WINDOWS = platform() === 'win32';
/**
* Return a new "support_block" object whose first-level properties
* (browser names) have been ordered according to Array.prototype.sort,
* and so will be stringified in that order as well. This relies on
* guaranteed "own" property ordering, which is insertion order for
* non-integer keys (which is our case).
*
* @param {string} key The key in the object
* @param {*} value The value of the key
*
* @returns {*} The new value
*/
function orderSupportBlock(key, value) {
if (key === '__compat') {
value.support = Object.keys(value.support).sort().reduce((result, key) => {
result[key] = value.support[key];
return result;
}, {});
}
return value;
}
/**
* @param {string} str
*/
function escapeInvisibles(str) {
/** @type {Array<[string, string]>} */
const invisibles = [
['\b', '\\b'],
['\f', '\\f'],
['\n', '\\n'],
['\r', '\\r'],
['\v', '\\v'],
['\t', '\\t'],
['\0', '\\0'],
];
let finalString = str;
invisibles.forEach(([invisible, replacement]) => {
finalString = finalString.replace(invisible, replacement);
});
return finalString;
}
/**
* Gets the row and column matching the index in a string.
*
* @param {string} str
* @param {number} index
* @return {[number, number] | [null, null]}
*/
function indexToPosRaw(str, index) {
let line = 1, col = 1;
let prevChar = null;
if (
typeof str !== 'string' ||
typeof index !== 'number' ||
index > str.length
) {
return [null, null];
}
for (let i = 0; i < index; i++) {
let char = str[i];
switch (char) {
case '\n':
if (prevChar === '\r') break;
case '\r':
line++;
col = 1;
break;
case '\t':
// Use JSON `tab_size` value from `.editorconfig`
col += 2;
break;
default:
col++;
break;
}
prevChar = char;
}
return [line, col];
}
/**
* Gets the row and column matching the index in a string and formats it.
*
* @param {string} str
* @param {number} index
* @return {string} The line and column in the form of: `"(Ln <ln>, Col <col>)"`
*/
function indexToPos(str, index) {
const [line, col] = indexToPosRaw(str, index);
return `(Ln ${line}, Col ${col})`;
}
/**
* @param {string} actual
* @param {string} expected
* @return {string}
*/
function jsonDiff(actual, expected) {
var actualLines = actual.split(/\n/);
var expectedLines = expected.split(/\n/);
for (var i = 0; i < actualLines.length; i++) {
if (actualLines[i] !== expectedLines[i]) {
return chalk`#${i + 1}{reset
Actual: ${escapeInvisibles(actualLines[i])}
Expected: ${escapeInvisibles(expectedLines[i])}}`;
}
}
}
/**
* @param {string} filename
*/
function testStyle(filename) {
let hasErrors = false;
let actual = fs.readFileSync(filename, 'utf-8').trim();
/** @type {import('../types').CompatData} */
let dataObject = JSON.parse(actual);
let expected = JSON.stringify(dataObject, null, 2);
let expectedSorting = JSON.stringify(dataObject, orderSupportBlock, 2);
// prevent false positives from git.core.autocrlf on Windows
if (IS_WINDOWS) {
actual = actual.replace(/\r/g, '');
expected = expected.replace(/\r/g, '');
expectedSorting = expectedSorting.replace(/\r/g, '');
}
if (actual !== expected) {
hasErrors = true;
console.error(chalk.red(` File : ${path.relative(process.cwd(), filename)}`));
console.error(chalk.red(` Style – Error on line ${jsonDiff(actual, expected)}`));
}
if (expected !== expectedSorting) {
hasErrors = true;
console.error(chalk.red(` File : ${path.relative(process.cwd(), filename)}`));
console.error(chalk.red(` Browser name sorting – Error on line ${jsonDiff(
expected,
expectedSorting,
)}`));
}
const bugzillaMatch = actual.match(String.raw`https?://bugzilla\.mozilla\.org/show_bug\.cgi\?id=(\d+)`);
if (bugzillaMatch) {
// use https://bugzil.la/1000000 instead
hasErrors = true;
console.error(chalk.yellow(
` Style ${indexToPos(
actual,
bugzillaMatch.index,
)} – Use shortenable URL (${
bugzillaMatch[0]
} → https://bugzil.la/${bugzillaMatch[1]}).`,
));
}
{
// Bugzil.la links should use HTTPS and have "bug ###" as link text ("Bug ###" only at the begin of notes/sentences).
const regexp = new RegExp(String.raw`(....)<a href='(https?)://(bugzil\.la|crbug\.com|webkit\.org/b)/(\d+)'>(.*?)</a>`, 'g');
/** @type {RegExpExecArray} */
let match;
do {
match = regexp.exec(actual);
if (match) {
const [,
before,
protocol,
domain,
bugId,
linkText,
] = match;
if (protocol !== 'https') {
hasErrors = true;
console.error(chalk.yellow(` Style ${indexToPos(
actual,
match.index,
)} – Use HTTPS URL (http://${domain}/${bugId} → https://${domain}/${bugId}).`));
}
if (domain !== 'bugzil.la') {
continue;
}
if (/^bug $/.test(before)) {
hasErrors = true;
console.error(chalk.yellow(` Style ${indexToPos(
actual,
match.index,
)} – Move word "bug" into link text ("${before}<a href='...'>${linkText}</a>" → "<a href='...'>${before}${bugId}</a>").`));
} else if (linkText === `Bug ${bugId}`) {
if (!/(\. |")$/.test(before)) {
hasErrors = true;
console.error(chalk.yellow(` Style ${indexToPos(
actual,
match.index,
)} – Use lowercase "bug" word within sentence ("Bug ${bugId}" → "bug ${bugId}").`));
}
} else if (linkText !== `bug ${bugId}`) {
hasErrors = true;
console.error(chalk.yellow(` Style ${indexToPos(
actual,
match.index,
)} – Use standard link text ("${linkText}" → "bug ${bugId}").`));
}
}
} while (match != null);
}
const crbugMatch = actual.match(String.raw`https?://bugs\.chromium\.org/p/chromium/issues/detail\?id=(\d+)`);
if (crbugMatch) {
// use https://crbug.com/100000 instead
hasErrors = true;
console.error(chalk.yellow(
` Style ${indexToPos(
actual,
crbugMatch.index,
)} – Use shortenable URL (${
crbugMatch[0]
} → https://crbug.com/${crbugMatch[1]}).`,
));
}
const webkitMatch = actual.match(String.raw`https?://bugs\.webkit\.org/show_bug\.cgi\?id=(\d+)`);
if (webkitMatch) {
// use https://webkit.org/b/100000 instead
hasErrors = true;
console.error(chalk.yellow(
` Style ${indexToPos(
actual,
webkitMatch.index,
)} – Use shortenable URL (${
webkitMatch[0]
} → https://webkit.org/b/${webkitMatch[1]}).`,
));
}
const mdnUrlMatch = actual.match(String.raw`https?://developer.mozilla.org/(\w\w-\w\w)/(.*?)(?=["'\s])`);
if (mdnUrlMatch) {
hasErrors = true;
console.error(chalk.yellow(
` Style ${indexToPos(
actual,
mdnUrlMatch.index,
)} – Use non-localized MDN URL (${
mdnUrlMatch[0]
} → https://developer.mozilla.org/${mdnUrlMatch[2]}).`,
));
}
const msdevUrlMatch = actual.match(String.raw`https?://developer.microsoft.com/(\w\w-\w\w)/(.*?)(?=["'\s])`);
if (msdevUrlMatch) {
hasErrors = true;
console.error(chalk.yellow(
` Style ${indexToPos(
actual,
msdevUrlMatch.index,
)} – Use non-localized Microsoft Developer URL (${
msdevUrlMatch[0]
} → https://developer.microsoft.com${msdevUrlMatch[2]}).`,
));
}
let constructorMatch = actual.match(String.raw`"<code>([^)]*?)</code> constructor"`)
if (constructorMatch) {
hasErrors = true;
console.error(chalk.yellow(
` Style ${indexToPos(
actual,
constructorMatch.index,
)} – Use parentheses in constructor description: ${
constructorMatch[1]
} → ${constructorMatch[1]}()`,
));
}
if (actual.includes("href=\\\"")) {
hasErrors = true;
console.error(chalk.yellow(' Style – Found \\" but expected \' for <a href>.'));
}
const regexp = new RegExp(String.raw`<a href='([^'>]+)'>((?:.(?!</a>))*.)</a>`, 'g');
let match = regexp.exec(actual);
if (match) {
var a_url = url.parse(match[1]);
if (a_url.hostname === null) {
hasErrors = true;
console.error(chalk.yellow(
` Style ${indexToPos(
actual,
match.index,
)} – Include hostname in URL: ${
match[1]
} → https://developer.mozilla.org/${match[1]}`,
));
}
}
return hasErrors;
}
module.exports = testStyle;