build: configure ESLint coverage for gulp, scripts, docs, config (#11064)

Author: Splaktar

.eslintignore

@@ -0,0 +1,15 @@
+# Ignore miscellaneous folders
+.github/
+.idea/
+node_modules/
+dist/
+tmp/
+bower-material/
+code.material.angularjs.org/
+
+# Ignore certain project files
+# TODO Remove test/ at some point when the files there are fit for linting
+test/
+src/core/services/compiler/compiler.spec.js
+docs/config/template/*.js
+docs/app/js/highlight.pack.js

.eslintrc.json

@@ -1,7 +1,7 @@
 {
     "extends": "eslint:recommended",
     "parserOptions": {
-      "ecmaVersion": 8
+        "ecmaVersion": 8
     },
     "rules": {
         "accessor-pairs": "error",
@@ -10,7 +10,10 @@
         "array-callback-return": "error",
         "array-element-newline": "off",
         "arrow-body-style": "error",
-        "arrow-parens": "error",
+        "arrow-parens": [
+            "error",
+            "as-needed"
+        ],
         "arrow-spacing": "error",
         "block-scoped-var": "off",
         "block-spacing": "off",
@@ -42,7 +45,7 @@
         "func-style": "off",
         "generator-star-spacing": "error",
         "getter-return": "error",
-        "global-require": "error",
+        "global-require": "off",
         "guard-for-in": "off",
         "handle-callback-err": "error",
         "id-blacklist": "error",
@@ -78,14 +81,17 @@
         "no-caller": "error",
         "no-catch-shadow": "error",
         "no-confusing-arrow": "error",
+        "no-console": [
+            "off"
+        ],
         "no-constant-condition": [
             "error",
             {
                 "checkLoops": false
             }
         ],
         "no-continue": "off",
-        "no-div-regex": "error",
+        "no-div-regex": "off",
         "no-duplicate-imports": "error",
         "no-else-return": "off",
         "no-empty-function": "off",
@@ -138,7 +144,7 @@
         "no-param-reassign": "off",
         "no-path-concat": "error",
         "no-plusplus": "off",
-        "no-process-env": "error",
+        "no-process-env": "off",
         "no-process-exit": "error",
         "no-proto": "error",
         "no-prototype-builtins": "off",
@@ -155,7 +161,7 @@
         "no-shadow": "off",
         "no-shadow-restricted-names": "error",
         "no-spaced-func": "off",
-        "no-sync": "error",
+        "no-sync": "off",
         "no-tabs": "off",
         "no-template-curly-in-string": "error",
         "no-ternary": "off",
@@ -240,15 +246,50 @@
         "no-unexpected-multiline": "off"
     },
     "env": {
-        "browser": true
+        "node": true
     },
     "globals": {
-        "angular": true,
-        "CryptoJS": true
+        "angular": true
     },
     "overrides": [
         {
-            "files": ["**/*.spec.js"],
+            "files": [
+                "docs/app/js/**/*",
+                "src/**/*"
+            ],
+            "parserOptions": {
+                "ecmaVersion": 5
+            },
+            "env": {
+                "browser": true
+            },
+            "rules": {
+                "arrow-parens": "error",
+                "global-require": "error",
+                "no-console": [
+                    "error"
+                ],
+                "no-process-env": "error",
+                "no-sync": "error"
+            },
+            "globals": {
+                "angular": true,
+                "CryptoJS": true,
+                "hljs": true
+            }
+        },
+        {
+            "files": [
+                "scripts/**/*"
+            ],
+            "rules": {
+                "no-process-env": "off"
+            }
+        },
+        {
+            "files": [
+                "**/*.spec.js"
+            ],
             "env": {
                 "jasmine": true
             },

.gitignore

@@ -6,3 +6,5 @@ dist
 .nvmrc
 tmp/
 .editorconfig
+bower-material/
+code.material.angularjs.org/

committers.json

@@ -1,6 +1,4 @@
-var pkg = require('../package.json');
-var fs = require('fs');
-var versionFile = __dirname + '/../dist/commit';
+const pkg = require('../package.json');
 
 module.exports = {
   ngVersion: '1.5.5',

config/build.config.js

@@ -1,12 +1,12 @@
-var baseKarma = require('./karma.conf.js');
+const baseKarma = require('./karma.conf.js');
 
 module.exports = function(config) {
   baseKarma(config);
 
   // Override defaults with custom CI settings
   config.set({
     colors: false,
-    singleRun:true,
+    singleRun: true,
     autoWatch: false,
     logLevel: config.LOG_DEBUG,
 
@@ -17,7 +17,7 @@ module.exports = function(config) {
 
     client: {
       // Do not clear the context as this can cause reload failures with Jasmine
-      clearContext:false
+      clearContext: false
     },
 
     // This is the new content for your travis-ci configuration test
@@ -30,7 +30,7 @@ module.exports = function(config) {
     }
   });
 
-  var browsers = process.env.TRAVIS ? ['Chrome_travis_ci'] : [];
+  const browsers = process.env.TRAVIS ? ['Chrome_travis_ci'] : [];
   config.browsers = browsers.concat(config.browsers);
 
 };

config/karma-ci.conf.js

@@ -1,14 +1,14 @@
+const path = require('path');
+
 // Used for running unit tests against the docs site
 // Unit tests can be run using gulp docs-karma
 module.exports = function(config) {
 
-  var UNCOMPILED_SRC = [
+  // releaseMode is a custom configuration option.
+  const testSrc = [
     'docs/spec/**/*.spec.js'
   ];
-
-  // releaseMode is a custom configuration option.
-  var testSrc = UNCOMPILED_SRC;
-  var dependencies = process.env.KARMA_TEST_JQUERY ?
+  let dependencies = process.env.KARMA_TEST_JQUERY ?
     ['node_modules/jquery/dist/jquery.js'] : [];
 
   dependencies = dependencies.concat([
@@ -26,7 +26,7 @@ module.exports = function(config) {
 
   config.set({
 
-    basePath: __dirname + '/..',
+    basePath: path.join(__dirname, '/..'),
     frameworks: ['jasmine'],
     files: dependencies.concat(testSrc),
 

config/karma-docs.conf.js

@@ -1,8 +1,8 @@
-var baseKarma = require('./karma.conf.js');
+const baseKarma = require('./karma.conf.js');
+const sauceBrowsers = require('./sauce-browsers.json');
 
 if (!process.env.SAUCE_USERNAME || !process.env.SAUCE_ACCESS_KEY) {
-  console.log('Environment variables SAUCE_USERNAME and SAUCE_ACCESS_KEY must be set to run saucelabs with Karma.');
-  process.exit(1);
+  throw new Error('Environment variables SAUCE_USERNAME and SAUCE_ACCESS_KEY must be set to run saucelabs with Karma.');
 }
 
 process.env.SAUCE_ACCESS_KEY = process.env.SAUCE_ACCESS_KEY.split('').reverse().join('');
@@ -17,7 +17,7 @@ module.exports = function(config) {
     // Those pre-configured browsers will always run in the CI Release Mode to confirm, that all
     // previous jobs have passed.
     browsers: ['SL_CHROME'],   //, 'SL_FIREFOX', 'SL_IE11'],
-    customLaunchers: require('./sauce-browsers.json'),
+    customLaunchers: sauceBrowsers,
 
     captureTimeout: 180 * 1000,
     browserDisconnectTimeout: 180 * 1000,

config/karma-sauce.conf.js

@@ -1,7 +1,9 @@
+const sauceBrowsers = require('./sauce-browsers.json');
+const path = require('path');
 
 module.exports = function(config) {
 
-  var UNCOMPILED_SRC = [
+  const UNCOMPILED_SRC = [
 
     // To enabled use of `gulp karma-watch`,
     // don't use the dist/angular-material.js
@@ -23,13 +25,13 @@ module.exports = function(config) {
     'src/**/*.spec.js'
   ];
 
-  var COMPILED_SRC = [
+  const COMPILED_SRC = [
     'dist/angular-material.min.css',
     'dist/angular-material.min.js',   // Minified source
     'src/**/*.spec.js'
   ];
 
-  var dependencies = process.env.KARMA_TEST_JQUERY ? ['node_modules/jquery/dist/jquery.js'] : [];
+  let dependencies = process.env.KARMA_TEST_JQUERY ? ['node_modules/jquery/dist/jquery.js'] : [];
       dependencies = dependencies.concat([
         'node_modules/angular/angular.js',
         'node_modules/angular-animate/angular-animate.js',
@@ -42,14 +44,14 @@ module.exports = function(config) {
         'test/angular-material-spec.js'
       ]);
 
-  var testSrc = process.env.KARMA_TEST_COMPRESSED ? COMPILED_SRC : UNCOMPILED_SRC;
+  const testSrc = process.env.KARMA_TEST_COMPRESSED ? COMPILED_SRC : UNCOMPILED_SRC;
 
   config.set({
 
-    basePath: __dirname + '/..',
+    basePath: path.join(__dirname, '/..'),
     frameworks: ['jasmine'],
     files: dependencies.concat(testSrc),
-    customLaunchers: require('./sauce-browsers.json'),
+    customLaunchers: sauceBrowsers,
 
     browserDisconnectTimeout:500,
 

config/karma.conf.js

@@ -12,19 +12,19 @@
 
 // Define patterns for AngularJS Module definitions
 
-var MATERIAL_ONLY = /\.module\(['|"](material\.[a-zA-Z\-\.]*)['|"]\s*,(\s*\[([^\]]*)\])/;
-var ANY = /\.module\(('[^']*'|"[^"]*")\s*,(?:\s*\[([^\]]+)\])?/;
+const MATERIAL_ONLY = /\.module\(['|"](material\.[a-zA-Z\-.]*)['|"]\s*,(\s*\[([^\]]*)])/;
+const ANY = /\.module\(('[^']*'|"[^"]*")\s*,(?:\s*\[([^\]]+)])?/;
 
 /**
  * Find module definition s that match the module definition pattern
  */
 function buildScanner(pattern) {
 
   return function findPatternIn(content) {
-    var dependencies;
-    var match = pattern.exec(content || '');
-    var moduleName = match ? match[1].replace(/\'/gi,'') : null;
-    var depsMatch = match && match[2] && match[2].trim();
+    let dependencies;
+    const match = pattern.exec(content || '');
+    const moduleName = match ? match[1].replace(/'/gi,'') : null;
+    const depsMatch = match && match[2] && match[2].trim();
 
     if (depsMatch) {
       dependencies = depsMatch.split(/\s*,\s*/).map(function(dep) {
@@ -38,11 +38,10 @@ function buildScanner(pattern) {
       module       : moduleName || '',
       dependencies : dependencies || [ ]
     } : null;
-  }
+  };
 }
 
 module.exports = {
   material : buildScanner( MATERIAL_ONLY ),
   any      : buildScanner( ANY )
 };
-