w3c-html-validator/w3c-html-validator.ts at main · kevintap/w3c-html-validator · GitHub

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
// W3C HTML Validator ~ MIT License

// Imports
import { readFileSync } from 'fs';
import chalk            from 'chalk';
import log              from 'fancy-log';
import request          from 'superagent';

// Type Declarations
export type ValidatorOptions = {
   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,
   ignoreLevel?:    'info' | 'warning',  //skip unwanted messages ('warning' also skips 'info')
   ignoreMessages?: string | RegExp,  //matcher to skip unwanted messages
   output?:         ValidatorResultsOutput,
   };
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,
   };
export type ValidatorResultsOutput = ValidatorResults['output'];
export type ReporterOptions = {
   maxMessageLen?: number | null,  //trim validation messages to not exceed a maximum length
   title?:         string | null,  //override display title (useful for naming HTML string inputs)
   };

// W3C HTML Validator
const w3cHtmlValidator = {

   version: '~~~version~~~',

   validate(options: ValidatorOptions): Promise<ValidatorResults> {
      const defaults = {
         checkUrl:       'https://validator.w3.org/nu/',
         ignoreLevel:    null,
         ignoreMessages: null,
         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 mode = settings.html ? 'html' : settings.filename ? 'filename' : 'website';
      const readFile = () => settings.filename ? readFileSync(settings.filename, 'utf8') : null;
      const inputHtml = settings.html || readFile();
      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: settings.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 skipSubstr = (title: string) =>
            typeof settings.ignoreMessages === 'string' && title.includes(settings.ignoreMessages);
         const skipRegEx = (title: string) =>
            settings.ignoreMessages?.constructor.name === 'RegExp' &&
            (<RegExp>settings.ignoreMessages).test(title);
         const isImportant = (message: ValidatorResultsMessage): boolean =>
            aboveIgnoreLevel(message) && !skipSubstr(message.message) && !skipRegEx(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:  settings.filename || null,
         website:   settings.website || null,
         output:    <ValidatorResultsOutput>settings.output,
         status:    response.statusCode || -1,
         messages:  json ? response.body.messages : null,
         display:   json ? null : response.text,
         });
      const handleError = (reason: Error): ValidatorResults => {
         const response =   reason['response'];
         const getMsg =     () => [response.status, response.res.statusMessage, response.request.url];
         const message =    response ? getMsg() : [reason['errno'], reason.message];
         const networkErr = { type: 'network-error', message: message.join(' ') };
         return toValidatorResults({ ...response, ...{ body: { messages: [networkErr] } } });
         };
      return w3cRequest.then(filterMessages).then(toValidatorResults).catch(handleError);
      },

   reporter(results: ValidatorResults, options?: ReporterOptions): ValidatorResults {
      const defaults = {
         maxMessageLen: null,
         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 fail =   'fail (messages: ' + messages!.length  + ')';
      const status = results.validates ? chalk.green('pass') : chalk.red.bold(fail);
      log(chalk.gray('w3c-html-validator'), chalk.blue.bold(title), status);
      const typeColorMap = {
         error:   chalk.red.bold,
         warning: chalk.yellow.bold,
         info:    chalk.white.bold,
         };
      const logMessage = (message: ValidatorResultsMessage) => {
         const type =      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);
      return results;
      },

   };

export { w3cHtmlValidator };