fix(eslint): force eslint configuration check to be synchronous, thanks to sync-rpc

Author: Kocal

lib/loaders/eslint.js

@@ -9,18 +9,12 @@
 
 'use strict';
 
+const forceSync = require('sync-rpc');
+const hasEslintConfiguration = forceSync(require.resolve('../utils/has-eslint-configuration'));
 const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
 const loaderFeatures = require('../features');
 const applyOptionsCallback = require('../utils/apply-options-callback');
 
-function isMissingConfigError(e) {
-    if (!e.message || !e.message.includes('No ESLint configuration found')) {
-        return false;
-    }
-
-    return true;
-}
-
 module.exports = {
     /**
      * @param {WebpackConfig} webpackConfig
@@ -29,19 +23,11 @@ module.exports = {
     getOptions(webpackConfig) {
         loaderFeatures.ensurePackagesExistAndAreCorrectVersion('eslint');
 
-        const eslint = require('eslint'); // eslint-disable-line node/no-unpublished-require
-        const engine = new eslint.CLIEngine({
-            cwd: webpackConfig.runtimeConfig.context,
-        });
-
-        try {
-            engine.getConfigForFile('webpack.config.js');
-        } catch (e) {
-            if (isMissingConfigError(e)) {
-                const chalk = require('chalk');
-                const packageHelper = require('../package-helper');
+        if (!hasEslintConfiguration(webpackConfig)) {
+            const chalk = require('chalk');
+            const packageHelper = require('../package-helper');
 
-                const message = `No ESLint configration has been found.
+            const message = `No ESLint configuration has been found.
 
 ${chalk.bgGreen.black('', 'FIX', '')} Run command ${chalk.yellow('./node_modules/.bin/eslint --init')} or manually create a ${chalk.yellow('.eslintrc.js')} file at the root of your project.
 
@@ -57,10 +43,7 @@ module.exports = {
 Install ${chalk.yellow('babel-eslint')} to prevent potential parsing issues: ${packageHelper.getInstallCommand([[{ name: 'babel-eslint' }]])}
 
 `;
-                throw new Error(message);
-            }
-
-            throw e;
+            throw new Error(message);
         }
 
         const eslintLoaderOptions = {

lib/plugins/eslint.js

@@ -9,19 +9,13 @@
 
 'use strict';
 
+const forceSync = require('sync-rpc');
+const hasEslintConfiguration = forceSync(require.resolve('../utils/has-eslint-configuration'));
 const WebpackConfig = require('../WebpackConfig'); //eslint-disable-line no-unused-vars
 const EslintPlugin = require('eslint-webpack-plugin'); //eslint-disable-line node/no-unpublished-require
 const applyOptionsCallback = require('../utils/apply-options-callback');
 const pluginFeatures = require('../features');
 
-function isMissingConfigError(e) {
-    if (!e.message || !e.message.includes('No ESLint configuration found')) {
-        return false;
-    }
-
-    return true;
-}
-
 /**
  * Support for ESLint.
  *
@@ -33,21 +27,11 @@ module.exports = function(plugins, webpackConfig) {
     if (webpackConfig.useEslintPlugin) {
         pluginFeatures.ensurePackagesExistAndAreCorrectVersion('eslint_plugin');
 
-        const { ESLint } = require('eslint'); // eslint-disable-line node/no-unpublished-require
-        const eslint = new ESLint({
-            cwd: webpackConfig.runtimeConfig.context,
-        });
-
-        try {
-            (async function() {
-                await eslint.calculateConfigForFile('webpack.config.js');
-            })();
-        } catch (e) {
-            if (isMissingConfigError(e)) {
-                const chalk = require('chalk');
-                const packageHelper = require('../package-helper');
+        if (!hasEslintConfiguration(webpackConfig)) {
+            const chalk = require('chalk');
+            const packageHelper = require('../package-helper');
 
-                const message = `No ESLint configuration has been found.
+            const message = `No ESLint configuration has been found.
 
 ${chalk.bgGreen.black('', 'FIX', '')} Run command ${chalk.yellow('./node_modules/.bin/eslint --init')} or manually create a ${chalk.yellow('.eslintrc.js')} file at the root of your project.
 
@@ -63,10 +47,7 @@ module.exports = {
 Install ${chalk.yellow('babel-eslint')} to prevent potential parsing issues: ${packageHelper.getInstallCommand([[{ name: 'babel-eslint' }]])}
 
 `;
-                throw new Error(message);
-            }
-
-            throw e;
+            throw new Error(message);
         }
 
         const eslintPluginOptions = {

lib/utils/has-eslint-configuration.js

@@ -0,0 +1,43 @@
+/*
+ * This file is part of the Symfony Webpack Encore package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+'use strict';
+
+
+function isMissingConfigError(e) {
+    if (!e.message || !e.message.includes('No ESLint configuration found')) {
+        return false;
+    }
+
+    return true;
+}
+
+/**
+ * @returns {Promise<boolean>}
+ */
+module.exports = async function() {
+    /**
+     * @param {WebpackConfig} webpackConfig
+     * @returns {Promise<boolean>}
+     */
+    return async function(webpackConfig) {
+        const { ESLint } = require('eslint'); // eslint-disable-line node/no-unpublished-require
+        const eslint = new ESLint({
+            cwd: webpackConfig.runtimeConfig.context,
+        });
+
+        try {
+            await eslint.calculateConfigForFile('webpack.config.js');
+        } catch (e) {
+            return !isMissingConfigError(e);
+        }
+
+        return true;
+    };
+};

package.json

@@ -45,6 +45,7 @@
     "resolve-url-loader": "^3.1.2",
     "semver": "^7.3.2",
     "style-loader": "^2.0.0",
+    "sync-rpc": "^1.3.6",
     "terser-webpack-plugin": "^5.1.1",
     "tmp": "^0.2.1",
     "webpack": "^5.35",

test/functional.js

@@ -1962,7 +1962,7 @@ module.exports = {
 
             expect(() => {
                 testSetup.runWebpack(config, (webpackAssert, stats) => {});
-            }).to.throw('No ESLint configration has been found.');
+            }).to.throw('No ESLint configuration has been found.');
         });
 
         it('When enabled and without any configuration, ESLint will throw an error and a nice message should be displayed (eslint-webpack-plugin)', (done) => {

yarn.lock

@@ -3619,6 +3619,11 @@ get-intrinsic@^1.0.2, get-intrinsic@^1.1.1:
     has "^1.0.3"
     has-symbols "^1.0.1"
 
+get-port@^3.1.0:
+  version "3.2.0"
+  resolved "https://registry.yarnpkg.com/get-port/-/get-port-3.2.0.tgz#dd7ce7de187c06c8bf353796ac71e099f0980ebc"
+  integrity sha1-3Xzn3hh8Bsi/NTeWrHHgmfCYDrw=
+
 get-stream@^6.0.0:
   version "6.0.1"
   resolved "https://registry.yarnpkg.com/get-stream/-/get-stream-6.0.1.tgz#a262d8eef67aced57c2852ad6167526a43cbf7b7"
@@ -6801,6 +6806,13 @@ symbol-tree@^3.2.2:
   resolved "https://registry.yarnpkg.com/symbol-tree/-/symbol-tree-3.2.4.tgz#430637d248ba77e078883951fb9aa0eed7c63fa2"
   integrity sha512-9QNk5KwDF+Bvz+PyObkmSYjI5ksVUYtjW7AU22r2NKcfLJcXp96hkDWU3+XndOsUb+AQ9QhfzfCT2O+CNWT5Tw==
 
+sync-rpc@^1.3.6:
+  version "1.3.6"
+  resolved "https://registry.yarnpkg.com/sync-rpc/-/sync-rpc-1.3.6.tgz#b2e8b2550a12ccbc71df8644810529deb68665a7"
+  integrity sha512-J8jTXuZzRlvU7HemDgHi3pGnh/rkoqR/OZSjhTyyZrEkkYQbk7Z33AXp37mkPfPpfdOuj7Ex3H/TJM1z48uPQw==
+  dependencies:
+    get-port "^3.1.0"
+
 table@^6.0.9:
   version "6.7.1"
   resolved "https://registry.yarnpkg.com/table/-/table-6.7.1.tgz#ee05592b7143831a8c94f3cee6aae4c1ccef33e2"