Removing deprecated Encore.enableEslintLoader()

Author: weaverryan

CHANGELOG.md

@@ -36,6 +36,8 @@ which you may have installed to enable extra features:
 * `stylus-loader` Minimum version increased from `3` to `6` [CHANGELOG](https://github.com/webpack-contrib/stylus-loader/blob/master/CHANGELOG.md#400-2020-09-29)
 * `vue-loader` Minimum version increased from `16` to `17` [CHANGELOG](https://github.com/vuejs/vue-loader/blob/next/CHANGELOG.md#1700-2021-12-12)
 
+* Removed `Encore.enableEslintLoader()`: use `Encore.enableEslintPlugin()`.
+
 ## [v1.8.2](https://github.com/symfony/webpack-encore/releases/tag/v1.8.2)
 
 *Mar 17th, 2022*

index.js

@@ -1260,53 +1260,6 @@ class Encore {
         return this;
     }
 
-    /**
-     * If enabled, the eslint-loader is enabled.
-     *
-     * https://github.com/MoOx/eslint-loader
-     *
-     * ```
-     * // enables the eslint loaded using the default eslint configuration.
-     * Encore.enableEslintLoader();
-     *
-     * // You can also pass in an object of options
-     * // that will be passed on to the eslint-loader
-     * Encore.enableEslintLoader({
-     *     emitWarning: false
-     * });
-     *
-     * // For a more advanced usage you can pass in a callback
-     * // https://github.com/webpack-contrib/eslint-loader#options
-     * Encore.enableEslintLoader((options) => {
-     *      options.extends = 'airbnb';
-     *      options.emitWarning = false;
-     * });
-     *
-     * // configure Encore-specific options
-     * Encore.enableEslintLoader(() => {}, {
-     *     // set optional Encore-specific options, for instance:
-     *
-     *     // lint `.vue` files
-     *     lintVue: true
-     * });
-     * ```
-     *
-     * Supported options:
-     *      * {boolean} lintVue (default=false)
-     *              Configure the loader to lint `.vue` files
-     * ```
-     *
-     * @deprecated Prefer using "Encore.enableEslintPlugin()" instead.
-     * @param {string|object|function} eslintLoaderOptionsOrCallback
-     * @param {object} encoreOptions
-     * @returns {Encore}
-     */
-    enableEslintLoader(eslintLoaderOptionsOrCallback = () => {}, encoreOptions = {}) {
-        webpackConfig.enableEslintLoader(eslintLoaderOptionsOrCallback, encoreOptions);
-
-        return this;
-    }
-
     /**
      * If enabled, the eslint-webpack-plugin is enabled.
      *
@@ -1546,15 +1499,11 @@ class Encore {
      *
      * https://webpack.js.org/concepts/loaders/#configuration
      *
-     * For example, if you are using Vue and ESLint loader,
-     * this is how you can configure ESLint to lint Vue files:
-     *
      * ```
      * Encore
-     *     .enableEslintLoader()
      *     .enableVueLoader()
-     *     .configureLoaderRule('eslint', (loaderRule) => {
-     *          loaderRule.test = /\.(jsx?|vue)/;
+     *     .configureLoaderRule('vue', (loaderRule) => {
+     *         // some custom config for vue-loader
      *     });
      * ```
      *

lib/WebpackConfig.js

@@ -119,7 +119,6 @@ class WebpackConfig {
         this.useReact = false;
         this.usePreact = false;
         this.useVueLoader = false;
-        this.useEslintLoader = false;
         this.useEslintPlugin = false;
         this.useTypeScriptLoader = false;
         this.useForkedTypeScriptTypeChecking = false;
@@ -151,9 +150,6 @@ class WebpackConfig {
             version: null,
             runtimeCompilerBuild: null
         };
-        this.eslintOptions = {
-            lintVue: false,
-        };
         this.persistentCacheBuildDependencies = {};
 
         // Features/Loaders options callbacks
@@ -171,7 +167,6 @@ class WebpackConfig {
         this.watchOptionsConfigurationCallback = () => {};
         this.devServerOptionsConfigurationCallback = () => {};
         this.vueLoaderOptionsCallback = () => {};
-        this.eslintLoaderOptionsCallback = () => {};
         this.eslintPluginOptionsCallback = () => {};
         this.tsConfigurationCallback = () => {};
         this.handlebarsConfigurationCallback = () => {};
@@ -804,46 +799,7 @@ class WebpackConfig {
         }
     }
 
-    enableEslintLoader(eslintLoaderOptionsOrCallback = () => {}, eslintOptions = {}) {
-        logger.deprecation('Encore.enableEslintLoader() is deprecated, please use Encore.enableEslintPlugin() instead.');
-
-        if (this.useEslintPlugin) {
-            throw new Error('Encore.enableEslintLoader() can not be called when Encore.enableEslintPlugin() has been called.');
-        }
-
-        this.useEslintLoader = true;
-
-        if (typeof eslintLoaderOptionsOrCallback === 'function') {
-            this.eslintLoaderOptionsCallback = eslintLoaderOptionsOrCallback;
-        } else if (typeof eslintLoaderOptionsOrCallback === 'string') {
-            logger.deprecation('enableEslintLoader: Extending from a configuration is deprecated, please use a configuration file instead. See https://eslint.org/docs/user-guide/configuring for more information.');
-
-            this.eslintLoaderOptionsCallback = (options) => {
-                options.extends = eslintLoaderOptionsOrCallback;
-            };
-        } else if (typeof eslintLoaderOptionsOrCallback === 'object') {
-            this.eslintLoaderOptionsCallback = (options) => {
-                Object.assign(options, eslintLoaderOptionsOrCallback);
-            };
-        } else {
-            throw new Error('Argument 1 to enableEslintLoader() must be either a string, object or callback function.');
-        }
-
-        // Check allowed keys
-        for (const key of Object.keys(eslintOptions)) {
-            if (!(key in this.eslintOptions)) {
-                throw new Error(`"${key}" is not a valid key for enableEslintLoader(). Valid keys: ${Object.keys(this.eslintOptions).join(', ')}.`);
-            }
-        }
-
-        this.eslintOptions = eslintOptions;
-    }
-
     enableEslintPlugin(eslintPluginOptionsOrCallback = () => {}) {
-        if (this.useEslintLoader) {
-            throw new Error('Encore.enableEslintPlugin() can not be called when Encore.enableEslintLoader() has been called.');
-        }
-
         this.useEslintPlugin = true;
 
         if (typeof eslintPluginOptionsOrCallback === 'function') {

lib/config-generator.js

@@ -22,7 +22,6 @@ const babelLoaderUtil = require('./loaders/babel');
 const tsLoaderUtil = require('./loaders/typescript');
 const vueLoaderUtil = require('./loaders/vue');
 const handlebarsLoaderUtil = require('./loaders/handlebars');
-const eslintLoaderUtil = require('./loaders/eslint');
 // plugins utils
 const miniCssExtractPluginUtil = require('./plugins/mini-css-extract');
 const deleteUnusedEntriesPluginUtil = require('./plugins/delete-unused-entries');
@@ -400,16 +399,6 @@ class ConfigGenerator {
             }));
         }
 
-        if (this.webpackConfig.useEslintLoader) {
-            rules.push(applyRuleConfigurationCallback('eslint', {
-                test: eslintLoaderUtil.getTest(this.webpackConfig),
-                loader: require.resolve('eslint-loader'), //eslint-disable-line node/no-unpublished-require
-                exclude: /node_modules/,
-                enforce: 'pre',
-                options: eslintLoaderUtil.getOptions(this.webpackConfig)
-            }));
-        }
-
         if (this.webpackConfig.useTypeScriptLoader) {
             rules.push(applyRuleConfigurationCallback('typescript', {
                 test: /\.tsx?$/,

lib/features.js

@@ -117,15 +117,6 @@ const features = {
         ],
         description: 'use Vue with JSX support'
     },
-    eslint: {
-        method: 'enableEslintLoader()',
-        // eslint is needed so the end-user can do things
-        packages: [
-            { name: 'eslint' },
-            { name: 'eslint-loader', enforce_version: true },
-        ],
-        description: 'Enable ESLint checks'
-    },
     eslint_plugin: {
         method: 'enableEslintPlugin()',
         // eslint is needed so the end-user can do things

lib/loaders/eslint.js

@@ -70,7 +70,6 @@
     "chai-subset": "^1.6.0",
     "core-js": "^3.0.0",
     "eslint": "^8.0.0",
-    "eslint-loader": "^4.0.0",
     "eslint-plugin-header": "^3.0.0",
     "eslint-plugin-import": "^2.8.0",
     "eslint-plugin-node": "^11.1.0",

package.json

@@ -1549,37 +1549,6 @@ describe('WebpackConfig object', () => {
         });
     });
 
-    describe('enableEslintLoader', () => {
-        it('Should validate Encore-specific options', () => {
-            const config = createConfig();
-
-            expect(() => {
-                config.enableEslintLoader(() => {}, {
-                    notExisting: false,
-                });
-            }).to.throw('"notExisting" is not a valid key for enableEslintLoader(). Valid keys: lintVue.');
-        });
-
-        it('ESLint loader can not be enabled if ESLint Webpack Plugin is already enabled', () => {
-            const config = createConfig();
-            config.enableEslintPlugin();
-
-            expect(function() {
-                config.enableEslintLoader();
-            }).to.throw('Encore.enableEslintLoader() can not be called when Encore.enableEslintPlugin() has been called.');
-        });
-    });
-    describe('enableEslintPlugin', () => {
-        it('ESLint loader can not be enabled if ESLint Webpack Plugin is already enabled', () => {
-            const config = createConfig();
-            config.enableEslintLoader();
-
-            expect(function() {
-                config.enableEslintPlugin();
-            }).to.throw('Encore.enableEslintPlugin() can not be called when Encore.enableEslintLoader() has been called.');
-        });
-    });
-
     describe('validateNameIsNewEntry', () => {
         it('Providing a new name does not throw an error', () => {
             const config = createConfig();