lint for usage of setTimeout (#5)

web-platform-tests · Feb 22, 2017 · 95b0f83 · 95b0f83
1 parent 0bceacb
commit 95b0f83
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/lint/lint.py b/lint/lint.py
@@ -145,6 +145,12 @@ class CRRegexp(Regexp):
     error = "CR AT EOL"
     description = "CR character in line separator"
 
+class SetTimeoutRegexp(Regexp):
+    pattern = b"setTimeout\s*\("
+    error = "SET TIMEOUT"
+    file_extensions = [".html", ".htm", ".js", ".xht", ".xhtml", ".svg"]
+    description = "setTimeout used; step_timeout should typically be used instead"
+
 class W3CTestOrgRegexp(Regexp):
     pattern = b"w3c\-test\.org"
     error = "W3C-TEST.ORG"
@@ -171,6 +177,7 @@ class PrintRegexp(Regexp):
            [TrailingWhitespaceRegexp,
             TabsRegexp,
             CRRegexp,
+            SetTimeoutRegexp,
             W3CTestOrgRegexp,
             Webidl2Regexp,
             ConsoleRegexp,

diff --git a/lint/tests/test_file_lints.py b/lint/tests/test_file_lints.py
@@ -130,6 +130,21 @@ def test_console():
             assert errors == [("PARSE-FAILED", "Unable to parse file", filename, 1)]
 
 
+def test_setTimeout():
+    error_map = check_with_files(b"<script>setTimeout(() => 1, 10)</script>")
+
+    for (filename, (errors, kind)) in error_map.items():
+        check_errors(errors)
+
+        if kind == "python":
+            assert errors == [("PARSE-FAILED", "Unable to parse file", filename, 1)]
+        else:
+            assert errors == [('SET TIMEOUT',
+                               'setTimeout used; step_timeout should typically be used instead',
+                               filename,
+                               1)]
+
+
 def test_meta_timeout():
     code = b"""
 <html xmlns="http://www.w3.org/1999/xhtml">