feat: migrate all message to messageId

scagood · scagood · commit 9dcfd39ace76 · 2024-05-27T13:15:53.000+01:00
diff --git a/rules/always-return.js b/rules/always-return.js
@@ -44,7 +44,7 @@ function isMemberCall(memberName, node) {
 /** @param {Node} node */
 function isFirstArgument(node) {
   return Boolean(
-    node.parent && node.parent.arguments && node.parent.arguments[0] === node
+    node.parent && node.parent.arguments && node.parent.arguments[0] === node,
   )
 }
 
@@ -143,6 +143,9 @@ module.exports = {
         additionalProperties: false,
       },
     ],
+    messages: {
+      thenShouldThrow: 'Each then() should return a value or throw',
+    },
   },
   create(context) {
     const options = context.options[0] || {}
@@ -242,7 +245,7 @@ module.exports = {
           const branch = funcInfo.branchInfoMap[id]
           if (!branch.good) {
             context.report({
-              message: 'Each then() should return a value or throw',
+              messageId: 'thenShouldThrow',
               node: branch.node,
             })
           }
diff --git a/rules/avoid-new.js b/rules/avoid-new.js
@@ -16,12 +16,15 @@ module.exports = {
       url: getDocsUrl('avoid-new'),
     },
     schema: [],
+    messages: {
+      avoidNew: 'Avoid creating new promises.',
+    },
   },
   create(context) {
     return {
       NewExpression(node) {
         if (node.callee.name === 'Promise') {
-          context.report({ node, message: 'Avoid creating new promises.' })
+          context.report({ node, messageId: 'avoidNew' })
         }
       },
     }
diff --git a/rules/no-multiple-resolved.js b/rules/no-multiple-resolved.js
@@ -167,12 +167,12 @@ class CodePathInfo {
    */
   *iterateReports(promiseCodePathContext) {
     const targets = [...this.segmentInfos.values()].filter(
-      (info) => info.resolved
+      (info) => info.resolved,
     )
     for (const segmentInfo of targets) {
       const result = this._getAlreadyResolvedData(
         segmentInfo.segment,
-        promiseCodePathContext
+        promiseCodePathContext,
       )
       if (result) {
         yield {
@@ -191,13 +191,13 @@ class CodePathInfo {
    */
   _getAlreadyResolvedData(segment, promiseCodePathContext) {
     const prevSegments = segment.prevSegments.filter(
-      (prev) => !promiseCodePathContext.isResolvedTryBlockCodePathSegment(prev)
+      (prev) => !promiseCodePathContext.isResolvedTryBlockCodePathSegment(prev),
     )
     if (prevSegments.length === 0) {
       return null
     }
     const prevSegmentInfos = prevSegments.map((prev) =>
-      this._getProcessedSegmentInfo(prev, promiseCodePathContext)
+      this._getProcessedSegmentInfo(prev, promiseCodePathContext),
     )
     if (prevSegmentInfos.every((info) => info.resolved)) {
       // If the previous paths are all resolved, the next path is also resolved.
@@ -278,7 +278,7 @@ class CodePathInfo {
 
     const alreadyResolvedData = this._getAlreadyResolvedData(
       segment,
-      promiseCodePathContext
+      promiseCodePathContext,
     )
     if (alreadyResolvedData) {
       if (alreadyResolvedData.kind === 'certain') {
@@ -375,7 +375,7 @@ module.exports = {
      */
     function verifyMultipleResolvedPath(codePathInfo, promiseCodePathContext) {
       for (const { node, resolved, kind } of codePathInfo.iterateReports(
-        promiseCodePathContext
+        promiseCodePathContext,
       )) {
         report(node, resolved, kind)
       }
@@ -398,7 +398,7 @@ module.exports = {
         const resolverReferences = new Set()
         const resolvers = node.params.filter(
           /** @returns {node is Identifier} */
-          (node) => node && node.type === 'Identifier'
+          (node) => node && node.type === 'Identifier',
         )
         for (const resolver of resolvers) {
           const variable = getScope(context, node).set.get(resolver.name)
@@ -430,7 +430,7 @@ module.exports = {
       },
       /** @param {ThrowableExpression} node */
       'CallExpression, MemberExpression, NewExpression, ImportExpression, YieldExpression:exit'(
-        node
+        node,
       ) {
         lastThrowableExpression = node
       },
diff --git a/rules/no-nesting.js b/rules/no-nesting.js
@@ -18,6 +18,9 @@ module.exports = {
       url: getDocsUrl('no-nesting'),
     },
     schema: [],
+    messages: {
+      avoidNesting: 'Avoid nesting promises.',
+    },
   },
   create(context) {
     /**
@@ -96,13 +99,13 @@ module.exports = {
         //
         const closestCallbackScope = callbackScopes[0]
         for (const reference of iterateDefinedReferences(
-          closestCallbackScope
+          closestCallbackScope,
         )) {
           if (
             node.arguments.some(
               (arg) =>
                 arg.range[0] <= reference.identifier.range[0] &&
-                reference.identifier.range[1] <= arg.range[1]
+                reference.identifier.range[1] <= arg.range[1],
             )
           ) {
             // Argument callbacks refer to variables defined in the callback function.
@@ -112,7 +115,7 @@ module.exports = {
 
         context.report({
           node: node.callee.property,
-          message: 'Avoid nesting promises.',
+          messageId: 'avoidNesting',
         })
       },
     }
diff --git a/rules/no-new-statics.js b/rules/no-new-statics.js
@@ -12,6 +12,9 @@ module.exports = {
     },
     fixable: 'code',
     schema: [],
+    messages: {
+      avoidNewStatic: "Avoid calling 'new' on 'Promise.{{ name }}()'",
+    },
   },
   create(context) {
     return {
@@ -23,12 +26,12 @@ module.exports = {
         ) {
           context.report({
             node,
-            message: "Avoid calling 'new' on 'Promise.{{ name }}()'",
+            messageId: 'avoidNewStatic',
             data: { name: node.callee.property.name },
             fix(fixer) {
               return fixer.replaceTextRange(
                 [node.range[0], node.range[0] + 'new '.length],
-                ''
+                '',
               )
             },
           })
diff --git a/rules/no-promise-in-callback.js b/rules/no-promise-in-callback.js
@@ -18,6 +18,9 @@ module.exports = {
       url: getDocsUrl('no-promise-in-callback'),
     },
     schema: [],
+    messages: {
+      avoidPromiseInCallback: 'Avoid using promises inside of callbacks.',
+    },
   },
   create(context) {
     return {
@@ -34,7 +37,7 @@ module.exports = {
         if (getAncestors(context, node).some(isInsideCallback)) {
           context.report({
             node: node.callee,
-            message: 'Avoid using promises inside of callbacks.',
+            messageId: 'avoidPromiseInCallback',
           })
         }
       },
diff --git a/rules/no-return-in-finally.js b/rules/no-return-in-finally.js
@@ -11,6 +11,9 @@ module.exports = {
       url: getDocsUrl('no-return-in-finally'),
     },
     schema: [],
+    messages: {
+      avoidReturnInFinally: 'No return in finally',
+    },
   },
   create(context) {
     return {
@@ -35,7 +38,7 @@ module.exports = {
               ) {
                 context.report({
                   node: node.callee.property,
-                  message: 'No return in finally',
+                  messageId: 'avoidReturnInFinally',
                 })
               }
             }
diff --git a/rules/param-names.js b/rules/param-names.js
@@ -23,12 +23,18 @@ module.exports = {
         additionalProperties: false,
       },
     ],
+    messages: {
+      resolveParamNames:
+        'Promise constructor parameters must be named to match "{{ resolvePattern }}"',
+      rejectParamNames:
+        'Promise constructor parameters must be named to match "{{ rejectPattern }}"',
+    },
   },
   create(context) {
     const options = context.options[0] || {}
     const resolvePattern = new RegExp(
       options.resolvePattern || '^_?resolve$',
-      'u'
+      'u',
     )
     const rejectPattern = new RegExp(options.rejectPattern || '^_?reject$', 'u')
 
@@ -45,8 +51,7 @@ module.exports = {
           if (resolveParamName && !resolvePattern.test(resolveParamName)) {
             context.report({
               node: params[0],
-              message:
-                'Promise constructor parameters must be named to match "{{ resolvePattern }}"',
+              messageId: 'resolveParamNames',
               data: {
                 resolvePattern: resolvePattern.source,
               },
@@ -56,8 +61,7 @@ module.exports = {
           if (rejectParamName && !rejectPattern.test(rejectParamName)) {
             context.report({
               node: params[1],
-              message:
-                'Promise constructor parameters must be named to match "{{ rejectPattern }}"',
+              messageId: 'rejectParamNames',
               data: {
                 rejectPattern: rejectPattern.source,
               },
diff --git a/rules/prefer-await-to-then.js b/rules/prefer-await-to-then.js
@@ -17,6 +17,9 @@ module.exports = {
       url: getDocsUrl('prefer-await-to-then'),
     },
     schema: [],
+    messages: {
+      preferWaitToCallback: 'Prefer await to then()/catch()/finally().',
+    },
   },
   create(context) {
     /** Returns true if node is inside yield or await expression. */
@@ -52,7 +55,7 @@ module.exports = {
         ) {
           context.report({
             node: node.property,
-            message: 'Prefer await to then()/catch()/finally().',
+            messageId: 'preferWaitToCallback',
           })
         }
       },
diff --git a/rules/valid-params.js b/rules/valid-params.js
@@ -12,6 +12,14 @@ module.exports = {
       url: getDocsUrl('valid-params'),
     },
     schema: [],
+    messages: {
+      requireOneOptionalArgument:
+        'Promise.{{ name }}() requires 0 or 1 arguments, but received {{ numArgs }}',
+      requireOneArgument:
+        'Promise.{{ name }}() requires 1 argument, but received {{ numArgs }}',
+      requireTwoOptionalArgument:
+        'Promise.{{ name }}() requires 1 or 2 arguments, but received {{ numArgs }}',
+    },
   },
   create(context) {
     return {
@@ -30,8 +38,7 @@ module.exports = {
             if (numArgs > 1) {
               context.report({
                 node,
-                message:
-                  'Promise.{{ name }}() requires 0 or 1 arguments, but received {{ numArgs }}',
+                messageId: 'requireOneOptionalArgument',
                 data: { name, numArgs },
               })
             }
@@ -40,8 +47,7 @@ module.exports = {
             if (numArgs < 1 || numArgs > 2) {
               context.report({
                 node,
-                message:
-                  'Promise.{{ name }}() requires 1 or 2 arguments, but received {{ numArgs }}',
+                messageId: 'requireTwoOptionalArgument',
                 data: { name, numArgs },
               })
             }
@@ -55,8 +61,7 @@ module.exports = {
             if (numArgs !== 1) {
               context.report({
                 node,
-                message:
-                  'Promise.{{ name }}() requires 1 argument, but received {{ numArgs }}',
+                messageId: 'requireOneArgument',
                 data: { name, numArgs },
               })
             }
