CHANGELOG.md

@@ -2,6 +2,28 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [4.0.0](https://github.com/webpack-contrib/eslint-loader/compare/v3.0.4...v4.0.0) (2020-04-03)
+
+### Breaking Changes
+
+* drop support for Node < 10.13.0
+* minimum supported eslint version is 6
+
+### [3.0.4](https://github.com/webpack-contrib/eslint-loader/compare/v3.0.3...v3.0.4) (2020-04-02)
+
+
+### Bug Fixes
+
+* [#316](https://github.com/webpack-contrib/eslint-loader/issues/316) updating loader-fs-cache min version ([#317](https://github.com/webpack-contrib/eslint-loader/issues/317)) ([796e3d1](https://github.com/webpack-contrib/eslint-loader/commit/796e3d130a030ce48e14ee3421809ca40d25cde1))
+
+### [3.0.3](https://github.com/webpack-contrib/eslint-loader/compare/v3.0.2...v3.0.3) (2019-12-06)
+
+
+### Bug Fixes
+
+* check result object ([#311](https://github.com/webpack-contrib/eslint-loader/issues/311)) ([6bb1fa6](https://github.com/webpack-contrib/eslint-loader/commit/6bb1fa68d043f00de63cda4d9babd3a2c9a50d58))
+* support webpack 5 ([#312](https://github.com/webpack-contrib/eslint-loader/issues/312)) ([c0a9d0c](https://github.com/webpack-contrib/eslint-loader/commit/c0a9d0c118155c56c41dc344460f333a9e969eaf))
+
 ### [3.0.2](https://github.com/webpack-contrib/eslint-loader/compare/v3.0.1...v3.0.2) (2019-09-27)
 
 

README.md

@@ -13,23 +13,23 @@
 
 # eslint-loader
 
-> ESlint loader for webpack
+> A ESlint loader for webpack
 
 ## Install
 
 ```bash
 npm install eslint-loader --save-dev
 ```
 
-**NOTE**: You also need to install `eslint` from npm, if you haven't already:
+**Note**: You also need to install `eslint` from npm, if you haven't already:
 
 ```bash
 npm install eslint --save-dev
 ```
 
 ## Usage
 
-In your webpack configuration
+In your webpack configuration:
 
 ```js
 module.exports = {
@@ -50,8 +50,7 @@ module.exports = {
 };
 ```
 
-When using with transpiling loaders (like `babel-loader`), make sure they are in correct order
-(bottom to top). Otherwise files will be checked after being processed by `babel-loader`
+When using with transpiling loaders (like `babel-loader`), make sure they are in correct order (bottom to top). Otherwise files will be checked after being processed by `babel-loader`:
 
 ```js
 module.exports = {
@@ -69,8 +68,7 @@ module.exports = {
 };
 ```
 
-To be safe, you can use `enforce: 'pre'` section to check source files, not modified
-by other loaders (like `babel-loader`)
+To be safe, you can use `enforce: 'pre'` section to check source files, not modified by other loaders (like `babel-loader`):
 
 ```js
 module.exports = {
@@ -96,25 +94,20 @@ module.exports = {
 
 ## Options
 
-You can pass [eslint options](http://eslint.org/docs/developer-guide/nodejs-api#cliengine)
-using standard webpack [loader options](https://webpack.js.org/configuration/module/#useentry).
+You can pass [eslint options](http://eslint.org/docs/developer-guide/nodejs-api#cliengine) using standard webpack [loader options](https://webpack.js.org/configuration/module/#useentry).
 
-Note that the config option you provide will be passed to the `CLIEngine`.
-This is a different set of options than what you'd specify in `package.json` or `.eslintrc`.
-See the [eslint docs](http://eslint.org/docs/developer-guide/nodejs-api#cliengine) for more detail.
+**Note**: That the config option you provide will be passed to the `CLIEngine`. This is a different set of options than what you'd specify in `package.json` or `.eslintrc`. See the [eslint docs](http://eslint.org/docs/developer-guide/nodejs-api#cliengine) for more detail.
 
 ### `cache`
 
 - Type: `Boolean|String`
 - Default: `false`
 
-This option will enable caching of the linting results into a file.
-This is particularly useful in reducing linting time when doing a full build.
+This option will enable caching of the linting results into a file. This is particularly useful in reducing linting time when doing a full build.
 
 This can either be a `boolean` value or the cache directory path(ex: `'./.eslint-loader-cache'`).
 
-If `cache: true` is used, the cache file is written to the `./node_modules/.cache` directory.
-This is the recommended usage.
+If `cache: true` is used, the cache is written to the `./node_modules/.cache/eslint-loader` directory. This is the recommended usage.
 
 ```js
 module.exports = {
@@ -139,9 +132,7 @@ module.exports = {
 - Type: `String`
 - Default: `eslint`
 
-Path to `eslint` instance that will be used for linting.
-If the `eslintPath` is a folder like a official eslint, or specify a `formatter` option.
-now you dont have to install `eslint`.
+Path to `eslint` instance that will be used for linting. If the `eslintPath` is a folder like a official eslint, or specify a `formatter` option. Now you dont have to install `eslint`.
 
 ```js
 module.exports = {
@@ -161,14 +152,14 @@ module.exports = {
 };
 ```
 
-### `formatter`
+### `fix`
 
-- Type: `String|Function`
-- Default: `stylish`
+- Type: `Boolean`
+- Default: `false`
 
-This option accepts a function that will have one argument: an array of eslint messages (object).
-The function must return the output as a string.
-You can use official [eslint formatters](https://eslint.org/docs/user-guide/formatters/).
+This option will enable [ESLint autofix feature](http://eslint.org/docs/user-guide/command-line-interface#fix).
+
+**Be careful: this option will change source files.**
 
 ```js
 module.exports = {
@@ -180,39 +171,20 @@ module.exports = {
         exclude: /node_modules/,
         loader: 'eslint-loader',
         options: {
-          // several examples !
-
-          // default value
-          formatter: 'stylish',
-
-          // community formatter
-          formatter: require('eslint-friendly-formatter'),
-
-          // custom formatter
-          formatter: function(results) {
-            // `results` format is available here
-            // http://eslint.org/docs/developer-guide/nodejs-api.html#executeonfiles()
-
-            // you should return a string
-            // DO NOT USE console.*() directly !
-            return 'OUTPUT';
-          },
+          fix: true,
         },
       },
     ],
   },
 };
 ```
 
-### `fix`
+### `formatter`
 
-- Type: `Boolean`
-- Default: `false`
+- Type: `String|Function`
+- Default: `stylish`
 
-This option will enable
-[ESLint autofix feature](http://eslint.org/docs/user-guide/command-line-interface#fix).
-
-**Be careful: this option will change source files.**
+This option accepts a function that will have one argument: an array of eslint messages (object). The function must return the output as a string. You can use official [eslint formatters](https://eslint.org/docs/user-guide/formatters/).
 
 ```js
 module.exports = {
@@ -224,7 +196,23 @@ module.exports = {
         exclude: /node_modules/,
         loader: 'eslint-loader',
         options: {
-          fix: true,
+          // several examples !
+
+          // default value
+          formatter: 'stylish',
+
+          // community formatter
+          formatter: require('eslint-friendly-formatter'),
+
+          // custom formatter
+          formatter: function (results) {
+            // `results` format is available here
+            // http://eslint.org/docs/developer-guide/nodejs-api.html#executeonfiles()
+
+            // you should return a string
+            // DO NOT USE console.*() directly !
+            return 'OUTPUT';
+          },
         },
       },
     ],
@@ -234,9 +222,7 @@ module.exports = {
 
 ### Errors and Warning
 
-**By default the loader will auto adjust error reporting depending
-on eslint errors/warnings counts.**
-You can still force this behavior by using `emitError` **or** `emitWarning` options:
+**By default the loader will auto adjust error reporting depending on eslint errors/warnings counts.** You can still force this behavior by using `emitError` **or** `emitWarning` options:
 
 #### `emitError`
 
@@ -368,11 +354,9 @@ module.exports = {
 - Type: `Boolean|Object`
 - Default: `false`
 
-Write the output of the errors to a file, for example a checkstyle xml file for use for reporting on Jenkins CI
+Write the output of the errors to a file, for example a checkstyle xml file for use for reporting on Jenkins CI.
 
-The `filePath` is an absolute path or relative to the webpack config: `output.path`
-You can pass in a different `formatter` for the output file,
-if none is passed in the default/configured formatter will be used
+The `filePath` is an absolute path or relative to the webpack config: `output.path`. You can pass in a different `formatter` for the output file, if none is passed in the default/configured formatter will be used.
 
 ```js
 module.exports = {
@@ -399,17 +383,11 @@ module.exports = {
 
 ### NoEmitOnErrorsPlugin
 
-`NoEmitOnErrorsPlugin` is now automatically enabled in webpack 4, when mode is either unset,
-or set to production. So even ESLint warnings will fail the build.
-No matter what error settings are used for `eslint-loader`, except if `emitWarning` enabled.
+`NoEmitOnErrorsPlugin` is now automatically enabled in webpack 4, when mode is either unset, or set to production. So even ESLint warnings will fail the build. No matter what error settings are used for `eslint-loader`, except if `emitWarning` enabled.
 
 ### Defining `configFile` or using `eslint -c path/.eslintrc`
 
-Bear in mind that when you define `configFile`, `eslint` doesn't automatically look for
-`.eslintrc` files in the directory of the file to be linted.
-More information is available in official eslint documentation in section
-[_Using Configuration Files_](http://eslint.org/docs/user-guide/configuring#using-configuration-files).
-See [#129](https://github.com/webpack-contrib/eslint-loader/issues/129).
+Bear in mind that when you define `configFile`, `eslint` doesn't automatically look for `.eslintrc` files in the directory of the file to be linted. More information is available in official eslint documentation in section [_Using Configuration Files_](http://eslint.org/docs/user-guide/configuring#using-configuration-files). See [#129](https://github.com/webpack-contrib/eslint-loader/issues/129).
 
 ## Changelog