[New] add support for @typescript-eslint/parser v5

ljharb · ljharb · commit 5448e2e5e30a · 2021-10-25T16:54:40.000-07:00
diff --git a/.github/workflows/node-4+.yml b/.github/workflows/node-4+.yml
@@ -77,7 +77,7 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
           after_install: |
-            npm install --no-save "eslint@${{ matrix.eslint }}" "@typescript-eslint/parser@${{ matrix.node-version >= 14 && '4' || (matrix.node-version >= 12 && '4' || (matrix.node-version >= 10 && '4.0' || (matrix.node-version >= 8 && '3' || '2'))) }}" "babel-eslint@${{ matrix.babel-eslint }}"
+            npm install --no-save "eslint@${{ matrix.eslint }}" "@typescript-eslint/parser@${{ matrix.node-version >= 14 && '5' || (matrix.node-version >= 12 && '4' || (matrix.node-version >= 10 && '4.0' || (matrix.node-version >= 8 && '3' || '2'))) }}" "babel-eslint@${{ matrix.babel-eslint }}"
           skip-ls-check: true
         env:
           NPM_CONFIG_LEGACY_PEER_DEPS: true
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@ This change log adheres to standards from [Keep a CHANGELOG](http://keepachangel
 ### Added
 * [`no-unused-class-component-methods`]: Handle unused class component methods ([#2166][] @jakeleventhal @pawelnvk)
 * add [`no-arrow-function-lifecycle`] ([#1980][] @ngtan)
+* add support for `@typescript-eslint/parser` v5 (@ljharb)
 
 ### Fixed
 * `propTypes`: add `VoidFunctionComponent` to react generic list ([#3092][] @vedadeepta)
diff --git a/lib/rules/boolean-prop-naming.js b/lib/rules/boolean-prop-naming.js
@@ -233,7 +233,7 @@ module.exports = {
     // --------------------------------------------------------------------------
 
     return {
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!rule || !propsUtil.isPropTypesDeclaration(node)) {
           return;
         }
diff --git a/lib/rules/destructuring-assignment.js b/lib/rules/destructuring-assignment.js
@@ -138,7 +138,7 @@ module.exports = {
     function isInClassProperty(node) {
       let curNode = node.parent;
       while (curNode) {
-        if (curNode.type === 'ClassProperty') {
+        if (curNode.type === 'ClassProperty' || curNode.type === 'PropertyDefinition') {
           return true;
         }
         curNode = curNode.parent;
@@ -221,7 +221,7 @@ module.exports = {
 
         if (
           classComponent && destructuringClass && configuration === 'never'
-          && !(ignoreClassFields && node.parent.type === 'ClassProperty')
+          && !(ignoreClassFields && (node.parent.type === 'ClassProperty' || node.parent.type === 'PropertyDefinition'))
         ) {
           report(context, messages.noDestructAssignment, 'noDestructAssignment', {
             node,
diff --git a/lib/rules/display-name.js b/lib/rules/display-name.js
@@ -124,7 +124,7 @@ module.exports = {
     // --------------------------------------------------------------------------
 
     return {
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!propsUtil.isDisplayNameDeclaration(node)) {
           return;
         }
diff --git a/lib/rules/forbid-foreign-prop-types.js b/lib/rules/forbid-foreign-prop-types.js
@@ -61,7 +61,7 @@ module.exports = {
       let parent = node.parent;
 
       while (parent && parent.type !== 'Program') {
-        if (parent.type === 'ClassProperty') {
+        if (parent.type === 'ClassProperty' || parent.type === 'PropertyDefinition') {
           return parent;
         }
         parent = parent.parent;
diff --git a/lib/rules/forbid-prop-types.js b/lib/rules/forbid-prop-types.js
@@ -156,7 +156,7 @@ module.exports = {
     }
 
     return {
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (
           !propsUtil.isPropTypesDeclaration(node)
           && !shouldCheckContextTypes(node)
diff --git a/lib/rules/jsx-sort-default-props.js b/lib/rules/jsx-sort-default-props.js
@@ -165,7 +165,7 @@ module.exports = {
     // --------------------------------------------------------------------------
 
     return {
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!isDefaultPropsDeclaration(node)) {
           return;
         }
diff --git a/lib/rules/no-arrow-function-lifecycle.js b/lib/rules/no-arrow-function-lifecycle.js
@@ -32,7 +32,7 @@ module.exports = {
         return `: function(${params.join(', ')}) `;
       }
 
-      if (node.type === 'ClassProperty') {
+      if (node.type === 'ClassProperty' || node.type === 'PropertyDefinition') {
         return `(${params.join(', ')}) `;
       }
 
diff --git a/lib/rules/no-typos.js b/lib/rules/no-typos.js
@@ -201,7 +201,7 @@ module.exports = {
         }
       },
 
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!node.static || !utils.isES6Component(node.parent.parent)) {
           return;
         }
diff --git a/lib/rules/no-unused-class-component-methods.js b/lib/rules/no-unused-class-component-methods.js
@@ -191,7 +191,7 @@ module.exports = {
         }
       },
 
-      'ClassProperty, MethodDefinition'(node) {
+      'ClassProperty, MethodDefinition, PropertyDefinition'(node) {
         if (!classInfo) {
           return;
         }
@@ -208,6 +208,7 @@ module.exports = {
 
       'ClassProperty:exit': exitMethod,
       'MethodDefinition:exit': exitMethod,
+      'PropertyDefinition:exit': exitMethod,
 
       MemberExpression(node) {
         if (!classInfo || classInfo.inStatic) {
diff --git a/lib/rules/no-unused-state.js b/lib/rules/no-unused-state.js
@@ -306,7 +306,7 @@ module.exports = {
         }
       },
 
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!classInfo) {
           return;
         }
@@ -345,6 +345,18 @@ module.exports = {
         }
       },
 
+      'PropertyDefinition:exit'(node) {
+        if (
+          classInfo
+          && !node.static
+          && node.value
+          && node.value.type === 'ArrowFunctionExpression'
+        ) {
+          // Forget our set of local aliases.
+          classInfo.aliases = null;
+        }
+      },
+
       MethodDefinition() {
         if (!classInfo) {
           return;
diff --git a/lib/rules/prefer-exact-props.js b/lib/rules/prefer-exact-props.js
@@ -105,7 +105,7 @@ module.exports = {
         typeAliases[node.id.name] = node;
       },
 
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!propsUtil.isPropTypesDeclaration(node)) {
           return;
         }
diff --git a/lib/rules/require-render-return.js b/lib/rules/require-render-return.js
@@ -64,7 +64,7 @@ module.exports = {
             depth++;
           }
           if (
-            /(MethodDefinition|(Class)?Property)$/.test(ancestor.type)
+            /(MethodDefinition|Property|ClassProperty|PropertyDefinition)$/.test(ancestor.type)
             && astUtil.getPropertyName(ancestor) === 'render'
             && depth <= 1
           ) {
diff --git a/lib/rules/sort-comp.js b/lib/rules/sort-comp.js
@@ -388,17 +388,17 @@ module.exports = {
         getter: node.kind === 'get',
         setter: node.kind === 'set',
         staticVariable: node.static
-          && node.type === 'ClassProperty'
+          && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')
           && (!node.value || !astUtil.isFunctionLikeExpression(node.value)),
         staticMethod: node.static
-          && (node.type === 'ClassProperty' || node.type === 'MethodDefinition')
+          && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition' || node.type === 'MethodDefinition')
           && node.value
           && (astUtil.isFunctionLikeExpression(node.value)),
         instanceVariable: !node.static
-          && node.type === 'ClassProperty'
+          && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')
           && (!node.value || !astUtil.isFunctionLikeExpression(node.value)),
         instanceMethod: !node.static
-          && node.type === 'ClassProperty'
+          && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')
           && node.value
           && (astUtil.isFunctionLikeExpression(node.value)),
         typeAnnotation: !!node.typeAnnotation && node.value === null,
diff --git a/lib/rules/sort-prop-types.js b/lib/rules/sort-prop-types.js
@@ -218,7 +218,7 @@ module.exports = {
         }
       },
 
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!propsUtil.isPropTypesDeclaration(node)) {
           return;
         }
diff --git a/lib/rules/state-in-constructor.js b/lib/rules/state-in-constructor.js
@@ -37,7 +37,7 @@ module.exports = {
   create: Components.detect((context, components, utils) => {
     const option = context.options[0] || 'always';
     return {
-      ClassProperty(node) {
+      'ClassProperty, PropertyDefinition'(node) {
         if (
           option === 'always'
           && !node.static
diff --git a/lib/rules/static-property-placement.js b/lib/rules/static-property-placement.js
@@ -140,15 +140,15 @@ module.exports = {
     // Public
     // ----------------------------------------------------------------------
     return {
-      ClassProperty: (node) => {
+      'ClassProperty, PropertyDefinition'(node) {
         if (!utils.getParentES6Component()) {
           return;
         }
 
         reportNodeIncorrectlyPositioned(node, STATIC_PUBLIC_FIELD);
       },
 
-      MemberExpression: (node) => {
+      MemberExpression(node) {
         // If definition type is undefined then it must not be a defining expression or if the definition is inside a
         // class body then skip this node.
         const right = node.parent.right;
@@ -168,7 +168,7 @@ module.exports = {
         reportNodeIncorrectlyPositioned(node, PROPERTY_ASSIGNMENT);
       },
 
-      MethodDefinition: (node) => {
+      MethodDefinition(node) {
         // If the function is inside a class and is static getter then check if correctly positioned
         if (utils.getParentES6Component() && node.static && node.kind === 'get') {
           // Report error if needed
diff --git a/lib/util/Components.js b/lib/util/Components.js
@@ -752,7 +752,7 @@ function componentRule(rule, context) {
       components.add(node, 2);
     },
 
-    ClassProperty(node) {
+    'ClassProperty, PropertyDefinition'(node) {
       node = utils.getParentComponent();
       if (!node) {
         return;
diff --git a/lib/util/defaultProps.js b/lib/util/defaultProps.js
@@ -201,7 +201,7 @@ module.exports = function defaultPropsInstructions(context, components, utils) {
     //     bar: 'baz'
     //   };
     // }
-    ClassProperty(node) {
+    'ClassProperty, PropertyDefinition'(node) {
       if (!(node.static && node.value)) {
         return;
       }
diff --git a/lib/util/makeNoMethodSetStateRule.js b/lib/util/makeNoMethodSetStateRule.js
@@ -83,7 +83,7 @@ function makeNoMethodSetStateRule(methodName, shouldCheckUnsafeCb) {
               depth++;
             }
             if (
-              (ancestor.type !== 'Property' && ancestor.type !== 'MethodDefinition' && ancestor.type !== 'ClassProperty')
+              (ancestor.type !== 'Property' && ancestor.type !== 'MethodDefinition' && ancestor.type !== 'ClassProperty' && ancestor.type !== 'PropertyDefinition')
               || !nameMatches(ancestor.key.name)
               || (mode !== 'disallow-in-func' && depth > 1)
             ) {
diff --git a/lib/util/propTypes.js b/lib/util/propTypes.js
@@ -884,7 +884,7 @@ module.exports = function propTypesInstructions(context, components, utils) {
           let n = propTypes;
           while (n) {
             if (((n.type === 'AssignmentExpression') && propsUtil.isPropTypesDeclaration(n.left))
-              || ((n.type === 'ClassProperty' || n.type === 'Property') && propsUtil.isPropTypesDeclaration(n))) {
+              || ((n.type === 'ClassProperty' || n.type === 'PropertyDefinition' || n.type === 'Property') && propsUtil.isPropTypesDeclaration(n))) {
               // Found a propType used inside of another propType. This is not considered usage, we'll still validate
               // this component.
               isUsedInPropTypes = true;
@@ -1071,7 +1071,7 @@ module.exports = function propTypesInstructions(context, components, utils) {
    * @returns {Boolean} True if the node is a type annotated props declaration, false if not.
    */
   function isAnnotatedClassPropsDeclaration(node) {
-    if (node && node.type === 'ClassProperty') {
+    if (node && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')) {
       const tokens = context.getFirstTokens(node, 2);
       if (
         node.typeAnnotation && (
@@ -1099,7 +1099,7 @@ module.exports = function propTypesInstructions(context, components, utils) {
       }
     },
 
-    ClassProperty(node) {
+    'ClassProperty, PropertyDefinition'(node) {
       if (isAnnotatedClassPropsDeclaration(node)) {
         markPropTypesAsDeclared(node, resolveTypeAnnotation(node));
       } else if (propsUtil.isPropTypesDeclaration(node)) {
diff --git a/lib/util/props.js b/lib/util/props.js
@@ -12,7 +12,7 @@ const astUtil = require('./ast');
  * @returns {Boolean} `true` if the node is a propTypes declaration, `false` if not
  */
 function isPropTypesDeclaration(node) {
-  if (node && node.type === 'ClassProperty') {
+  if (node && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')) {
     // Flow support
     if (node.typeAnnotation && node.key.name === 'props') {
       return true;
@@ -27,7 +27,7 @@ function isPropTypesDeclaration(node) {
  * @returns {Boolean} `true` if the node is a contextTypes declaration, `false` if not
  */
 function isContextTypesDeclaration(node) {
-  if (node && node.type === 'ClassProperty') {
+  if (node && (node.type === 'ClassProperty' || node.type === 'PropertyDefinition')) {
     // Flow support
     if (node.typeAnnotation && node.key.name === 'context') {
       return true;
@@ -72,6 +72,7 @@ function isDefaultPropsDeclaration(node) {
 function isDisplayNameDeclaration(node) {
   switch (node.type) {
     case 'ClassProperty':
+    case 'PropertyDefinition':
       return node.key && node.key.name === 'displayName';
     case 'Identifier':
       return node.name === 'displayName';
diff --git a/package.json b/package.json
@@ -53,7 +53,7 @@
     "@types/eslint": "=7.2.10",
     "@types/estree": "^0.0.50",
     "@types/node": "^14.17.27",
-    "@typescript-eslint/parser": "^2.34.0 || ^3.10.1 || ^4.0.0",
+    "@typescript-eslint/parser": "^2.34.0 || ^3.10.1 || ^4.0.0 || ^5.0.0",
     "aud": "^1.1.5",
     "babel-eslint": "^8 || ^9 || ^10.1.0",
     "eslint": "^3 || ^4 || ^5 || ^6 || ^7",
diff --git a/tests/lib/rules/require-render-return.js b/tests/lib/rules/require-render-return.js
@@ -209,7 +209,7 @@ ruleTester.run('require-render-return', rule, {
       errors: [
         {
           messageId: 'noRenderReturn',
-          type: 'ClassProperty',
+          line: 3,
         },
       ],
     },

Original file line number	Diff line number	Diff line change
`@@ -233,7 +233,7 @@ module.exports = {`
`233`	`233`	`// --------------------------------------------------------------------------`
`234`	`234`
`235`	`235`	`return {`
`236`		`- ClassProperty(node) {`
	`236`	`+ 'ClassProperty, PropertyDefinition'(node) {`
`237`	`237`	`if (!rule \|\| !propsUtil.isPropTypesDeclaration(node)) {`
`238`	`238`	`return;`
`239`	`239`	`}`
Original file line number	Diff line number	Diff line change
`@@ -124,7 +124,7 @@ module.exports = {`
`124`	`124`	`// --------------------------------------------------------------------------`
`125`	`125`
`126`	`126`	`return {`
`127`		`- ClassProperty(node) {`
	`127`	`+ 'ClassProperty, PropertyDefinition'(node) {`
`128`	`128`	`if (!propsUtil.isDisplayNameDeclaration(node)) {`
`129`	`129`	`return;`
`130`	`130`	`}`
Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ module.exports = {`
`61`	`61`	`let parent = node.parent;`
`62`	`62`
`63`	`63`	`while (parent && parent.type !== 'Program') {`
`64`		`- if (parent.type === 'ClassProperty') {`
	`64`	`+ if (parent.type === 'ClassProperty' \|\| parent.type === 'PropertyDefinition') {`
`65`	`65`	`return parent;`
`66`	`66`	`}`
`67`	`67`	`parent = parent.parent;`
Original file line number	Diff line number	Diff line change
`@@ -156,7 +156,7 @@ module.exports = {`
`156`	`156`	`}`
`157`	`157`
`158`	`158`	`return {`
`159`		`- ClassProperty(node) {`
	`159`	`+ 'ClassProperty, PropertyDefinition'(node) {`
`160`	`160`	`if (`
`161`	`161`	`!propsUtil.isPropTypesDeclaration(node)`
`162`	`162`	`&& !shouldCheckContextTypes(node)`
Original file line number	Diff line number	Diff line change
`@@ -165,7 +165,7 @@ module.exports = {`
`165`	`165`	`// --------------------------------------------------------------------------`
`166`	`166`
`167`	`167`	`return {`
`168`		`- ClassProperty(node) {`
	`168`	`+ 'ClassProperty, PropertyDefinition'(node) {`
`169`	`169`	`if (!isDefaultPropsDeclaration(node)) {`
`170`	`170`	`return;`
`171`	`171`	`}`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ module.exports = {`
`32`	`32`	return `: function(${params.join(', ')}) `;
`33`	`33`	`}`
`34`	`34`
`35`		`- if (node.type === 'ClassProperty') {`
	`35`	`+ if (node.type === 'ClassProperty' \|\| node.type === 'PropertyDefinition') {`
`36`	`36`	return `(${params.join(', ')}) `;
`37`	`37`	`}`
`38`	`38`
Original file line number	Diff line number	Diff line change
`@@ -201,7 +201,7 @@ module.exports = {`
`201`	`201`	`}`
`202`	`202`	`},`
`203`	`203`
`204`		`- ClassProperty(node) {`
	`204`	`+ 'ClassProperty, PropertyDefinition'(node) {`
`205`	`205`	`if (!node.static \|\| !utils.isES6Component(node.parent.parent)) {`
`206`	`206`	`return;`
`207`	`207`	`}`