ESLintBear.py: Add settings from eslint

Add settings to support javascript variant
typescript. Settings to check javascript code
in markdown and html files and settings to support
global variables.

Closes coala#2635

Author: saksham189

bear-requirements.yaml

@@ -45,8 +45,14 @@ npm_requirements:
     version: ~0.18
   eslint:
     version: ~3
+  eslint-plugin-html:
+    version: ~3.2.2
   eslint-plugin-import:
     version: ~2
+  eslint-plugin-markdown:
+    version: ~1.0.0-beta.6
+  eslint-plugin-typescript:
+    version: ~0.8.1
   gherkin-lint:
     version: ~2
   happiness:
@@ -121,6 +127,8 @@ npm_requirements:
     version: ~3
   typescript:
     version: '>=1.7.3'
+  typescript-eslint-parser:
+    version: ~12.0.0
   write-good:
     version: ~0.9.1
 pip_requirements:

bears/js/ESLintBear.py

@@ -5,6 +5,8 @@
 from coalib.results.Diff import Diff
 from coalib.results.RESULT_SEVERITY import RESULT_SEVERITY
 from coalib.results.Result import Result
+from coalib.settings.Setting import typed_list
+from coalib.settings.Setting import language
 
 
 @linter(executable='eslint',
@@ -17,10 +19,14 @@ class ESLintBear:
     Find out more at <http://eslint.org/docs/rules/>.
     """
 
-    LANGUAGES = {'JavaScript', 'JSX'}
+    LANGUAGES = {'JavaScript', 'JSX', 'Markdown', 'Typescript', 'HTML'}
     REQUIREMENTS = {NpmRequirement('eslint', '3'),
                     NpmRequirement('babel-eslint', '8.0'),
-                    NpmRequirement('eslint-plugin-import', '2')}
+                    NpmRequirement('eslint-plugin-import', '2'),
+                    NpmRequirement('typescript-eslint-parser', '12.0.0'),
+                    NpmRequirement('eslint-plugin-typescript', '0.8.1'),
+                    NpmRequirement('eslint-plugin-markdown', '1.0.0-beta.6'),
+                    NpmRequirement('eslint-plugin-html', '3.2.2')}
     AUTHORS = {'The coala developers'}
     AUTHORS_EMAILS = {'[email protected]'}
     LICENSE = 'AGPL-3.0'
@@ -32,9 +38,11 @@ class ESLintBear:
                     1: RESULT_SEVERITY.NORMAL,
                     0: RESULT_SEVERITY.INFO}
 
-    @staticmethod
-    def create_arguments(filename, file, config_file,
+    def create_arguments(self, filename, file, config_file,
                          eslint_config: str = '',
+                         language: language = language('JavaScript'),
+                         global_vars: typed_list(str) = (),
+                         eslint_env: typed_list(str) = (),
                          ):
         """
         :param eslint_config: The location of the .eslintrc config file.
@@ -47,6 +55,25 @@ def create_arguments(filename, file, config_file,
             '--stdin-filename=' + filename,
         )
 
+        if 'Markdown' in language:
+            args += ('--plugin', 'markdown',)
+        elif 'Typescript' in language:
+            args += ('--parser', 'typescript-eslint-parser',
+                     '--plugin', 'typescript')
+        elif 'HTML' in language:
+            args += ('--plugin', 'html')
+        elif 'Javascript' not in language:
+            self.err(
+                'Language needs to be either Markdown, HTML, TypeScript '
+                'or JavaScript. Assuming JavaScript.')
+
+        if eslint_env:
+            for env in eslint_env:
+                args += ('--env', env)
+        if global_vars:
+            for var in global_vars:
+                args += ('--global', var)
+
         if eslint_config:
             args += ('--config', eslint_config)
         else:

package.json

@@ -13,7 +13,10 @@
     "dockerfile_lint": "~0.3.2",
     "elm": "~0.18",
     "eslint": "~3",
+    "eslint-plugin-html": "~3.2.2",
     "eslint-plugin-import": "~2",
+    "eslint-plugin-markdown": "~1.0.0-beta.6",
+    "eslint-plugin-typescript": "~0.8.1",
     "gherkin-lint": "~2",
     "happiness": "~10",
     "htmlhint": "~0.9.13",
@@ -51,6 +54,7 @@
     "textlint-rule-write-good": "~1.6.0",
     "tslint": "~3",
     "typescript": ">=1.7.3",
+    "typescript-eslint-parser": "~12.0.0",
     "write-good": "~0.9.1"
   }
 }

