feature #1309 Drop ESLint integration (Kocal)

This PR was merged into the main branch. Discussion ---------- Drop ESLint integration Close #1282, see #1267 (comment) for more information. Removing `Encore.enableEslintPlugin()` from user-land. It will ease Encore maintenance a lot! Users have three options to migrate: 1. Either re-install `eslint-webpack-plugin` and add the plugin back through `Encore.addPlugin(new EslintPlugin())` 2. **Recommended:** Either use ESLint in a dedicated task, ex: a git hook pre-commit, a dedicated npm script, a step in their CI, ... 3. Use alternative (and faster) tools like Biome.js or Oxlint Commits ------- ef70c34 Drop ESLint integration
symfony · Aug 30, 2024 · 3056c2a · 3056c2a
2 parents a39f4a0 + ef70c34
commit 3056c2a
Show file tree

Hide file tree

Showing 13 changed files with 11 additions and 519 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,8 @@ This is a new major version that contains several backwards-compatibility breaks
 
 * #1308 Drop Vue 2 support (End-Of-Life), only Vue 3 is supported (@Kocal)
 
+* #1309 Drop ESLint integration (@Kocal) 
+
 ## 4.7.0
 
 ### Features

diff --git a/index.js b/index.js
@@ -1263,38 +1263,6 @@ class Encore {
         return this;
     }
 
