Deprecate Encore.enableEslintLoader('extends-name')

symfony · Jan 12, 2020 · c828b32 · c828b32
1 parent 9f31d95
commit c828b32
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 5 deletions.
diff --git a/index.js b/index.js
@@ -1070,18 +1070,14 @@ class Encore {
      * // enables the eslint loaded using the default eslint configuration.
      * Encore.enableEslintLoader();
      *
-     * // Optionally, you can pass in the configuration eslint should extend.
-     * Encore.enableEslintLoader('airbnb');
-     *
      * // You can also pass in an object of options
      * // that will be passed on to the eslint-loader
      * Encore.enableEslintLoader({
-     *     extends: 'airbnb',
      *     emitWarning: false
      * });
      *
      * // For a more advanced usage you can pass in a callback
-     * // https://github.com/MoOx/eslint-loader#options
+     * // https://github.com/webpack-contrib/eslint-loader#options
      * Encore.enableEslintLoader((options) => {
      *      options.extends = 'airbnb';
      *      options.emitWarning = false;

diff --git a/lib/WebpackConfig.js b/lib/WebpackConfig.js
@@ -686,6 +686,8 @@ class WebpackConfig {
         }
 
         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;
             };

diff --git a/test/config-generator.js b/test/config-generator.js
@@ -372,6 +372,10 @@ describe('The config-generator function', () => {
         });
 
         it('enableEslintLoader("extends-name")', () => {
+            before(() => {
+                logger.reset();
+            });
+
             const config = createConfig();
             config.addEntry('main', './main');
             config.publicPath = '/';
@@ -380,6 +384,7 @@ describe('The config-generator function', () => {
 
             const actualConfig = configGenerator(config);
 
+            expect(JSON.stringify(logger.getMessages().deprecation)).to.contain('enableEslintLoader: Extending from a configuration is deprecated, please use a configuration file instead. See https://eslint.org/docs/user-guide/configuring for more information.');
             expect(JSON.stringify(actualConfig.module.rules)).to.contain('eslint-loader');
             expect(JSON.stringify(actualConfig.module.rules)).to.contain('extends-name');
         });