Adding (and running) eslint

Author: weaverryan

.eslintrc.js

@@ -0,0 +1,59 @@
+module.exports = {
+    "root": true,
+    "plugins": ["node"],
+    "extends": ["eslint:recommended", "plugin:node/recommended"],
+    "env": {
+        "node": true,
+        "es6": true,
+    },
+    "parserOptions": { "ecmaVersion": 2017 },
+    "rules": {
+        "quotes": ["error", "single"],
+        "no-undef": "error",
+        "no-extra-semi": "error",
+        "semi": "error",
+        "no-template-curly-in-string": "error",
+        "no-caller": "error",
+        "eqeqeq": "error",
+        "global-require": "off",
+        "brace-style": "error",
+        "eol-last": "error",
+        "indent": ["error", 4, { "SwitchCase": 1 }],
+        "no-extra-bind": "warn",
+        "no-empty": "off",
+        "no-multiple-empty-lines": "error",
+        "no-multi-spaces": "error",
+        "no-process-exit": "warn",
+        "space-in-parens": "error",
+        "no-trailing-spaces": "error",
+        "no-use-before-define": "off",
+        "no-unused-vars": ["error", { "args": "none" }],
+        "key-spacing": "error",
+        "space-infix-ops": "error",
+        "no-unsafe-negation": "error",
+        "no-loop-func": "warn",
+        "space-before-function-paren": ["error", "never"],
+        "space-before-blocks": "error",
+        "object-curly-spacing": ["error", "always"],
+        "keyword-spacing": ["error", {
+            "after": true
+        }],
+        "no-console": "off",
+        "valid-jsdoc": ["error", {"requireParamDescription": false, "requireReturnDescription": false}],
+        "node/no-unsupported-features": ["error", { version: 6 }],
+        "node/no-deprecated-api": "error",
+        "node/no-missing-import": "error",
+        "node/no-missing-require": [
+            "error",
+            {
+                "allowModules": [
+                    "webpack"
+                ]
+            }
+        ],
+        "node/no-unpublished-bin": "error",
+        "node/no-unpublished-require": "error",
+        "node/process-exit-as-throw": "error"
+    }
+};
+

index.js

@@ -4,7 +4,7 @@ const validator = require('./lib/validate-config');
 const PrettyError = require('pretty-error');
 const commandConfig = require('./lib/command-config');
 
-webpackConfig = new WebpackConfig();
+const webpackConfig = new WebpackConfig();
 
 // determine the environment
 let environment = commandConfig.environment;
