Merge pull request #196 from SublimeLinter/format-json

Experiment: Use JSON format and provided endLine and endColumn for highlights

Author: kaste

linter.py

@@ -10,6 +10,7 @@
 
 """This module exports the ESLint plugin class."""
 
+import json
 import logging
 import re
 from SublimeLinter.lint import NodeLinter
@@ -22,13 +23,8 @@ class ESLint(NodeLinter):
     """Provides an interface to the eslint executable."""
 
     npm_name = 'eslint'
-    cmd = ('eslint', '--format', 'compact', '--stdin', '--stdin-filename', '@')
+    cmd = ('eslint', '--format', 'json', '--stdin', '--stdin-filename', '@')
 
-    regex = (
-        r'^.+?: line (?P<line>\d+), col (?P<col>\d+), '
-        r'(?:(?P<error>Error)|(?P<warning>Warning)) - '
-        r'(?P<message>.+)'
-    )
     crash_regex = re.compile(
         r'^(.*?)\r?\n\w*(Oops! Something went wrong!)',
         re.DOTALL
@@ -46,17 +42,44 @@ def find_errors(self, output):
         match = self.crash_regex.match(output)
         if match:
             logger.error(output)
-            return []
+            return
 
-        return super().find_errors(output)
+        content = json.loads(output)
 
-    def split_match(self, match):
-        """Extract and return values from match.
+        if logger.isEnabledFor(logging.INFO):
+            import pprint
+            logger.info(
+                '{} output:\n{}'.format(self.name, pprint.pformat(content)))
 
-        Return 'no match' for ignored files
-        """
-        match, line, col, error, warning, message, near = super().split_match(match)
-        if message and message.startswith('File ignored'):
-            return match, None, None, None, None, '', None
+        for entry in content:
+            for match in entry['messages']:
+                if match['message'].startswith('File ignored'):
+                    continue
+
+                yield (
+                    match,
+                    match['line'] - 1,  # apply line_col_base manually
+                    match['column'] - 1,
+                    match['ruleId'] if match['severity'] == 2 else '',
+                    match['ruleId'] if match['severity'] == 1 else '',
+                    match['message'],
+                    None  # near
+                )
+
+    def reposition_match(self, line, col, m, vv):
+        match = m.match
+        if match.get('fatal', False):  # parse error
+            text = vv.select_line(line)
+            return line, 0, len(text)  # select whole line?
+            return super().reposition_match(line, col, m, vv)
+
+        # apply line_col_base manually
+        end_line = match.get('endLine', line + 1) - 1
+        # to ensure a length of 1, add 2 to the starting col
+        end_column = match.get('endColumn', col + 2) - 1
+
+        for _line in range(line, end_line):
+            text = vv.select_line(_line)
+            end_column += len(text)
 
-        return match, line, col, error, warning, message, near
+        return line, col, end_column