Fix circular dependency with rule names

Author: zachbryant

src/config/constants.ts

@@ -1 +1,7 @@
 export const PLUGIN_NAME = 'typescript-sort-keys'
+
+export enum RuleNames {
+  Enum = 'enum',
+  StringEnum = 'string-enum',
+  Interface = 'interface',
+}

src/report.ts

@@ -30,10 +30,9 @@ export function reportParentNode(
   context.report({
     loc,
     messageId,
-    node: bodyParent,
     data: {
       unsortedCount,
-      notice: getDeprecationMessage(context.id),
+      notice: getDeprecationMessage(context.id.split('/').at(-1)!),
     },
     fix: fixerFunction,
   })
@@ -50,12 +49,12 @@ 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
     if (finalIndicesToReport[finalIndex]) {
@@ -88,7 +87,6 @@ export function reportBodyNodes(
           options: optionsString,
           notice: getDeprecationMessage(context.id),
         },
-        fix: fixerFunction,
       })
     }
   }

src/rules/enum.ts

@@ -1,6 +1,7 @@
 import { TSESTree } from '@typescript-eslint/utils'
 import { JSONSchema4 } from '@typescript-eslint/utils/json-schema'
 
+import { RuleNames } from '../config/constants'
 import { createReporter } from '../plugin'
 import {
   ErrorMessage,
@@ -15,7 +16,7 @@ import { createRule, RuleMetaData } from '../utils/rule'
 /**
  * The name of this rule.
  */
-export const name = 'enum' as const
+export const name = RuleNames.Enum as const
 
 /**
  * The options this rule can take.

src/rules/interface.ts

@@ -1,6 +1,7 @@
 import { TSESTree } from '@typescript-eslint/utils'
 import { JSONSchema4 } from '@typescript-eslint/utils/json-schema'
 
+import { RuleNames } from '../config/constants'
 import { createReporter } from '../plugin'
 import {
   ErrorMessage,
@@ -15,7 +16,7 @@ import { createRule, RuleMetaData } from '../utils/rule'
 /**
  * The name of this rule.
  */
-export const name = 'interface' as const
+export const name = RuleNames.Interface as const
 
 /**
  * The options this rule can take.

src/rules/string-enum.ts

@@ -1,6 +1,7 @@
 import { AST_NODE_TYPES, TSESTree } from '@typescript-eslint/utils'
 import { JSONSchema4 } from '@typescript-eslint/utils/json-schema'
 
+import { RuleNames } from '../config/constants'
 import { createReporter } from '../plugin'
 import {
   ErrorMessage,
@@ -16,7 +17,7 @@ import { createRule, RuleMetaData } from '../utils/rule'
  * @deprecated
  * The name of this rule.
  */
-export const name = 'string-enum' as const
+export const name = RuleNames.StringEnum as const
 
 /**
  * @deprecated
@@ -74,6 +75,7 @@ const meta: RuleMetaData<errorMessageKeys> = {
   messages: errorMessages,
   fixable: 'code',
   schema,
+  deprecated: true,
 }
 
 /**

src/types/error.ts

@@ -1,6 +1,6 @@
 export enum ErrorMessage {
   InterfaceParentInvalidOrder = `Found {{ unsortedCount }} keys out of order.`,
-  EnumParentInvalidOrder = `{{ notice }}Found {{ unsortedCount }} members out of order.`,
+  EnumParentInvalidOrder = `Found {{ unsortedCount }} members 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 = `{{ notice }}Expected enum members 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 }}`,
 }

src/utils/reportUtils.ts

@@ -1,3 +1,4 @@
+import { PLUGIN_NAME, RuleNames } from '../config/constants'
 import { NodeOrToken, NodePositionInfo } from '../types'
 
 /**
@@ -44,8 +45,8 @@ export function getUnsortedInfo(
 // Return string with url to notify of rule deprecations
 export function getDeprecationMessage(name: string) {
   switch (name) {
-    case enumRuleNameDeprecated:
-      return `DEPRECATED: see [${PLUGIN_NAME}/${enumRuleName}](${getRuleDocsUrl(enumRuleName)})`
+    case RuleNames.StringEnum:
+      return `\nThis rule is deprecated. Use \`${PLUGIN_NAME}/${RuleNames.Enum}\` instead. See docs for more info.`
     default:
       return ''
   }