feat!: use flat config by default

Author: ricardogobbosouza

README.md

@@ -114,7 +114,7 @@ Specify the path to the cache location. Can be a file or a directory.
 type configType = 'flat' | 'eslintrc';
 ```
 
-- Default: `eslintrc`
+- Default: `flat`
 
 Specify the type of configuration to use with ESLint.
 
@@ -123,9 +123,6 @@ Specify the type of configuration to use with ESLint.
 
 The new configuration format is explained in its [own documentation](https://eslint.org/docs/latest/use/configure/configuration-files-new).
 
-> This configuration format being considered as experimental, it is not exported in the main ESLint module in ESLint 8.
-> You need to set your `eslintPath` to `eslint/use-at-your-own-risk` for this config format to work.
-
 ### `context`
 
 - Type:

src/options.js

@@ -4,12 +4,10 @@ const schema = require('./options.json');
 
 /** @typedef {import("eslint").ESLint.Options} ESLintOptions */
 /** @typedef {import('eslint').ESLint.LintResult} LintResult */
-/** @typedef {import('eslint').ESLint.LintResultData} LintResultData */
 
 /**
  * @callback FormatterFunction
  * @param {LintResult[]} results
- * @param {LintResultData=} data
  * @returns {string}
  */
 
@@ -50,6 +48,7 @@ function getOptions(pluginOptions) {
   const options = {
     cache: true,
     cacheLocation: 'node_modules/.cache/eslint-webpack-plugin/.eslintcache',
+    configType: 'flat',
     extensions: 'js',
     emitError: true,
     emitWarning: true,

src/options.json

@@ -3,7 +3,7 @@
   "additionalProperties": true,
   "properties": {
     "configType": {
-      "description": "Enable flat config by setting this value to `flat`.",
+      "description": "Specify the type of configuration to use with ESLint, `flat` or `eslintrc`.",
       "type": "string"
     },
     "context": {

test/empty.test.js

@@ -10,7 +10,7 @@ describe('empty', () => {
       context: join(__dirname, 'fixtures', 'empty'),
       mode: 'development',
       entry: '../',
-      plugins: [new ESLintPlugin()],
+      plugins: [new ESLintPlugin({ configType: 'eslintrc' })],
     });
 
     compiler.run((err, stats) => {

test/multiple-instances.test.js

@@ -9,8 +9,16 @@ describe('multiple instances', () => {
       {},
       {
         plugins: [
-          new ESLintPlugin({ ignore: false, exclude: 'error.js' }),
-          new ESLintPlugin({ ignore: false, exclude: 'error.js' }),
+          new ESLintPlugin({
+            configType: 'eslintrc',
+            ignore: false,
+            exclude: 'error.js',
+          }),
+          new ESLintPlugin({
+            configType: 'eslintrc',
+            ignore: false,
+            exclude: 'error.js',
+          }),
         ],
       },
     );
@@ -26,8 +34,16 @@ describe('multiple instances', () => {
       {},
       {
         plugins: [
-          new ESLintPlugin({ ignore: false, exclude: 'good.js' }),
-          new ESLintPlugin({ ignore: false, exclude: 'error.js' }),
+          new ESLintPlugin({
+            configType: 'eslintrc',
+            ignore: false,
+            exclude: 'good.js',
+          }),
+          new ESLintPlugin({
+            configType: 'eslintrc',
+            ignore: false,
+            exclude: 'error.js',
+          }),
         ],
       },
     );
@@ -43,8 +59,16 @@ describe('multiple instances', () => {
       {},
       {
         plugins: [
-          new ESLintPlugin({ ignore: false, exclude: 'error.js' }),
-          new ESLintPlugin({ ignore: false, exclude: 'good.js' }),
+          new ESLintPlugin({
+            configType: 'eslintrc',
+            ignore: false,
+            exclude: 'error.js',
+          }),
+          new ESLintPlugin({
+            configType: 'eslintrc',
+            ignore: false,
+            exclude: 'good.js',
+          }),
         ],
       },
     );

test/utils/conf.js

@@ -14,6 +14,7 @@ export default (entry, pluginConf = {}, webpackConf = {}) => {
     },
     plugins: [
       new ESLintPlugin({
+        configType: 'eslintrc',
         // this disables the use of .eslintignore, since it contains the fixtures
         // folder to skip it on the global linting, but here we want the opposite
         // (we only use .eslintignore on the test that checks this)