Pass regexp match into the lint description

As a start, lightly change lint.rules.Regexp, making it a subclass of
lint.rules.Rule, thus allowing it to use the generic
lint.rules.Rule.error.

With that done, we now pass the subpattern matches as the context to
the error factor, allowing them to be used in the description, thus
letting us give users better error descriptions.

Author: gsnedders

tools/lint/lint.py

@@ -339,25 +339,29 @@ def filter_ignorelist_errors(data: Ignorelist, errors: Sequence[rules.Error]) ->
     return [item for i, item in enumerate(errors) if not skipped[i]]
 
 
-regexps = [item() for item in  # type: ignore
-           [rules.TrailingWhitespaceRegexp,
-            rules.TabsRegexp,
-            rules.CRRegexp,
-            rules.SetTimeoutRegexp,
-            rules.W3CTestOrgRegexp,
-            rules.WebPlatformTestRegexp,
-            rules.Webidl2Regexp,
-            rules.ConsoleRegexp,
-            rules.GenerateTestsRegexp,
-            rules.PrintRegexp,
-            rules.LayoutTestsRegexp,
-            rules.MissingDepsRegexp,
-            rules.SpecialPowersRegexp,
-            rules.AssertThrowsRegexp,
-            rules.PromiseRejectsRegexp,
-            rules.AssertPreconditionRegexp,
-            rules.HTMLInvalidSyntaxRegexp,
-            rules.TestDriverInternalRegexp]]
+regexps: Sequence[rules.Regexp] = [
+    item()
+    for item in (
+        rules.TrailingWhitespaceRegexp,
+        rules.TabsRegexp,
+        rules.CRRegexp,
+        rules.SetTimeoutRegexp,
+        rules.W3CTestOrgRegexp,
+        rules.WebPlatformTestRegexp,
+        rules.Webidl2Regexp,
+        rules.ConsoleRegexp,
+        rules.GenerateTestsRegexp,
+        rules.PrintRegexp,
+        rules.LayoutTestsRegexp,
+        rules.MissingDepsRegexp,
+        rules.SpecialPowersRegexp,
+        rules.AssertThrowsRegexp,
+        rules.PromiseRejectsRegexp,
+        rules.AssertPreconditionRegexp,
+        rules.HTMLInvalidSyntaxRegexp,
+        rules.TestDriverInternalRegexp,
+    )
+]
 
 
 def check_regexp_line(repo_root: Text, path: Text, f: IO[bytes]) -> List[rules.Error]:
@@ -367,8 +371,13 @@ def check_regexp_line(repo_root: Text, path: Text, f: IO[bytes]) -> List[rules.E
 
     for i, line in enumerate(f):
         for regexp in applicable_regexps:
-            if regexp.search(line):
-                errors.append((regexp.name, regexp.description, path, i+1))
+            m = regexp.search(line)
+            if m:
+                groups = tuple(
+                    g.decode("ascii", "backslashreplace") if g is not None else None
+                    for g in m.groups()
+                )
+                errors.append(regexp.error(path, context=groups, line_no=i+1))
 
     return errors
 

tools/lint/rules.py

@@ -390,19 +390,11 @@ class MissingTestInWebFeaturesFile(Rule):
 EXTENSIONS["js_all"] = EXTENSIONS["markup"] + EXTENSIONS["js"]
 
 
-class Regexp(metaclass=abc.ABCMeta):
+class Regexp(Rule, metaclass=abc.ABCMeta):
     @abc.abstractproperty
     def pattern(self) -> bytes:
         pass
 
-    @abc.abstractproperty
-    def name(self) -> Text:
-        pass
-
-    @abc.abstractproperty
-    def description(self) -> Text:
-        pass
-
     file_extensions: Optional[List[Text]] = None
 
     def __init__(self) -> None:
@@ -506,7 +498,7 @@ class LayoutTestsRegexp(Regexp):
     pattern = br"(eventSender|testRunner|internals)\."
     name = "LAYOUTTESTS APIS"
     file_extensions = EXTENSIONS["js_all"]
-    description = "eventSender/testRunner/internals used; these are LayoutTests-specific APIs (WebKit/Blink)"
+    description = "%s used; this is a LayoutTests-specific API (WebKit/Blink)"
 
 
 class MissingDepsRegexp(Regexp):
@@ -560,10 +552,10 @@ class HTMLInvalidSyntaxRegexp(Regexp):
                br"dfn|dialog|div|dl|dt|em|fieldset|figcaption|figure|footer|form|h[1-6]|head|header|html|i|iframe|ins|kbd|label|legend|li|"
                br"main|map|mark|menu|meter|nav|noscript|object|ol|optgroup|option|output|p|picture|pre|progress|q|rp|rt|ruby|s|samp|script|"
                br"search|section|select|slot|small|span|strong|style|sub|summary|sup|table|tbody|td|template|textarea|tfoot|th|thead|time|"
-               br"title|tr|u|ul|var|video)(\s+[^>]+)?\s*/>")
+               br"title|tr|u|ul|var|video)(?:\s+[^>]+)?\s*/>")
     name = "HTML INVALID SYNTAX"
     file_extensions = EXTENSIONS["html"]
-    description = "Test-file line has a non-void HTML tag with /> syntax"
+    description = "Test-file line has a non-void HTML %s tag with /> syntax"
     to_fix = """Replace with start tag and end tag"""
 
 

tools/lint/tests/test_file_lints.py

@@ -168,7 +168,7 @@ def test_eventSender():
             assert errors == [("PARSE-FAILED", "Unable to parse file", filename, 1)]
         else:
             assert errors == [('LAYOUTTESTS APIS',
-                               'eventSender/testRunner/internals used; these are LayoutTests-specific APIs (WebKit/Blink)',
+                               'eventSender used; this is a LayoutTests-specific API (WebKit/Blink)',
                                filename,
                                1)]
 
@@ -183,7 +183,7 @@ def test_testRunner():
             assert errors == [("PARSE-FAILED", "Unable to parse file", filename, 1)]
         else:
             assert errors == [('LAYOUTTESTS APIS',
-                               'eventSender/testRunner/internals used; these are LayoutTests-specific APIs (WebKit/Blink)',
+                               'testRunner used; this is a LayoutTests-specific API (WebKit/Blink)',
                                filename,
                                1)]
 
@@ -198,7 +198,7 @@ def test_internals():
             assert errors == [("PARSE-FAILED", "Unable to parse file", filename, 1)]
         else:
             assert errors == [('LAYOUTTESTS APIS',
-                               'eventSender/testRunner/internals used; these are LayoutTests-specific APIs (WebKit/Blink)',
+                               'internals used; this is a LayoutTests-specific API (WebKit/Blink)',
                                filename,
                                1)]
 
@@ -240,7 +240,7 @@ def test_html_invalid_syntax():
         check_errors(errors)
 
         if kind == "web-lax":
-            assert errors == [("HTML INVALID SYNTAX", "Test-file line has a non-void HTML tag with /> syntax", filename, 1)]
+            assert errors == [("HTML INVALID SYNTAX", "Test-file line has a non-void HTML div tag with /> syntax", filename, 1)]
 
 
 def test_testdriver_internal():