-    /**
-     * If enabled, the eslint-webpack-plugin is enabled.
-     *
-     * https://github.com/webpack-contrib/eslint-webpack-plugin
-     *
-     * ```
-     * // enables the eslint plugin using the default eslint configuration.
-     * Encore.enableEslintPlugin();
-     *
-     * // You can also pass in an object of options
-     * // that will be passed on to the eslint-webpack-plugin
-     * Encore.enableEslintPlugin({
-     *     emitWarning: false
-     * });
-     *
-     * // For a more advanced usage you can pass in a callback
-     * // https://github.com/webpack-contrib/eslint-webpack-plugin#options
-     * Encore.enableEslintPlugin((options) => {
-     *      options.extensions.push('vue'); // to lint Vue files
-     *      options.emitWarning = false;
-     * });
-     * ```
-     *
-     * @param {string|object|function} eslintPluginOptionsOrCallback
-     * @returns {Encore}
-     */
-    enableEslintPlugin(eslintPluginOptionsOrCallback = () => {}) {
-        webpackConfig.enableEslintPlugin(eslintPluginOptionsOrCallback);
-
-        return this;
-    }
-
     /**
      * If enabled, display build notifications using
      * webpack-notifier.

diff --git a/lib/WebpackConfig.js b/lib/WebpackConfig.js
@@ -89,7 +89,6 @@ class WebpackConfig {
         this.useReact = false;
         this.usePreact = false;
         this.useVueLoader = false;
-        this.useEslintPlugin = false;
         this.useTypeScriptLoader = false;
         this.useForkedTypeScriptTypeChecking = false;
         this.useBabelTypeScriptPreset = false;
@@ -134,7 +133,6 @@ class WebpackConfig {
         this.watchOptionsConfigurationCallback = () => {};
         this.devServerOptionsConfigurationCallback = () => {};
         this.vueLoaderOptionsCallback = () => {};
-        this.eslintPluginOptionsCallback = () => {};
         this.tsConfigurationCallback = () => {};
         this.handlebarsConfigurationCallback = () => {};
         this.miniCssExtractLoaderConfigurationCallback = () => {};
@@ -148,7 +146,6 @@ class WebpackConfig {
             less: () => {},
             stylus: () => {},
             vue: () => {},
-            eslint: () => {},
             typescript: () => {},
             handlebars: () => {},
             svelte: () => {},
@@ -765,22 +762,6 @@ class WebpackConfig {
         }
     }
 
-    enableEslintPlugin(eslintPluginOptionsOrCallback = () => {}) {
-        logger.deprecation('The ESLint integration is now deprecated and will be removed in the next major release. Please use the standalone ESLint CLI instead, or use the ESLint Webpack plugin directly.');
-
-        this.useEslintPlugin = true;
-
-        if (typeof eslintPluginOptionsOrCallback === 'function') {
-            this.eslintPluginOptionsCallback = eslintPluginOptionsOrCallback;
-        } else if (typeof eslintPluginOptionsOrCallback === 'object') {
-            this.eslintPluginOptionsCallback = (options) => {
-                Object.assign(options, eslintPluginOptionsOrCallback);
-            };
-        } else {
-            throw new Error('Argument 1 to enableEslintPlugin() must be either an object or callback function.');
-        }
-    }
-
     enableBuildNotifications(enabled = true, notifierPluginOptionsCallback = () => {}) {
         if (typeof notifierPluginOptionsCallback !== 'function') {
             throw new Error('Argument 2 to enableBuildNotifications() must be a callback function.');

diff --git a/lib/config-generator.js b/lib/config-generator.js
@@ -36,7 +36,6 @@ const vuePluginUtil = require('./plugins/vue');
 const friendlyErrorPluginUtil = require('./plugins/friendly-errors');
 const assetOutputDisplay = require('./plugins/asset-output-display');
 const notifierPluginUtil = require('./plugins/notifier');
-const eslintPluginUtil = require('./plugins/eslint');
 const PluginPriorities = require('./plugins/plugin-priorities');
 const applyOptionsCallback = require('./utils/apply-options-callback');
 const copyEntryTmpName = require('./utils/copyEntryTmpName');
@@ -466,8 +465,6 @@ class ConfigGenerator {
 
         vuePluginUtil(plugins, this.webpackConfig);
 
-        eslintPluginUtil(plugins, this.webpackConfig);
-
         if (!this.webpackConfig.runtimeConfig.outputJson) {
             const friendlyErrorPlugin = friendlyErrorPluginUtil(this.webpackConfig);
             plugins.push({

diff --git a/lib/features.js b/lib/features.js
@@ -111,15 +111,6 @@ const features = {
         ],
         description: 'use Vue with JSX support'
     },
-    eslint_plugin: {
-        method: 'enableEslintPlugin()',
-        // eslint is needed so the end-user can do things
-        packages: [
-            { name: 'eslint' },
-            { name: 'eslint-webpack-plugin', enforce_version: true },
-        ],
-        description: 'Enable ESLint checks'
-    },
     copy_files: {
         method: 'copyFiles()',
         packages: [

diff --git a/lib/plugins/eslint.js b/lib/plugins/eslint.js
diff --git a/lib/utils/has-eslint-configuration.js b/lib/utils/has-eslint-configuration.js
diff --git a/package.json b/package.json
@@ -40,7 +40,6 @@
     "resolve-url-loader": "^5.0.0",
     "semver": "^7.3.2",
     "style-loader": "^3.3.0",
-    "sync-rpc": "^1.3.6",
     "tapable": "^2.2.1",
     "terser-webpack-plugin": "^5.3.0",
     "tmp": "^0.2.1",
@@ -70,7 +69,6 @@
     "eslint-plugin-header": "^3.0.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-webpack-plugin": "^3.1.0 || ^4.0.0",
     "file-loader": "^6.0.0",
     "fork-ts-checker-webpack-plugin": "^7.0.0 || ^8.0.0 || ^9.0.0",
     "fs-extra": "^10.0.0",
@@ -112,8 +110,6 @@
     "@vue/babel-plugin-jsx": "^1.0.0",
     "@vue/babel-preset-jsx": "^1.0.0",
     "@vue/compiler-sfc": "^2.6 || ^3.0.2",
-    "eslint": "^8.0.0",
-    "eslint-webpack-plugin": "^3.1.0 || ^4.0.0",
     "file-loader": "^6.0.0",
     "fork-ts-checker-webpack-plugin": "^7.0.0 || ^8.0.0 || ^9.0.0",
     "handlebars": "^4.7.7",
@@ -165,12 +161,6 @@
     "@vue/compiler-sfc": {
       "optional": true
     },
-    "eslint": {
-      "optional": true
-    },
-    "eslint-webpack-plugin": {
-      "optional": true
-    },
     "file-loader": {
       "optional": true
     },

diff --git a/test/WebpackConfig.js b/test/WebpackConfig.js
@@ -1483,29 +1483,29 @@ describe('WebpackConfig object', () => {
             const config = createConfig();
             const callback = (loader) => {};
 
-            expect(config.loaderConfigurationCallbacks['eslint']).to.not.equal(callback);
+            expect(config.loaderConfigurationCallbacks['javascript']).to.not.equal(callback);
 
-            config.configureLoaderRule('eslint', callback);
-            expect(config.loaderConfigurationCallbacks['eslint']).to.equal(callback);
+            config.configureLoaderRule('javascript', callback);
+            expect(config.loaderConfigurationCallbacks['javascript']).to.equal(callback);
         });
 
         it('Call method with a not supported loader', () => {
             const config = createConfig();
 
             expect(() => {
                 config.configureLoaderRule('reason');
-            }).to.throw('Loader "reason" is not configurable. Valid loaders are "javascript", "css", "images", "fonts", "sass", "less", "stylus", "vue", "eslint", "typescript", "handlebars", "svelte" and the aliases "js", "ts", "scss".');
+            }).to.throw('Loader "reason" is not configurable. Valid loaders are "javascript", "css", "images", "fonts", "sass", "less", "stylus", "vue", "typescript", "handlebars", "svelte" and the aliases "js", "ts", "scss".');
         });
 
         it('Call method with not a valid callback', () => {
             const config = createConfig();
 
             expect(() => {
-                config.configureLoaderRule('eslint');
+                config.configureLoaderRule('javascript');
             }).to.throw('Argument 2 to configureLoaderRule() must be a callback function.');
 
             expect(() => {
-                config.configureLoaderRule('eslint', {});
+                config.configureLoaderRule('javascript', {});
             }).to.throw('Argument 2 to configureLoaderRule() must be a callback function.');
         });
     });