update plugin messages

Author: zachbryant

src/plugin.ts

@@ -80,13 +80,18 @@ export function createReporter(
     )
 
     if (unsortedCount > 0) {
-      const fixerFunctionMemoKey = `fixerFunction_${baseMemoKey}`
-      const fixerFunction = memoize(fixerFunctionMemoKey, () =>
+      const fixerFunction = memoize(`fixerFunction_${baseMemoKey}`, () =>
         getFixerFunction(baseMemoKey, createReporterArgs, body, sortedBody),
       )
 
       reportParentNode(createReporterArgs, bodyParent.loc, unsortedCount, fixerFunction)
-      reportBodyNodes(createReporterArgs, nodePositions, sortedBody, finalIndicesToReport)
+      reportBodyNodes(
+        createReporterArgs,
+        nodePositions,
+        sortedBody,
+        finalIndicesToReport,
+        fixerFunction,
+      )
     }
   }
 }

src/report.ts

@@ -27,13 +27,29 @@ export function reportParentNode(
 ) {
   const { context, createReportParentObject } = createReporterArgs
   const { loc, messageId } = createReportParentObject(_loc)
+
+  const { isInsensitive, isNatural, isRequiredFirst, order } = getOptions(
+    createReporterArgs.context,
+  )
+
+  let optionsString = [
+    isRequiredFirst && 'required-first',
+    isInsensitive && 'insensitive',
+    isNatural && 'natural',
+  ]
+    .filter(Boolean)
+    .join(', ')
+  if (optionsString) optionsString += ' '
+
   context.report({
     loc,
     messageId,
     data: {
       plural: unsortedCount > 1 ? 's' : '',
       unsortedCount,
       notice: getDeprecationMessage(context.id.split('/').at(-1)!),
+      order,
+      options: optionsString,
     },
     fix: fixerFunction,
   })
@@ -50,11 +66,9 @@ export function reportBodyNodes(
   nodePositions: Map<NodeOrToken, NodePositionInfo>,
   sortedBody: NodeOrToken[],
   finalIndicesToReport: boolean[],
+  fixerFunction: ReportFixFunction,
 ) {
   const { context, createReportPropertiesObject } = createReporterArgs
-  const { isInsensitive, isNatural, isRequiredFirst, order } = getOptions(
-    createReporterArgs.context,
-  )
 
   for (const [node, { finalIndex }] of nodePositions.entries()) {
     // If the node is not in the correct position, report it
@@ -65,15 +79,6 @@ export function reportBodyNodes(
       assert(loc, 'createReportObject return value must include a node location')
       assert(messageId, 'createReportObject return value must include a problem message')
 
-      let optionsString = [
-        isRequiredFirst && 'required-first',
-        isInsensitive && 'insensitive',
-        isNatural && 'natural',
-      ]
-        .filter(Boolean)
-        .join(', ')
-      if (optionsString) optionsString += ' '
-
       context.report({
         loc,
         messageId,
@@ -84,10 +89,8 @@ export function reportBodyNodes(
             finalIndex + 1 < sortedBody.length
               ? `before '${getPropertyName(sortedBody[finalIndex + 1])}'`
               : 'at the end',
-          order,
-          options: optionsString,
-          notice: getDeprecationMessage(context.id),
         },
+        fix: fixerFunction,
       })
     }
   }

src/types/error.ts

@@ -1,6 +1,6 @@
 export enum ErrorMessage {
-  InterfaceParentInvalidOrder = `Found {{ unsortedCount }} key{{plural}} out of order.`,
-  EnumParentInvalidOrder = `Found {{ unsortedCount }} member{{plural}} out of order.{{ notice }}`,
-  InterfaceInvalidOrder = `Expected interface keys to be in {{ order }}ending {{ options }}order. '{{ nodeName }}' should be {{ messageShouldBeWhere }}. Run autofix to sort entire body.`,
-  EnumInvalidOrder = `Expected enum members to be in {{ order }}ending {{ options }}order. '{{ nodeName }}' should be {{ messageShouldBeWhere }}. Run autofix to sort entire body.{{ notice }}`,
+  InterfaceParentInvalidOrder = `Found {{ unsortedCount }} key{{plural}} out of {{ order }}ending {{ options }}order.`,
+  EnumParentInvalidOrder = `Found {{ unsortedCount }} member{{plural}} out of {{ order }}ending {{ options }}order.{{ notice }}`,
+  InterfaceInvalidOrder = `Property '{{ nodeName }}' should be {{ messageShouldBeWhere }}.`,
+  EnumInvalidOrder = `Member '{{ nodeName }}' should be {{ messageShouldBeWhere }}.`,
 }

src/utils/reportUtils.ts

@@ -49,7 +49,7 @@ export function getUnsortedInfo(
 export function getDeprecationMessage(name: string) {
   switch (name) {
     case RuleNames.StringEnum:
-      return `\nThis rule is deprecated. Use \`${PLUGIN_NAME}/${RuleNames.Enum}\` instead.`
+      return `\nThis rule is deprecated: use \`${PLUGIN_NAME}/${RuleNames.Enum}\` instead.`
     default:
       return ''
   }

tests/helpers/cases/preprocess.ts

@@ -37,23 +37,21 @@ function processErrorArgs(
   }
 
   if (!omitInferredErrorCount)
-    errorMessages.push(getCountErrorString(category, errorArgs.length))
+    errorMessages.push(getCountErrorString(category, optionsSetsKey, errorArgs.length))
 
   for (const args of errorArgs) {
     // At this point args is number or string[]
     if (Array.isArray(args)) {
       switch (args.length) {
         case 1:
-          errorMessages.push(getEndErrorString(category, optionsSetsKey, args[0]))
+          errorMessages.push(getEndErrorString(category, args[0]))
           break
         case 2:
-          errorMessages.push(
-            getSwapErrorString(category, optionsSetsKey, args[0], args[1]),
-          )
+          errorMessages.push(getSwapErrorString(category, args[0], args[1]))
           break
       }
     } else {
-      errorMessages.push(getCountErrorString(category, args))
+      errorMessages.push(getCountErrorString(category, optionsSetsKey, args))
     }
   }
   return errorMessages

tests/helpers/strings.ts

@@ -28,10 +28,10 @@ export enum CaseCategory {
 function getCategoryErrorString(category: CaseCategory) {
   switch (category) {
     case CaseCategory.Interface:
-      return 'interface keys'
+      return 'Property'
     case CaseCategory.Enum:
     default:
-      return 'enum members'
+      return 'Member'
   }
 }
 
@@ -45,27 +45,18 @@ function getCategoryParentErrorString(category: CaseCategory) {
   }
 }
 
-export const getSwapErrorString = (
-  category: CaseCategory,
-  order: OptionsSetsKey,
-  a: string,
-  b: string,
-) => {
-  return `Expected ${getCategoryErrorString(category)} to be in ${
-    orderStrings[order]
-  } order. '${a}' should be before '${b}'. Run autofix to sort entire body.`
+export const getSwapErrorString = (category: CaseCategory, a: string, b: string) => {
+  return `${getCategoryErrorString(category)} '${a}' should be before '${b}'.`
 }
 
-export const getEndErrorString = (
+export const getEndErrorString = (category: CaseCategory, a: string) =>
+  `${getCategoryErrorString(category)} '${a}' should be at the end.`
+
+export const getCountErrorString = (
   category: CaseCategory,
   order: OptionsSetsKey,
-  a: string,
+  count: number,
 ) =>
-  `Expected ${getCategoryErrorString(category)} to be in ${
-    orderStrings[order]
-  } order. '${a}' should be at the end. Run autofix to sort entire body.`
-
-export const getCountErrorString = (category: CaseCategory, count: number) =>
   `Found ${count} ${getCategoryParentErrorString(category)}${
     count > 1 ? 's' : ''
-  } out of order.`
+  } out of ${orderStrings[order]} order.`