diff --git a/eslint/babel-eslint-parser/README.md b/eslint/babel-eslint-parser/README.md index dd63887924..889de538a3 100644 --- a/eslint/babel-eslint-parser/README.md +++ b/eslint/babel-eslint-parser/README.md @@ -34,3 +34,10 @@ Check out the [ESLint docs](http://eslint.org/docs/rules/) for all possible rule ```sh $ eslint your-files-here ``` + +## How does it work? + +ESLint allows custom parsers. This is great but some of the syntax nodes that Babel supports +aren't supported by ESLint. When using this plugin, ESLint is monkeypatched and your code is +transformed into code that ESLint can understand. All location info such as line numbers, +columns is also retained so you can track down errors with ease.