[Refactor] no-arrow-function-lifecycle, `no-unused-class-component-…

…methods`: use report/messages convention
jsx-eslint · Nov 25, 2021 · 32f2e24 · 32f2e24
1 parent 94826da
commit 32f2e24
Show file tree

Hide file tree

Showing 3 changed files with 53 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,9 @@ This change log adheres to standards from [Keep a CHANGELOG](http://keepachangel
 
 ## Unreleased
 
+### Changed
+* [Refactor] [`no-arrow-function-lifecycle`], [`no-unused-class-component-methods`]: use report/messages convention (@ljharb)
+
 ## [7.27.1] - 2021.11.18
 
 ### Fixed

diff --git a/lib/rules/no-arrow-function-lifecycle.js b/lib/rules/no-arrow-function-lifecycle.js
@@ -11,6 +11,7 @@ const Components = require('../util/Components');
 const astUtil = require('../util/ast');
 const docsUrl = require('../util/docsUrl');
 const lifecycleMethods = require('../util/lifecycleMethods');
+const report = require('../util/report');
 
 function getText(node) {
   const params = node.value.params.map((p) => p.name);
@@ -26,6 +27,10 @@ function getText(node) {
   return null;
 }
 
+const messages = {
+  lifecycle: '{{propertyName}} is a React lifecycle method, and should not be an arrow function or in a class field. Use an instance method instead.',
+};
+
 module.exports = {
   meta: {
     docs: {
@@ -34,6 +39,7 @@ module.exports = {
       recommended: false,
       url: docsUrl('no-arrow-function-lifecycle'),
     },
+    messages,
     schema: [],
     fixable: 'code',
   },
@@ -95,26 +101,30 @@ module.exports = {
             (previousComment.length > 0 ? previousComment[0] : body).range[0],
           ];
 
-          context.report({
-            node,
-            message: '{{propertyName}} is a React lifecycle method, and should not be an arrow function or in a class field. Use an instance method instead.',
-            data: {
-              propertyName,
-            },
-            fix(fixer) {
-              if (!sourceCode.getCommentsAfter) {
-                // eslint 3.x
-                return isBlockBody && fixer.replaceTextRange(headRange, getText(node));
-              }
-              return [].concat(
-                fixer.replaceTextRange(headRange, getText(node)),
-                isBlockBody ? [] : fixer.replaceTextRange(
-                  bodyRange,
-                  `{ return ${previousComment.map((x) => sourceCode.getText(x)).join('')}${sourceCode.getText(body)}${nextComment.map((x) => sourceCode.getText(x)).join('')}; }`
-                )
-              );
-            },
-          });
+          report(
+            context,
+            messages.lifecycle,
+            'lifecycle',
+            {
+              node,
+              data: {
+                propertyName,
+              },
+              fix(fixer) {
+                if (!sourceCode.getCommentsAfter) {
+                  // eslint 3.x
+                  return isBlockBody && fixer.replaceTextRange(headRange, getText(node));
+                }
+                return [].concat(
+                  fixer.replaceTextRange(headRange, getText(node)),
+                  isBlockBody ? [] : fixer.replaceTextRange(
+                    bodyRange,
+                    `{ return ${previousComment.map((x) => sourceCode.getText(x)).join('')}${sourceCode.getText(body)}${nextComment.map((x) => sourceCode.getText(x)).join('')}; }`
+                  )
+                );
+              },
+            }
+          );
         }
       });
     }

diff --git a/lib/rules/no-unused-class-component-methods.js b/lib/rules/no-unused-class-component-methods.js
@@ -7,6 +7,7 @@
 
 const Components = require('../util/Components');
 const docsUrl = require('../util/docsUrl');
+const report = require('../util/report');
 
 // ------------------------------------------------------------------------------
 // Rule Definition
@@ -92,6 +93,11 @@ function getInitialClassInfo(node, isClass) {
   };
 }
 
+const messages = {
+  unused: 'Unused method or property "{{name}}"',
+  unusedWithClass: 'Unused method or property "{{name}}" of class "{{className}}"',
+};
+
 module.exports = {
   meta: {
     docs: {
@@ -100,6 +106,7 @@ module.exports = {
       recommended: false,
       url: docsUrl('no-unused-class-component-methods'),
     },
+    messages,
     schema: [
       {
         type: 'object',
@@ -137,10 +144,19 @@ module.exports = {
         ) {
           const className = (classInfo.classNode.id && classInfo.classNode.id.name) || '';
 
-          context.report({
-            node,
-            message: `Unused method or property "${name}"${className ? ` of class "${className}"` : ''}`,
-          });
+          const messageID = className ? 'unusedWithClass' : 'unused';
+          report(
+            context,
+            messages[messageID],
+            messageID,
+            {
+              node,
+              data: {
+                name,
+                className,
+              },
+            }
+          );
         }
       }
     }