-
Notifications
You must be signed in to change notification settings - Fork 667
/
analyze.ts
493 lines (383 loc) · 14.4 KB
/
analyze.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
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
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
import * as path from 'path';
import boxen = require('boxen');
import * as chalk from 'chalk';
import * as isCI from 'is-ci';
import * as ora from 'ora';
import * as osLocale from 'os-locale';
import {
appInsights,
askQuestion,
configStore,
ConnectorConfig,
getHintsFromConfiguration,
HintsConfigObject,
HintSeverity,
installPackages,
logger,
mergeEnvWithOptions,
normalizeHints
} from '@hint/utils';
import { cwd } from '@hint/utils-fs';
import { getAsUris } from '@hint/utils-network';
import { debug as d } from '@hint/utils-debug';
import { Problem, Severity } from '@hint/utils-types';
import {
AnalyzerError,
AnalyzeOptions,
CLIOptions,
CreateAnalyzerOptions,
HintResources,
UserConfig
} from '../types';
import { loadHintPackage } from '../utils/packages/load-hint-package';
import { createAnalyzer, getUserConfig } from '../';
import { Analyzer } from '../analyzer';
import { AnalyzerErrorStatus } from '../enums/error-status';
const debug: debug.IDebugger = d(__filename);
const alreadyRunKey: string = 'run';
const spinner = ora({ spinner: 'line' });
/*
* ------------------------------------------------------------------------------
* Private
* ------------------------------------------------------------------------------
*/
const printFrame = (message: string) => {
logger.log(boxen(message, {
align: 'center',
margin: 1,
padding: 1
}));
};
/**
* Prints a message asking user to accept send telemetry data.
*/
const showTelemetryMessage = () => {
const message: string = `Help us improve webhint
by sending limited usage information
(no personal information or URLs will be sent).
To know more about what information will be sent please
visit ${chalk.green('https://webhint.io/docs/user-guide/telemetry/summary/')}`;
printFrame(message);
};
/**
* Prints a message asking user to configure the telemetry.
*/
const showCITelemetryMessage = () => {
const message: string = `Help us improve webhint
by sending limited usage information
(no personal information or URLs will be sent).
To know more about what information will be sent please
visit ${chalk.green('https://webhint.io/docs/user-guide/telemetry/summary/')}
Please configure it using
the environment variable HINT_TELEMETRY to 'on' or 'off'
or set the flag --telemetry=on|off`;
printFrame(message);
};
const getHintsForTelemetry = (hints?: HintsConfigObject | (string | any)[]) => {
if (!hints) {
return null;
}
const normalizedHints = normalizeHints(hints);
const result = {} as HintsConfigObject;
for (const [hintId, severity] of Object.entries(normalizedHints)) {
result[hintId] = typeof severity === 'string' ? severity : (severity as [HintSeverity, any])[0];
}
return result;
};
const pruneUserConfig = (userConfig: UserConfig) => {
return {
browserslist: userConfig.browserslist,
connector: userConfig.connector ? (userConfig.connector as ConnectorConfig).name || userConfig.connector : undefined,
extends: userConfig.extends,
formatters: userConfig.formatters,
hints: getHintsForTelemetry(getHintsFromConfiguration(userConfig)),
hintsTimeout: userConfig.hintsTimeout,
language: userConfig.language,
parsers: userConfig.parsers
};
};
const askForTelemetryConfirmation = async () => {
showTelemetryMessage();
const message = `Do you want to opt-in?`;
debug(`Prompting telemetry permission.`);
const telemetryEnabled = await askQuestion(message);
if (telemetryEnabled) {
appInsights.enable();
} else {
appInsights.disable();
}
return telemetryEnabled;
};
/** Ask user if he wants to activate the telemetry or not. */
const sendTelemetryIfEnabled = async (userConfig: UserConfig) => {
const telemetryConfigured = appInsights.isConfigured();
let telemetryEnabled = appInsights.isEnabled();
const alreadyRun: boolean = configStore.get(alreadyRunKey);
if (!alreadyRun) {
configStore.set(alreadyRunKey, true);
}
if (!telemetryConfigured) {
if (isCI) {
showCITelemetryMessage();
telemetryEnabled = false;
} else if (alreadyRun) {
/* Only prompt the user about opt-intelemetry if they have run webhint before. */
telemetryEnabled = await askForTelemetryConfirmation();
if (telemetryEnabled) {
appInsights.trackEvent('cli-telemetry');
}
}
}
if (!telemetryEnabled) {
return;
}
appInsights.trackEvent('cli-analyze', {
ci: isCI,
previouslyRun: alreadyRun,
...pruneUserConfig(userConfig)
});
};
/**
* Prints a message telling the user a valid configuration couldn't be found and the
* defaults will be used.
*/
const showDefaultMessage = () => {
const defaultMessage = `${chalk.yellow(`Couldn't find any valid configuration`)}
Running hint with the default configuration.
Learn more about how to create your own configuration at:
${chalk.green('https://webhint.io/docs/user-guide/')}`;
printFrame(defaultMessage);
};
const areFiles = (targets: URL[]) => {
return targets.every((target) => {
return target.protocol === 'file:';
});
};
const anyFile = (targets: URL[]) => {
return targets.some((target) => {
return target.protocol === 'file:';
});
};
/**
* Prints a message to the screen alerting the user the default configuration
* will be used and returns the default configuration.
*/
const getDefaultConfiguration = (targets: URL[]) => {
showDefaultMessage();
const targetsAreFiles = areFiles(targets);
if (!targetsAreFiles && anyFile(targets)) {
// TODO: Improve this message.
throw new Error('You cannot mix file system with urls in the analysis');
}
const ext = targetsAreFiles ? 'development' : 'web-recommended';
const config = { extends: [ext] } as UserConfig;
if (isCI) {
config.formatters = ['html', 'stylish'];
}
return config;
};
const askUserToUseDefaultConfiguration = async (targets: URL[]): Promise<UserConfig | null> => {
const question: string = `A valid configuration file can't be found. Do you want to use the default configuration? To know more about the default configuration see: https://webhint.io/docs/user-guide/#default-configuration`;
const confirmation: boolean = await askQuestion(question);
if (confirmation) {
return getDefaultConfiguration(targets);
}
return null;
};
/** Prints the list of missing and incompatible resources found. */
const showMissingAndIncompatiblePackages = (resources: HintResources) => {
if (resources.missing.length > 0) {
logger.log(`The following ${resources.missing.length === 1 ? 'package is' : 'packages are'} missing:
${resources.missing.join(', ')}`);
}
if (resources.incompatible.length > 0) {
logger.log(`The following ${resources.incompatible.length === 1 ? 'package is' : 'packages are'} incompatible:
${resources.incompatible.join(', ')}`);
}
};
const askUserToInstallDependencies = async (resources: HintResources): Promise<boolean> => {
showMissingAndIncompatiblePackages(resources);
const dependencies: string[] = resources.incompatible.concat(resources.missing);
const question: string = `There ${dependencies.length === 1 ? 'is a package' : 'are packages'} from your .hintrc file not installed or with an incompatible version. Do you want us to try to install/update them?`;
const answer: boolean = await askQuestion(question);
return answer;
};
/** Get language. If language is not in the config file or CLI options, get the language configure in the OS. */
const getLanguage = async (userConfig?: UserConfig, actions?: CLIOptions): Promise<string> => {
if (actions && actions.language) {
debug(`Using language option provided from command line: ${actions.language}`);
return actions.language;
}
if (userConfig && userConfig.language) {
debug(`Using language option provided in user config file: ${userConfig.language}`);
return userConfig.language;
}
const osLanguage = await osLocale();
debug(`Using language option configured in the OS: ${osLanguage}`);
return osLanguage;
};
const loadUserConfig = async (actions: CLIOptions, targets: URL[]): Promise<UserConfig> => {
let userConfig = getUserConfig(actions.config);
if (!userConfig) {
userConfig = getDefaultConfiguration(targets);
}
userConfig.language = await getLanguage(userConfig, actions);
userConfig = mergeEnvWithOptions(userConfig) as UserConfig;
return userConfig;
};
const askToInstallPackages = async (resources: HintResources): Promise<boolean> => {
if (resources.missing.length > 0) {
appInsights.trackEvent('cli-missing', resources.missing);
}
if (resources.incompatible.length > 0) {
appInsights.trackEvent('cli-incompatible', resources.incompatible);
}
const missingPackages = resources.missing.map((name) => {
return `@hint/${name}`;
});
const incompatiblePackages = resources.incompatible.map((name) => {
// If the packages are incompatible, we need to force to install the latest version.
return `@hint/${name}@latest`;
});
if (!(await askUserToInstallDependencies(resources) &&
await installPackages(missingPackages) &&
await installPackages(incompatiblePackages))) {
// The user doesn't want to install the dependencies or something went wrong installing them
return false;
}
// After installing all the packages, we need to load the resources again.
return true;
};
const getAnalyzer = async (userConfig: UserConfig, options: CreateAnalyzerOptions, targets: URL[]): Promise<Analyzer> => {
let webhint: Analyzer;
try {
webhint = createAnalyzer(userConfig, options);
} catch (e) {
const error = e as AnalyzerError;
if (error.status === AnalyzerErrorStatus.ConfigurationError) {
const config = await askUserToUseDefaultConfiguration(targets);
if (!config) {
throw e;
}
return getAnalyzer(config, options, targets);
}
if (error.status === AnalyzerErrorStatus.ResourceError) {
const installed = await askToInstallPackages(error.resources!);
if (!installed) {
throw e;
}
return getAnalyzer(userConfig, options, targets);
}
if (error.status === AnalyzerErrorStatus.HintError) {
logger.error(`Invalid hint configuration in .hintrc: ${error.invalidHints!.join(', ')}.`);
throw e;
}
if (error.status === AnalyzerErrorStatus.ConnectorError) {
logger.error(`Invalid connector configuration in .hintrc`);
throw e;
}
/*
* If the error is not an AnalyzerErrorStatus
* bubble up the exception.
*/
logger.error(e.message, e);
throw e;
}
return webhint;
};
const actionsToOptions = (actions: CLIOptions): CreateAnalyzerOptions => {
const options: CreateAnalyzerOptions = {
formatters: actions.formatters ? actions.formatters.split(',') : undefined,
hints: actions.hints ? actions.hints.split(',') : undefined,
watch: actions.watch
};
return options;
};
/*
* ------------------------------------------------------------------------------
* Public
* ------------------------------------------------------------------------------
*/
/** Analyzes a website if indicated by `actions`. */
export default async (actions: CLIOptions): Promise<boolean> => {
const targets = getAsUris(actions._);
if (targets.length === 0) {
return false;
}
const userConfig = await loadUserConfig(actions, targets);
const createAnalyzerOptions = actionsToOptions(actions);
let webhint: Analyzer;
try {
webhint = await getAnalyzer(userConfig, createAnalyzerOptions, targets);
} catch (e) {
return false;
}
const start = Date.now();
let exitCode = 0;
const endSpinner = (method: string) => {
if (!actions.debug && (spinner as any)[method]) {
(spinner as any)[method]();
}
};
const hasIssues = (reports: Problem[]): boolean => {
const threshold = userConfig.severityThreshold || Severity.error;
for (const result of reports) {
if (result.severity >= threshold) {
return true;
}
}
return false;
};
const print = async (reports: Problem[], target?: string, scanTime?: number, date?: string): Promise<void> => {
await webhint.format(reports, {
config: userConfig || undefined,
date,
output: actions.output ? path.resolve(cwd(), actions.output) : undefined,
resources: webhint.resources,
scanTime,
target,
version: loadHintPackage().version
});
};
const getAnalyzeOptions = (): AnalyzeOptions => {
const scanStart = new Map<string, number>();
const analyzerOptions: AnalyzeOptions = {
targetEndCallback: undefined,
targetStartCallback: undefined,
updateCallback: undefined
};
/* istanbul ignore else */
if (!actions.debug) {
analyzerOptions.updateCallback = (update) => {
spinner.text = update.message;
};
}
analyzerOptions.targetStartCallback = (start) => {
if (!actions.debug) {
spinner.start();
}
scanStart.set(start.url, Date.now());
};
analyzerOptions.targetEndCallback = async (end) => {
const scanEnd = Date.now();
const start = scanStart.get(end.url) || 0;
if (hasIssues(end.problems)) {
exitCode = 1;
}
endSpinner(exitCode ? 'fail' : 'succeed');
await print(end.problems, end.url, scanEnd - start, new Date(start).toISOString());
};
return analyzerOptions;
};
try {
await webhint.analyze(targets, getAnalyzeOptions());
await sendTelemetryIfEnabled(userConfig!);
} catch (e) {
exitCode = 1;
endSpinner('fail');
debug(`Failed to analyze: ${e.url}`);
debug(e);
}
debug(`Total runtime: ${Date.now() - start}ms`);
return exitCode === 0;
};