From adb04f441dacb85dd76e6ab3ef7f8aa61060b0dc Mon Sep 17 00:00:00 2001 From: Joe Lencioni Date: Wed, 22 Jan 2020 09:23:23 -0600 Subject: [PATCH] Add v11 node type breaking change to readme This documents the breaking change that landed in https://github.com/babel/babel-eslint/pull/785 --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cc7fd8f5..8966db66 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,16 @@ **babel-eslint** allows you to lint **ALL** valid Babel code with the fantastic [ESLint](https://github.com/eslint/eslint). -## Breaking change in v11.x.x +## Breaking changes in v11.x.x As of the v11.x.x release, babel-eslint now requires Babel as a peer dependency and expects a valid [Babel configuration file](https://babeljs.io/docs/en/configuration) to exist. This ensures that the same Babel configuration is used during both linting and compilation. +v11 also changes some AST node types to match espree v6: + +- `ExperimentalSpreadProperty` became `SpreadElement`. +- `ExperimentalRestProperty` became `RestElement`. +- `Literal` became `JSXText` (for JSXText). + ## When should I use babel-eslint? ESLint's default parser and core rules [only support the latest final ECMAScript standard](https://github.com/eslint/eslint/blob/a675c89573836adaf108a932696b061946abf1e6/README.md#what-about-experimental-features) and do not support experimental (such as new features) and non-standard (such as Flow or TypeScript types) syntax provided by Babel. babel-eslint is a parser that allows ESLint to run on source code that is transformed by Babel.