tests/js/ESLintBearTest.py

@@ -7,6 +7,7 @@
 from coalib.results.Result import RESULT_SEVERITY, Result
 from coalib.settings.Section import Section
 from coalib.settings.Setting import Setting
+from coalib.bearlib.languages import Language
 from coalib.testing.BearTestHelper import generate_skip_decorator
 from coalib.testing.LocalBearTestHelper import (
     verify_local_bear,
@@ -46,6 +47,67 @@
 test();
 """
 
+test_file_global_vars = """
+(function(a,b,c) {
+    return [a, b, c];
+})(x,y,z)
+"""
+
+test_file_eslint_env = """
+(function(a) {
+    return a;
+})(suiteSetup)
+
+"""
+
+test_file_markdown = """
+# H1
+## H2
+```js
+// This gets linted
+var answer = 6 * 7;
+(function(a) {
+    return a;
+})(answer)
+```
+"""
+
+test_file_markdown_bad = """
+# H1
+## H2
+```js
+var answer = 6 * 7;
+```
+"""
+
+test_file_HTML = """
+<head></head>
+<body>
+<script>
+var foo = 1;
+(function(a) {
+    return a;
+})(foo)
+</script>
+</body>
+"""
+
+test_file_HTML_bad = """
+<head></head>
+<body>
+<script>
+var foo = 1
+</script>
+</body>
+"""
+
+test_file_typescript = """
+function greeter (person: string) {
+  return 'Hello, ' + person
+}
+greeter('Bob')
+"""
+
 test_syntax_error = '{<!@3@^ yeah!/\n'
 
 test_dir = os.path.join(os.path.dirname(__file__), 'test_files')
@@ -78,6 +140,18 @@
     settings={'eslint_config': os.path.join(test_dir,
                                             'eslintconfig_import.json')})
 
+ESLintBearGlobalVarsTest = verify_local_bear(
+    ESLintBear,
+    invalid_files=(),
+    valid_files=(test_file_global_vars,),
+    settings={'global_vars': 'x,y,z'})
+
+ESLintBearEslintEnvTest = verify_local_bear(
+    ESLintBear,
+    invalid_files=(),
+    valid_files=(test_file_eslint_env,),
+    settings={'eslint_env': 'mocha'})
+
 
 @generate_skip_decorator(ESLintBear)
 class ESLintBearIgnoredFileTest(LocalBearTestHelper):
@@ -110,3 +184,49 @@ def test_lint_config_file(self):
             create_tempfile=False,
             filename=config_filename,
         )
+
+
+@generate_skip_decorator(ESLintBear)
+class ESLintBearLanguageTest(LocalBearTestHelper):
+
+    def setUp(self):
+        self.section = Section('name')
+        self.queue = Queue()
+        self.uut = ESLintBear(self.section, self.queue)
+
+    def test_markdown(self):
+        good_file = [line + '\n' for line in test_file_markdown.splitlines()]
+        bad_file = [line + '\n' for line in
+                    test_file_markdown_bad.splitlines()]
+        self.section.language = Language['Markdown']
+        self.check_validity(self.uut, good_file,
+                            tempfile_kwargs={'suffix': '.md'})
+        self.check_invalidity(self.uut, bad_file,
+                              tempfile_kwargs={'suffix': '.md'})
+
+    def test_HTML(self):
+        good_file = [line + '\n' for line in test_file_HTML.splitlines()]
+        bad_file = [line + '\n' for line in test_file_HTML_bad.splitlines()]
+        self.section.language = Language['html']
+        self.check_validity(self.uut, good_file,
+                            tempfile_kwargs={'suffix': '.html'})
+        self.check_invalidity(self.uut, bad_file,
+                              tempfile_kwargs={'suffix': '.html'})
+
+    def test_typscript(self):
+        good_file = [line + '\n' for line in test_file_typescript.splitlines()]
+        self.section.language = Language['Typescript']
+        self.check_validity(self.uut, good_file)
+
+    def test_bad_language(self):
+        test_file = [line + '\n' for line in test_good.splitlines()]
+        self.section.language = Language['Python']
+        self.check_validity(self.uut, test_file)
+        while not self.queue.empty():
+            message = self.queue.get()
+            msg = ('Language needs to be either Markdown, HTML, TypeScript'
+                   ' or JavaScript. Assuming JavaScript.')
+            if message.message == msg:
+                break
+        else:
+            assert False, 'Message not found'