Option ignoreMessage to filter on substr or regex

center-key · Jun 26, 2021 · bd3643b · bd3643b
1 parent 39677c8
commit bd3643b
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 19 deletions.
diff --git a/README.md b/README.md
@@ -42,16 +42,17 @@ width=800 alt=screenshot>
 
 ## 3) Options
 ### validate()
-| Name (key)    | Type                    | Default                          | Description                               |
-| :------------ | :---------------------- | :------------------------------- | :---------------------------------------- |
-| `html`        | **string**              | `null`                           | HTML string to validate.                  |
-| `filename`    | **string**              | `null`                           | HTML file to validate.                    |
-| `website`     | **string**              | `null`                           | URL of website to validate.               |
-| `checkUrl`    | **string**              | `'https://validator.w3.org/nu/'` | W3C validation API endpoint.              |
-| `ignoreLevel` | `'info'` or `'warning'` | `null`                           | Skip unwanted messages.*                  |
-| `output`      | `'json'` or `'html'`    | `'json'`                         | Get results as an array or as a web page. |
+| Name (key)      | Type                     | Default                          | Description                                                   |
+| :-------------- | :----------------------- | :------------------------------- | :------------------------------------------------------------ |
+| `html`          | **string**               | `null`                           | HTML string to validate.                                      |
+| `filename`      | **string**               | `null`                           | HTML file to validate.                                        |
+| `website`       | **string**               | `null`                           | URL of website to validate.                                   |
+| `checkUrl`      | **string**               | `'https://validator.w3.org/nu/'` | W3C validation API endpoint.                                  |
+| `ignoreMessage` | **string** or **RegExp** | `null`                           | Skip messages containing a string or matching an expression.* |
+| `ignoreLevel`   | `'info'` or `'warning'`  | `null`                           | Skip unwanted messages.*                                      |
+| `output`        | `'json'` or `'html'`     | `'json'`                         | Get results as an array or as a web page.                     |
 
-*The `ignoreLevel` option only works for `'json'` output.&nbsp;
+*The `ignoreMessage` and `ignoreLevel` options only work for `'json'` output.&nbsp;
 Option value `'warning'` also skips `'info'`.
 
 ### reporter()

diff --git a/spec/mocha.js b/spec/mocha.js
@@ -231,3 +231,43 @@ describe('Option ignoreLevel set to "warning"', () => {
       });
 
    });
+
+////////////////////////////////////////////////////////////////////////////////////////////////////
+describe.only('Option ignoreMessage', () => {
+   // Example validation messgaes:
+   // warning: 'Section lacks heading. Consider using “h2”-“h6” elements to add identifying headings to all sections.',
+   // error:   'Element “blockquote” not allowed as child of element “span” in this context. (Suppressing further errors from this subtree.)',
+
+   it('as a substring can skip "Section lacks heading" messages', (done) => {
+      const handleData = (data) => {
+         const actual = {
+            validates: data.validates,
+            messages:  data.messages.map(message => message.type),
+            };
+         const expected = {
+            validates: false,
+            messages: ['error'],
+            };
+         assertDeepStrictEqual(actual, expected, done);
+         };
+      const options = { filename: 'spec/html/invalid.html', ignoreMessage: 'Section lacks heading' };
+      w3cHtmlValidator.validate(options).then(handleData);
+      });
+
+   it('can skip messages matching a regular expression', (done) => {
+      const handleData = (data) => {
+         const actual = {
+            validates: data.validates,
+            messages:  data.messages.map(message => message.type),
+            };
+         const expected = {
+            validates: false,
+            messages: ['info'],
+            };
+         assertDeepStrictEqual(actual, expected, done);
+         };
+      const options = { filename: 'spec/html/invalid.html', ignoreMessage: /^Element .blockquote./ };
+      w3cHtmlValidator.validate(options).then(handleData);
+      });
+
+   });
diff --git a/w3c-html-validator.ts b/w3c-html-validator.ts
@@ -6,12 +6,13 @@ import log from 'fancy-log';
 import request from 'superagent';
 
 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')
-   output?:      ValidatorResultsOutput,
+   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')
+   ignoreMessage?: string | RegExp,  //matcher to skip unwanted messages
+   output?:        ValidatorResultsOutput,
    };
 export type ValidatorResultsMessage = {
    // type                  subType
@@ -55,9 +56,10 @@ const w3cHtmlValidator = {
 
    validate(options: ValidatorOptions): Promise<ValidatorResults> {
       const defaults = {
-         checkUrl:    'https://validator.w3.org/nu/',
-         ignoreLevel: null,
-         output:      'json',
+         checkUrl:      'https://validator.w3.org/nu/',
+         ignoreLevel:   null,
+         ignoreMessage: null,
+         output:        'json',
          };
       const settings = { ...defaults, ...options };
       if (!settings.html && !settings.filename && !settings.website)
@@ -89,8 +91,15 @@ const w3cHtmlValidator = {
             settings.ignoreLevel === 'info' && !!subType;
          const aboveIgnoreLevel = (message: ValidatorResultsMessage): boolean =>
             !settings.ignoreLevel || message.type !== 'info' || aboveInfo(message.subType);
+         const skipSubstr = (title: string) =>
+            typeof settings.ignoreMessage === 'string' && title.includes(settings.ignoreMessage);
+         const skipRegEx = (title: string) =>
+            settings.ignoreMessage?.constructor.name === 'RegExp' && 
+            (<RegExp>settings.ignoreMessage).test(title);
+         const isImportant = (message: ValidatorResultsMessage): boolean =>
+            aboveIgnoreLevel(message) && !skipSubstr(message.message) && !skipRegEx(message.message);
          if (json)
-            response.body.messages = response.body.messages?.filter(aboveIgnoreLevel) ?? [];
+            response.body.messages = response.body.messages?.filter(isImportant) ?? [];
          return response;
          };
       const toValidatorResults = (response: request.Response): ValidatorResults => ({