You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by kl...@apache.org on 2017/11/09 15:59:32 UTC

mesos git commit: Added JavaScript linter.

Repository: mesos
Updated Branches:
  refs/heads/master 0f674bbbb -> 844590611


Added JavaScript linter.

The linter runs when changes on a JavaScript file are being committed.
We use ESLint with a configuration based on our current JS code base.
The linter and its dependencies (i.e. Node.js) are installed in a
virtual environment using Virtualenv and then Nodeenv.

Review: https://reviews.apache.org/r/62214/


Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/84459061
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/84459061
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/84459061

Branch: refs/heads/master
Commit: 844590611067d04de86a2de923b21ef377554728
Parents: 0f674bb
Author: Armand Grillet <ag...@mesosphere.io>
Authored: Thu Nov 9 16:53:40 2017 +0100
Committer: Kevin Klues <kl...@gmail.com>
Committed: Thu Nov 9 16:53:40 2017 +0100

----------------------------------------------------------------------
 support/.eslintrc.js         | 317 ++++++++++++++++++++++++++++++++++++++
 support/build-virtualenv     |  10 ++
 support/mesos-style.py       |  70 ++++++++-
 support/pip-requirements.txt |   1 +
 4 files changed, 397 insertions(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/mesos/blob/84459061/support/.eslintrc.js
----------------------------------------------------------------------
diff --git a/support/.eslintrc.js b/support/.eslintrc.js
new file mode 100644
index 0000000..a474944
--- /dev/null
+++ b/support/.eslintrc.js
@@ -0,0 +1,317 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// This file has been created by running 'eslint --init' with these options:
+// ? How would you like to configure ESLint? Inspect your JavaScript file(s)
+// ? Which file(s), path(s), or glob(s) should be examined?
+//   /apache-mesos/src/webui/master/static/js/app.js
+//   /apache-mesos/src/webui/master/static/js/controllers.js
+//   /apache-mesos/src/webui/master/static/js/services.js
+// ? What format do you want your config file to be in? JavaScript
+// ? Are you using ECMAScript 6 features? No
+// ? Where will your code run? Browser
+// ? Do you use CommonJS? No
+// ? Do you use JSX? No
+//
+// Some globals have also been added to work with our configuration and a rule
+// has been added to only print warnings for unused variables (no-unused-vars).
+
+module.exports = {
+    "env": {
+        "browser": true,
+        "jquery": true
+    },
+    "extends": "eslint:recommended",
+    "globals": {
+        "_": false,
+        "angular": false,
+        "Clipboard": false,
+        "popupErrorModal": false,
+        "relativeDate": false
+    },
+    "rules": {
+        "accessor-pairs": "error",
+        "array-bracket-newline": "off",
+        "array-bracket-spacing": "off",
+        "array-callback-return": "error",
+        "array-element-newline": "off",
+        "arrow-body-style": "error",
+        "arrow-parens": "error",
+        "arrow-spacing": "error",
+        "block-scoped-var": "error",
+        "block-spacing": [
+            "error",
+            "always"
+        ],
+        "brace-style": "off",
+        "callback-return": "error",
+        "camelcase": "off",
+        "capitalized-comments": "off",
+        "class-methods-use-this": "error",
+        "comma-dangle": "error",
+        "comma-spacing": [
+            "error",
+            {
+                "after": true,
+                "before": false
+            }
+        ],
+        "comma-style": [
+            "error",
+            "last"
+        ],
+        "complexity": "error",
+        "computed-property-spacing": [
+            "error",
+            "never"
+        ],
+        "consistent-return": "off",
+        "consistent-this": "error",
+        "curly": "off",
+        "default-case": "error",
+        "dot-location": "off",
+        "dot-notation": "error",
+        "eol-last": "error",
+        "eqeqeq": "off",
+        "for-direction": "error",
+        "func-call-spacing": "error",
+        "func-name-matching": "error",
+        "func-names": [
+            "error",
+            "never"
+        ],
+        "func-style": "off",
+        "function-paren-newline": "off",
+        "generator-star-spacing": "error",
+        "getter-return": "error",
+        "global-require": "error",
+        "guard-for-in": "error",
+        "handle-callback-err": "error",
+        "id-blacklist": "error",
+        "id-length": "off",
+        "id-match": "error",
+        "indent": "off",
+        "indent-legacy": "off",
+        "init-declarations": "off",
+        "jsx-quotes": "error",
+        "key-spacing": "off",
+        "keyword-spacing": [
+            "error",
+            {
+                "after": true,
+                "before": true
+            }
+        ],
+        "line-comment-position": "off",
+        "linebreak-style": [
+            "error",
+            "unix"
+        ],
+        "lines-around-comment": "off",
+        "lines-around-directive": "error",
+        "max-depth": "error",
+        "max-len": "off",
+        "max-lines": "off",
+        "max-nested-callbacks": "error",
+        "max-params": "off",
+        "max-statements": "off",
+        "max-statements-per-line": "off",
+        "new-cap": "error",
+        "new-parens": "error",
+        "newline-after-var": "off",
+        "newline-before-return": "off",
+        "newline-per-chained-call": "off",
+        "no-alert": "error",
+        "no-array-constructor": "error",
+        "no-await-in-loop": "error",
+        "no-bitwise": "error",
+        "no-buffer-constructor": "error",
+        "no-caller": "error",
+        "no-catch-shadow": "error",
+        "no-confusing-arrow": "error",
+        "no-continue": "error",
+        "no-div-regex": "error",
+        "no-duplicate-imports": "error",
+        "no-else-return": "off",
+        "no-empty-function": "off",
+        "no-eq-null": "off",
+        "no-eval": "error",
+        "no-extend-native": "error",
+        "no-extra-bind": "error",
+        "no-extra-label": "error",
+        "no-extra-parens": "off",
+        "no-floating-decimal": "error",
+        "no-implicit-globals": "error",
+        "no-implied-eval": "error",
+        "no-inline-comments": "off",
+        "no-inner-declarations": [
+            "error",
+            "functions"
+        ],
+        "no-invalid-this": "off",
+        "no-iterator": "error",
+        "no-label-var": "error",
+        "no-labels": "error",
+        "no-lone-blocks": "error",
+        "no-lonely-if": "error",
+        "no-loop-func": "error",
+        "no-magic-numbers": "off",
+        "no-mixed-operators": "error",
+        "no-mixed-requires": "error",
+        "no-multi-assign": "off",
+        "no-multi-spaces": [
+            "error",
+            {
+                "ignoreEOLComments": true
+            }
+        ],
+        "no-multi-str": "error",
+        "no-multiple-empty-lines": "error",
+        "no-native-reassign": "error",
+        "no-negated-condition": "off",
+        "no-negated-in-lhs": "error",
+        "no-nested-ternary": "error",
+        "no-new": "error",
+        "no-new-func": "error",
+        "no-new-object": "error",
+        "no-new-require": "error",
+        "no-new-wrappers": "error",
+        "no-octal-escape": "error",
+        "no-param-reassign": "off",
+        "no-path-concat": "error",
+        "no-plusplus": "error",
+        "no-process-env": "error",
+        "no-process-exit": "error",
+        "no-proto": "error",
+        "no-prototype-builtins": "error",
+        "no-restricted-globals": "error",
+        "no-restricted-imports": "error",
+        "no-restricted-modules": "error",
+        "no-restricted-properties": "error",
+        "no-restricted-syntax": "error",
+        "no-return-assign": "error",
+        "no-return-await": "error",
+        "no-script-url": "error",
+        "no-self-compare": "error",
+        "no-sequences": "error",
+        "no-shadow": "off",
+        "no-shadow-restricted-names": "error",
+        "no-spaced-func": "error",
+        "no-sync": "error",
+        "no-tabs": "error",
+        "no-template-curly-in-string": "error",
+        "no-ternary": "off",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "error",
+        "no-undef-init": "error",
+        "no-undefined": "error",
+        "no-underscore-dangle": "error",
+        "no-unmodified-loop-condition": "error",
+        "no-unneeded-ternary": "error",
+        "no-unused-expressions": "error",
+        "no-unused-vars": "warn",
+        "no-use-before-define": "off",
+        "no-useless-call": "error",
+        "no-useless-computed-key": "error",
+        "no-useless-concat": "error",
+        "no-useless-constructor": "error",
+        "no-useless-rename": "error",
+        "no-useless-return": "error",
+        "no-var": "off",
+        "no-void": "error",
+        "no-warning-comments": "off",
+        "no-whitespace-before-property": "error",
+        "no-with": "error",
+        "nonblock-statement-body-position": "error",
+        "object-curly-newline": "off",
+        "object-curly-spacing": "off",
+        "object-property-newline": [
+            "error",
+            {
+                "allowMultiplePropertiesPerLine": true
+            }
+        ],
+        "object-shorthand": "off",
+        "one-var": "off",
+        "one-var-declaration-per-line": "error",
+        "operator-assignment": "off",
+        "operator-linebreak": "error",
+        "padded-blocks": "off",
+        "padding-line-between-statements": "error",
+        "prefer-arrow-callback": "off",
+        "prefer-const": "error",
+        "prefer-destructuring": "off",
+        "prefer-numeric-literals": "error",
+        "prefer-promise-reject-errors": "error",
+        "prefer-reflect": "off",
+        "prefer-rest-params": "error",
+        "prefer-spread": "error",
+        "prefer-template": "off",
+        "quote-props": "off",
+        "quotes": "off",
+        "radix": [
+            "error",
+            "always"
+        ],
+        "require-await": "error",
+        "require-jsdoc": "off",
+        "rest-spread-spacing": "error",
+        "semi": "off",
+        "semi-spacing": [
+            "error",
+            {
+                "after": true,
+                "before": false
+            }
+        ],
+        "semi-style": [
+            "error",
+            "last"
+        ],
+        "sort-imports": "error",
+        "sort-keys": "off",
+        "sort-vars": "error",
+        "space-before-blocks": "error",
+        "space-before-function-paren": "off",
+        "space-in-parens": [
+            "error",
+            "never"
+        ],
+        "space-infix-ops": "error",
+        "space-unary-ops": "error",
+        "spaced-comment": [
+            "error",
+            "always"
+        ],
+        "strict": "error",
+        "switch-colon-spacing": "error",
+        "symbol-description": "error",
+        "template-curly-spacing": "error",
+        "template-tag-spacing": "error",
+        "unicode-bom": [
+            "error",
+            "never"
+        ],
+        "valid-jsdoc": "error",
+        "vars-on-top": "off",
+        "wrap-regex": "error",
+        "yield-star-spacing": "error",
+        "yoda": [
+            "error",
+            "never"
+        ]
+    }
+};

http://git-wip-us.apache.org/repos/asf/mesos/blob/84459061/support/build-virtualenv
----------------------------------------------------------------------
diff --git a/support/build-virtualenv b/support/build-virtualenv
index b46a86a..3ab40f0 100755
--- a/support/build-virtualenv
+++ b/support/build-virtualenv
@@ -62,4 +62,14 @@ ${PYTHON} ${VIRTUALENV} --python=${PYTHON} \
 source ${VIRTUALENV_DIRECTORY}/bin/activate
 pip install --upgrade pip
 pip install -r ${CURRDIR}/pip-requirements.txt
+
+# Add Node.js virtual environment to the existing virtual environment.
+nodeenv -p
+
+# Restart the virtual environment to then have npm available.
+deactivate
+source ${VIRTUALENV_DIRECTORY}/bin/activate
+
+# Install the JavaScript linter in the virtual environment.
+npm install -g eslint@4.6.1
 deactivate

http://git-wip-us.apache.org/repos/asf/mesos/blob/84459061/support/mesos-style.py
----------------------------------------------------------------------
diff --git a/support/mesos-style.py b/support/mesos-style.py
index 96030f2..f288819 100755
--- a/support/mesos-style.py
+++ b/support/mesos-style.py
@@ -96,6 +96,19 @@ class LinterBase(object):
         """
         pass
 
+    def run_command_in_virtualenv(self, command):
+        """
+        Activate the virtual environment, run the
+        given command and return its output.
+        """
+        virtualenv = os.path.join('support', '.virtualenv')
+        command = '. {virtualenv_path}/bin/activate; {cmd}'.format(
+            virtualenv_path=virtualenv, cmd=command)
+
+        process = subprocess.Popen(command, shell=True, stdout=subprocess.PIPE)
+
+        return process
+
     def check_license_header(self, source_paths):
         """Checks the license headers of the given files."""
         error_count = 0
@@ -278,6 +291,59 @@ class CppLinter(LinterBase):
         return process.returncode
 
 
+class JsLinter(LinterBase):
+    """The linter for JavaScript files, uses eslint."""
+    linter_type = 'JavaScript'
+
+    source_dirs = [os.path.join('src', 'webui')]
+
+    exclude_files = '(' \
+                    r'angular\-1\.2\.32|' \
+                    r'angular\-route\-1\.2\.32|' \
+                    r'clipboard\-1\.5\.16|' \
+                    r'jquery\-3\.2\.1|' \
+                    r'relative\-date|' \
+                    r'ui\-bootstrap\-tpls\-0\.9\.0|' \
+                    r'angular\-route\-1\.2\.32|' \
+                    r'underscore\-1\.4\.3|' \
+                    r'\.eslintrc|' \
+                    r'\.virtualenv' \
+                    ')'
+
+    source_files = r'\.(js)$'
+
+    comment_prefix = '//'
+
+    def run_lint(self, source_paths):
+        """
+        Runs eslint over given files.
+
+        https://eslint.org/docs/user-guide/configuring
+        """
+
+        num_errors = 0
+
+        source_files = ' '.join(source_paths)
+        config_path = os.path.join('support', '.eslintrc.js')
+
+        process = self.run_command_in_virtualenv(
+            'eslint {files} -c {config} -f compact'.format(
+                files=source_files,
+                config=config_path)
+            )
+
+        for line in process.stdout:
+            if "Error -" in line or "Warning -" in line:
+                sys.stderr.write(line)
+                if "Error -" in line:
+                    num_errors += 1
+
+        return num_errors
+
+    def main(self, modified_files):
+        return super(JsLinter, self).main(modified_files)
+
+
 class PyLinter(LinterBase):
     """The linter for Python files, uses pylint."""
     linter_type = 'Python'
@@ -402,4 +468,6 @@ if __name__ == '__main__':
     CPP_ERRORS = CPP_LINTER.main(sys.argv[1:])
     PY_LINTER = PyLinter()
     PY_ERRORS = PY_LINTER.main(sys.argv[1:])
-    sys.exit(CPP_ERRORS + PY_ERRORS)
+    JS_LINTER = JsLinter()
+    JS_ERRORS = JS_LINTER.main(sys.argv[1:])
+    sys.exit(CPP_ERRORS + PY_ERRORS + JS_ERRORS)

http://git-wip-us.apache.org/repos/asf/mesos/blob/84459061/support/pip-requirements.txt
----------------------------------------------------------------------
diff --git a/support/pip-requirements.txt b/support/pip-requirements.txt
index 6ae67d0..5877ad2 100644
--- a/support/pip-requirements.txt
+++ b/support/pip-requirements.txt
@@ -1 +1,2 @@
+nodeenv==1.1.2
 pylint==1.6.4