Revamp parsing to work with htmlhint's new json output format introduced in 0.9.8. Use direct JSON parsing rather than regular expressions.

Author: mmaday

README.md

@@ -13,14 +13,14 @@ Before using this plugin, you must ensure that `htmlhint` is installed on your s
 
 1. Install [Node.js](http://nodejs.org) (and [npm](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager) on Linux).
 
-1. Install `htmlhint` by typing the following in a terminal:
+1. Install the latest `htmlhint` by typing the following in a terminal:
    ```
-   npm install -g htmlhint@0.9.7
+   npm install -g htmlhint@latest
    ```
 
 1. If you are using `nvm` and `zsh`, ensure that the line to load `nvm` is in `.zshenv` and not `.zshrc`.
 
-**Note:** This plugin requires `htmlhint` 0.9.0 - 0.9.7. Later versions are currently not supported.
+**Note:** This plugin requires `htmlhint` 0.9.8 or greater. Upgrade your existing installation by running step 2 above.
 
 ### Linter configuration
 In order for `htmlhint` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in [“Finding a linter executable”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation.

linter.py

@@ -10,7 +10,7 @@
 
 """This module exports the Htmlhint plugin class."""
 
-import re
+import sublime
 from SublimeLinter.lint import Linter, persist
 
 
@@ -19,37 +19,54 @@ class Htmlhint(Linter):
     """Provides an interface to htmlhint."""
 
     syntax = 'html'
-    cmd = 'htmlhint'
+    cmd = ('htmlhint', '--format', 'json')
     version_args = '--version'
     version_re = r'(?P<version>\d+\.\d+\.\d+)'
-    version_requirement = '>= 0.9.0, <= 0.9.7'
-    regex = r'^\s*line (?P<line>\d+), col (?P<col>\d+): (?P<message>.+)'
+    version_requirement = '>= 0.9.8'
+    # empty regex so plugin initializes properly
+    regex = r''
     tempfile_suffix = '-'
     config_file = ('--config', '.htmlhintrc', '~')
 
-    # htmlhint uses color codes to distinguish errors and warnings
-    # colors get stripped by sublimelinter
-    # match warnings instead
-    warn_regex = (
-        r'^(Doctype must be html5.'
-        r'|The script tag can not be used in head'
-        r'|The value of href \[ .*?\] must be'
-        r'|The value of .*? can not use ad keyword.'
-        r'|Alt of img tag must be set value.'
-        r'|Mixed spaces and tabs in front of line'
-        r'|Style tag can not be use'
-        r'|The empty tag : \[ \w+ \] must closed by self.)'
-    )
-    warn_re = re.compile(warn_regex)
-
-    def split_match(self, match):
-        match, line, col, error, warning, message, near = super().split_match(match)
-        if match:
-            # check if message is a warning
-            warn = self.warn_re.match(message)
-            if warn:
-                return match, line, col, False, True, message, near
-
-            persist.debug('match -- msg:"{}", match:{}, line:{}, col:{}, near:{}, warn: {}'.format(message, match, line, col, near, warn))
-
-        return match, line, col, error, warning, message, near
+    def find_errors(self, output):
+        """
+        Override find_errors, parsing output json into json_object.
+
+        Calls parse_message for each error found.
+
+        """
+
+        output_json = sublime.decode_value(output)
+
+        # persist.debug('output_json:"{}", file: "{}"'.format(output_json, self.filename))
+
+        for file in output_json:
+            for message in file['messages']:
+                yield self.parse_message(message)
+
+    def parse_message(self, message):
+        """
+        Parse message object into standard elements of an error and return them.
+
+        """
+
+        error_message = message['message']
+        line = message['line'] - 1
+        col = message['col']
+
+        # set error and warning flags based on message type
+        error = None
+        warning = None
+        if message['type'] == 'error':
+            error = True
+            warning = False
+        elif message['type'] == 'warning':
+            error = False
+            warning = True
+        elif message['type'] == 'info':
+            # ignore info messages by setting message to None
+            message = None
+
+        persist.debug('message -- msg:"{}", line:{}, col:{}, error: {}, warning: {}, message_obj:{}'.format(error_message, line, col, error, warning, message))
+
+        return message, line, col, error, warning, error_message, None

messages.json

@@ -1,4 +1,5 @@
 {
     "install": "messages/install.txt",
-    "1.0.1": "messages/1.0.1.txt"
+    "1.0.1": "messages/1.0.1.txt",
+    "1.1.0": "messages/1.1.0.txt"
 }

messages/1.1.0.txt

@@ -0,0 +1,10 @@
+SublimeLinter-contrib-htmlhint 1.1.0
+------------------------------------
+This plugin has been rewritten to handle the latest output formats of htmlhint version 0.9.8 and later. It now parses the JSON output of htmlhint.
+
+*** NOTE: htmlhint version 0.9.8 and greater is now required. ***
+
+Upgrade your existing htmlhint to the latest by running:
+npm install -g htmlhint@latest
+
+Please refer to https://github.com/mmaday/SublimeLinter-contrib-htmlhint for complete installation instructions.