forked from thomasdavis/w3cjs
/
w3c-html-validator.ts
203 lines (193 loc) · 10 KB
/
w3c-html-validator.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
// W3C HTML Validator ~ MIT License
// Imports
import chalk from 'chalk';
import fs from 'fs';
import log from 'fancy-log';
import request from 'superagent';
import slash from 'slash';
// Type Declarations
export type ValidatorSettings = {
html: string, //example: '<!doctype html><html><head><title>Home</title></html>''
filename: string, //example: 'docs/index.html'
website: string, //example: 'https://pretty-print-json.js.org/'
checkUrl: string, //default: 'https://validator.w3.org/nu/'
ignoreLevel: 'info' | 'warning', //skip unwanted validation messages ('warning' also skips 'info')
ignoreMessages: (string | RegExp)[], //patterns to skip unwanted validation messages
output: ValidatorResultsOutput, //'json' or 'html'
dryRun: boolean, //bypass validation (for usage while building your CI)
};
export type ValidatorResultsMessage = {
// type subType
// -------------------- --------------------------------------------------
// 'info' 'warning' | undefined (informative)
// 'error' 'fatal' | undefined (spec violation)
// 'non-document-error' 'io' | 'schema' | 'internal' | undefined (external)
// 'network-error' undefined (network request failure)
type: 'info' | 'error' | 'non-document-error' | 'network-error',
subType?: 'warning' | 'fatal' | 'io' | 'schema' | 'internal',
message: string, //example: 'Section lacks heading.'
extract: string, //example: '<section>Hi</section>'
lastLine: number,
firstColumn: number,
lastColumn: number,
hiliteStart: number,
hiliteLength: number,
};
export type ValidatorResultsMessageType = ValidatorResultsMessage['type'];
export type ValidatorResultsMessageSubType = ValidatorResultsMessage['subType'];
export type ValidatorResults = {
validates: boolean,
mode: 'html' | 'filename' | 'website',
title: string,
html: string | null,
filename: string | null,
website: string | null,
output: 'json' | 'html',
status: number,
messages: ValidatorResultsMessage[] | null,
display: string | null,
dryRun: boolean,
};
export type ValidatorResultsOutput = ValidatorResults['output'];
export type ReporterSettings = {
continueOnFail: boolean, //report messages but do not throw an error if validation failed
maxMessageLen: number | null, //trim validation messages to not exceed a maximum length
quiet: boolean, //suppress messages for successful validations
title: string | null, //override display title (useful for naming HTML string inputs)
};
// W3C HTML Validator
const w3cHtmlValidator = {
version: '{{package.version}}',
validate(options: Partial<ValidatorSettings>): Promise<ValidatorResults> {
const defaults = {
checkUrl: 'https://validator.w3.org/nu/',
dryRun: false,
ignoreLevel: null,
ignoreMessages: [],
output: 'json',
};
const settings = { ...defaults, ...options };
if (!settings.html && !settings.filename && !settings.website)
throw Error('[w3c-html-validator] Must specify the "html", "filename", or "website" option.');
if (![null, 'info', 'warning'].includes(settings.ignoreLevel))
throw Error('[w3c-html-validator] Invalid ignoreLevel option: ' + settings.ignoreLevel);
if (settings.output !== 'json' && settings.output !== 'html')
throw Error('[w3c-html-validator] Option "output" must be "json" or "html".');
const filename = settings.filename ? slash(settings.filename) : null;
const mode = settings.html ? 'html' : filename ? 'filename' : 'website';
const readFile = (filename: string) => fs.readFileSync(filename, 'utf-8').replace(/\r/g, '');
const inputHtml = settings.html ?? (filename ? readFile(filename) : null);
const makePostRequest = () => request.post(settings.checkUrl)
.set('Content-Type', 'text/html; encoding=utf-8')
.send(<string>inputHtml);
const makeGetRequest = () => request.get(settings.checkUrl)
.query({ doc: settings.website });
const w3cRequest = inputHtml ? makePostRequest() : makeGetRequest();
w3cRequest.set('User-Agent', 'W3C HTML Validator ~ github.com/center-key/w3c-html-validator');
w3cRequest.query({ out: settings.output });
const json = settings.output === 'json';
const success = '<p class="success">';
const titleLookup = {
html: 'HTML String (characters: ' + inputHtml?.length + ')',
filename: filename,
website: settings.website,
};
const filterMessages = (response: request.Response): request.Response => {
const aboveInfo = (subType: ValidatorResultsMessageSubType): boolean =>
settings.ignoreLevel === 'info' && !!subType;
const aboveIgnoreLevel = (message: ValidatorResultsMessage): boolean =>
!settings.ignoreLevel || message.type !== 'info' || aboveInfo(message.subType);
const matchesSkipPattern = (title: string): boolean =>
settings.ignoreMessages.some(pattern =>
typeof pattern === 'string' ? title.includes(pattern) : pattern.test(title));
const isImportant = (message: ValidatorResultsMessage): boolean =>
aboveIgnoreLevel(message) && !matchesSkipPattern(message.message);
if (json)
response.body.messages = response.body.messages?.filter(isImportant) ?? [];
return response;
};
const toValidatorResults = (response: request.Response): ValidatorResults => ({
validates: json ? !response.body.messages.length : !!response.text?.includes(success),
mode: mode,
title: <string>titleLookup[mode],
html: inputHtml,
filename: filename,
website: settings.website || null,
output: <ValidatorResultsOutput>settings.output,
status: response.statusCode || -1,
messages: json ? response.body.messages : null,
display: json ? null : response.text,
dryRun: settings.dryRun,
});
type ReasonResponse = { request: { url: string }, res: { statusMessage: string }};
type ReasonError = Error & { errno: number, response: request.Response & ReasonResponse };
const handleError = (reason: ReasonError): ValidatorResults => {
const errRes = reason.response ?? <ReasonError['response']>{};
const getMsg = () => [errRes.status, errRes.res.statusMessage, errRes.request.url];
const message = reason.response ? getMsg() : [reason.errno, reason.message];
errRes.body = { messages: [{ type: 'network-error', message: message.join(' ') }] };
return toValidatorResults(errRes);
};
const pseudoResponse = <request.Response>{
statusCode: 200,
body: { messages: [] },
text: 'Validation bypassed.',
};
const pseudoRequest = (): Promise<request.Response> =>
new Promise(resolve => resolve(pseudoResponse));
const validation = settings.dryRun ? pseudoRequest() : w3cRequest;
return validation.then(filterMessages).then(toValidatorResults).catch(handleError);
},
dryRunNotice() {
log(chalk.gray('w3c-html-validator'),
chalk.yellowBright('dry run mode:'), chalk.whiteBright('validation being bypassed'));
},
summary(numFiles: number) {
log(chalk.gray('w3c-html-validator'), chalk.magenta('files: ' + numFiles));
},
reporter(results: ValidatorResults, options?: Partial<ReporterSettings>): ValidatorResults {
const defaults = {
continueOnFail: false,
maxMessageLen: null,
quiet: false,
title: null,
};
const settings = { ...defaults, ...options };
if (typeof results?.validates !== 'boolean')
throw Error('[w3c-html-validator] Invalid results for reporter(): ' + String(results));
const messages = results.messages ?? [];
const title = settings.title ?? results.title;
const status = results.validates ? chalk.green.bold('✔ pass') : chalk.red.bold('✘ fail');
const count = results.validates ? '' : '(messages: ' + messages!.length + ')';
if (!results.validates || !settings.quiet)
log(chalk.gray('w3c-html-validator'), status, chalk.blue.bold(title), chalk.white(count));
const typeColorMap = {
error: chalk.red.bold,
warning: chalk.yellow.bold,
info: chalk.white.bold,
};
const logMessage = (message: ValidatorResultsMessage) => {
const type = <keyof typeof typeColorMap>(message.subType ?? message.type);
const typeColor = typeColorMap[type] ?? chalk.redBright.bold;
const location = `line ${message.lastLine}, column ${message.firstColumn}:`;
const lineText = message.extract?.replace(/\n/g, '\\n');
const maxLen = settings.maxMessageLen ?? undefined;
log(typeColor('HTML ' + type + ':'), message.message.substring(0, maxLen));
if (message.lastLine)
log(chalk.white(location), chalk.magenta(lineText));
};
messages.forEach(logMessage);
const failDetails = () => {
// Example: 'spec/html/invalid.html -- warning line 9 column 4, error line 12 column 10'
const toString = (message: ValidatorResultsMessage) =>
`${message.subType ?? message.type} line ${message.lastLine} column ${message.firstColumn}`;
const fileDetails = () =>
results.filename + ' -- ' + results.messages!.map(toString).join(', ');
return !results.filename ? results.messages![0]!.message : fileDetails();
};
if (!settings.continueOnFail && !results.validates)
throw Error('[w3c-html-validator] Failed: ' + failDetails());
return results;
},
};
export { w3cHtmlValidator };