@@ -26,7 +26,7 @@ module.exports = {
      * to the directory where your package.json lives.
      *
      * @param {string} outputPath
-     * @returns {exports}
+     * @return {exports}
      */
     setOutputPath(outputPath) {
         webpackConfig.setOutputPath(outputPath);
@@ -50,7 +50,7 @@ module.exports = {
      *      .setManifestKeyPrefix('/build')
      *
      * @param {string} publicPath
-     * @returns {exports}
+     * @return {exports}
      */
     setPublicPath(publicPath) {
         webpackConfig.setPublicPath(publicPath);
@@ -79,7 +79,7 @@ module.exports = {
      *      }
      *
      * @param {string} manifestKeyPrefix
-     * @returns {exports}
+     * @return {exports}
      */
     setManifestKeyPrefix(manifestKeyPrefix) {
         webpackConfig.setManifestKeyPrefix(manifestKeyPrefix);
@@ -101,7 +101,8 @@ module.exports = {
      *      // guarantee the context is your root directory
      *      Encore.setContext(__dirname);
      *
-     * @param context
+     * @param {string} context
+     * @return {exports}
      */
     setContext(context) {
         webpackConfig.setContext(context);
@@ -136,7 +137,7 @@ module.exports = {
      * False can be passed as an argument to disable the dev server.
      *
      * @param {string|bool} webpackDevServerUrl
-     * @returns {exports}
+     * @return {exports}
      */
     useWebpackDevServer(webpackDevServerUrl = null) {
         webpackConfig.useWebpackDevServer(webpackDevServerUrl);
@@ -156,18 +157,55 @@ module.exports = {
         return this;
     },
 
+    /**
+     * Add a "commons" file that holds JS shared by multiple chunks.
+     *
+     * @param {string} name The chunk name (e.g. vendor)
+     * @param {Array}  files Array of files to put in the vendor entry
+     * @return {exports}
+     */
     createSharedEntry(name, files) {
         webpackConfig.createSharedEntry(name, files);
 
         return this;
     },
 
+    /**
+     * Automatically make some variables available everywhere!
+     *
+     * Usage:
+     *
+     *  WebpackConfig.autoProvideVariables({
+     *      $: 'jquery',
+     *      jQuery: 'jquery'
+     *  });
+     *
+     *  Then, whenever $ or jQuery are found in any
+     *  modules, webpack will automatically require
+     *  the "jquery" module so that the variable is available.
+     *
+     *  This is useful for older packages, that might
+     *  expect jQuery (or something else) to be a global variable.
+     *
+     * @param {Array} variables
+     * @return {exports}
+     */
     autoProvideVariables(variables) {
         webpackConfig.autoProvideVariables(variables);
 
         return this;
     },
 
+    /**
+     * Makes jQuery available everywhere. Equivalent to
+     *
+     *  WebpackConfig.autoProvideVariables({
+     *      $: 'jquery',
+     *      jQuery: 'jquery'
+     *  });
+     *
+     * @return {exports}
+     */
     autoProvidejQuery() {
         webpackConfig.autoProvidejQuery();
 
@@ -180,6 +218,9 @@ module.exports = {
      * Once enabled, you must have a postcss.config.js config file.
      *
      * https://github.com/postcss/postcss-loader
+     *
+     * @param {boolean} enabled
+     * @return {exports}
      */
     enablePostCssLoader(enabled = true) {
         webpackConfig.enablePostCssLoader(enabled);
@@ -190,8 +231,8 @@ module.exports = {
     /**
      * Call this if you plan on loading SASS files.
      *
-     * @param enabled
-     * @returns {exports}
+     * @param {boolean} enabled
+     * @return {exports}
      */
     enableSassLoader(enabled = true) {
         webpackConfig.enableSassLoader(enabled);
@@ -202,8 +243,8 @@ module.exports = {
     /**
      * Call this if you plan on loading less files.
      *
-     * @param enabled
-     * @returns {exports}
+     * @param {boolean} enabled
+     * @return {exports}
      */
     enableLessLoader(enabled = true) {
         webpackConfig.enableLessLoader(enabled);
@@ -221,6 +262,7 @@ module.exports = {
      * });
      *
      * @param {function} callback
+     * @return {exports}
      */
     configureBabel(callback) {
         webpackConfig.configureBabel(callback);
@@ -232,7 +274,8 @@ module.exports = {
      * Should the babel-loader be allowed to load config from
      * a .babelrc file?
      *
-     * @param shouldUse
+     * @param {boolean} shouldUse
+     * @return {exports}
      */
     useBabelRcFile(shouldUse = true) {
         webpackConfig.useBabelRcFile(shouldUse);
@@ -267,12 +310,12 @@ module.exports = {
             pe.appendStyle({
                 // hides the full paths below each stack item
                 'pretty-error > trace': {
-                   display: 'none'
+                    display: 'none'
                 }
             });
 
             console.log(pe.render(error));
-            process.exit(1);
+            process.exit(1); // eslint-disable-line
         }
     }
 };

lib/DeleteUnusedEntriesJSPlugin.js

@@ -14,7 +14,7 @@ DeleteUnusedEntriesJSPlugin.prototype.apply = function(compiler) {
 
                 // loop over the output files and find the 1 that ends in .js
                 chunk.files.forEach((filename) => {
-                    if (path.extname(filename) == '.js') {
+                    if (path.extname(filename) === '.js') {
                         fileDeleteCount++;
                         // remove the output file
                         delete compilation.assets[filename];
@@ -26,7 +26,7 @@ DeleteUnusedEntriesJSPlugin.prototype.apply = function(compiler) {
                 // sanity check: make sure 1 file was deleted
                 // if there's some edge case where multiple .js files
                 // or 0 .js files might be deleted, I'd rather error
-                if (fileDeleteCount != 1) {
+                if (fileDeleteCount !== 1) {
                     throw new Error(`Problem deleting JS entry for ${chunk.name}: ${fileDeleteCount} files were deleted`);
                 }
             }

lib/WebpackConfig.js

@@ -26,7 +26,7 @@ class WebpackConfig {
     }
 
     setEnvironment(environment) {
-        if (environment != 'production' && environment != 'dev') {
+        if (environment !== 'production' && environment !== 'dev') {
             throw new Error(`Invalid argument "${environment}" passed to setEnvironment. Valid values are production or dev`);
         }
 
@@ -35,7 +35,7 @@ class WebpackConfig {
 
     setContext(context) {
         if (null !== this.context) {
-            throw new Error(`Make sure to call setContext() at the top of your configuration (before adding any entries).`);
+            throw new Error('Make sure to call setContext() at the top of your configuration (before adding any entries).');
         }
 
         this.context = context;
@@ -46,7 +46,7 @@ class WebpackConfig {
             // context = cwd(), then find package.json file
             const packagesPath = pkgUp.sync(process.cwd());
             if (null === packagesPath) {
-                throw new Error(`Cannot determine webpack context. (Are you executing webpack from a directory outside of your project?). Call setContext() manually at the *top* of your webpack.config.js configuration.`);
+                throw new Error('Cannot determine webpack context. (Are you executing webpack from a directory outside of your project?). Call setContext() manually at the *top* of your webpack.config.js configuration.');
             }
 
             this.context = path.dirname(packagesPath);
@@ -56,7 +56,7 @@ class WebpackConfig {
     }
 
     setOutputPath(outputPath) {
-        if(!path.isAbsolute(outputPath)) {
+        if (!path.isAbsolute(outputPath)) {
             outputPath = path.resolve(this.getContext(), outputPath);
         }
 
@@ -95,16 +95,16 @@ class WebpackConfig {
         }
 
         // guarantee a single trailing slash
-        publicPath = publicPath.replace(/\/$/,"");
-        publicPath = publicPath+'/';
+        publicPath = publicPath.replace(/\/$/,'');
+        publicPath = publicPath + '/';
 
         this.publicPath = publicPath;
     }
 
     setManifestKeyPrefix(manifestKeyPrefix) {
         // guarantee a single trailing slash, except for blank strings
         if (manifestKeyPrefix !== '') {
-            manifestKeyPrefix = manifestKeyPrefix.replace(/\/$/, "");
+            manifestKeyPrefix = manifestKeyPrefix.replace(/\/$/, '');
             manifestKeyPrefix = manifestKeyPrefix + '/';
         }
 
@@ -138,8 +138,8 @@ class WebpackConfig {
         }
 
         // guarantee a single trailing slash
-        webpackDevServerUrl = webpackDevServerUrl.replace(/\/$/,"");
-        webpackDevServerUrl = webpackDevServerUrl+'/';
+        webpackDevServerUrl = webpackDevServerUrl.replace(/\/$/,'');
+        webpackDevServerUrl = webpackDevServerUrl + '/';
 
         this.webpackDevServerUrl = webpackDevServerUrl;
     }
@@ -154,7 +154,7 @@ class WebpackConfig {
         // if we're using webpack-dev-server, use it & add the publicPath
         if (this.webpackDevServerUrl) {
             // avoid 2 middle slashes
-            return this.webpackDevServerUrl.replace(/\/$/,"") + this.publicPath;
+            return this.webpackDevServerUrl.replace(/\/$/,'') + this.publicPath;
         }
 
         return this.publicPath;
@@ -205,15 +205,10 @@ class WebpackConfig {
         this.allowBabelRcFile = shouldUse;
     }
 
-    /**
-     *
-     * @param name The chunk name (e.g. vendor)
-     * @param files Array of files to put in the vendor entry
-     */
     createSharedEntry(name, files) {
         // don't allow to call this twice
         if (this.sharedCommonsEntryName) {
-            throw new Error('createSharedEntry() cannot be called multiple times: you can only create *one* shared entry.')
+            throw new Error('createSharedEntry() cannot be called multiple times: you can only create *one* shared entry.');
         }
 
         this.sharedCommonsEntryName = name;
@@ -241,28 +236,9 @@ class WebpackConfig {
         this.cleanupOutput = true;
     }
 
-    /**
-     * Automatically make some variables available everywhere!
-     *
-     * Usage:
-     *
-     *  WebpackConfig.autoProvideVariables({
-     *      $: 'jquery',
-     *      jQuery: 'jquery'
-     *  });
-     *
-     *  Then, whenever $ or jQuery are found in any
-     *  modules, webpack will automatically require
-     *  the "jquery" module so that the variable is available.
-     *
-     *  This is useful for older packages, that might
-     *  expect jQuery (or something else) to be a global variable.
-     *
-     * @param variables
-     */
     autoProvideVariables(variables) {
         // do a few sanity checks, so we can give better user errors
-        if (typeof variables == 'string' || Array.isArray(variables)) {
+        if (typeof variables === 'string' || Array.isArray(variables)) {
             throw new Error('Invalid argument passed to autoProvideVariables: you must pass an object map - e.g. { $: "jquery" }');
         }
 
@@ -274,14 +250,6 @@ class WebpackConfig {
         );
     }
 
-    /**
-     * Makes jQuery available everywhere. Equivalent to
-     *
-     *  WebpackConfig.autoProvideVariables({
-     *      $: 'jquery',
-     *      jQuery: 'jquery'
-     *  });
-     */
     autoProvidejQuery() {
         this.autoProvideVariables({
             $: 'jquery',