fix(eslint-plugin): [member-ordering] correctly invert optionalityOrder (typescript-eslint#6256)

JoshuaKGoldberg · web-flow · commit ccd45d4a9989 · 2022-12-20T17:16:41.000-05:00
diff --git a/packages/eslint-plugin/src/rules/member-ordering.ts b/packages/eslint-plugin/src/rules/member-ordering.ts
@@ -781,7 +781,7 @@ export default util.createRule<Options, MessageIds>({
           data: {
             member: getMemberName(member, context.getSourceCode()),
             optionalOrRequired:
-              optionalityOrder === 'optional-first' ? 'required' : 'optional',
+              optionalityOrder === 'required-first' ? 'required' : 'optional',
           },
         });
 
@@ -790,7 +790,7 @@ export default util.createRule<Options, MessageIds>({
       // have the correct optionality
       if (
         isMemberOptional(members[0]) !==
-        (optionalityOrder === 'required-first')
+        (optionalityOrder === 'optional-first')
       ) {
         report(members[0]);
         return false;
diff --git a/packages/eslint-plugin/tests/rules/member-ordering/member-ordering-optionalMembers.test.ts b/packages/eslint-plugin/tests/rules/member-ordering/member-ordering-optionalMembers.test.ts
@@ -10,7 +10,7 @@ const ruleTester = new RuleTester({
 
 const grouped: TSESLint.RunTests<MessageIds, Options> = {
   valid: [
-    // optionalityOrder - optional-first
+    // optionalityOrder - required-first
     {
       code: `
 interface X {
@@ -24,7 +24,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -42,7 +42,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'as-written',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -60,7 +60,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'as-written',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -78,7 +78,7 @@ class X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -96,7 +96,7 @@ class X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -114,7 +114,7 @@ class X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -132,7 +132,7 @@ class X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -150,7 +150,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -169,12 +169,12 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
     },
-    // optionalityOrder - required-first
+    // optionalityOrder - optional-first
     {
       code: `
 interface X {
@@ -188,7 +188,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
@@ -206,7 +206,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'as-written',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
@@ -224,7 +224,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'as-written',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
@@ -242,13 +242,13 @@ class X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
     },
   ],
-  // optionalityOrder - optional-first
+  // optionalityOrder - required-first
   invalid: [
     {
       code: `
@@ -263,12 +263,16 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
       errors: [
         {
+          data: {
+            member: 'b',
+            beforeMember: 'd',
+          },
           messageId: 'incorrectOrder',
           line: 5,
           column: 3,
@@ -288,7 +292,7 @@ interface X {
           default: {
             memberTypes: ['call-signature', 'field', 'method'],
             order: 'as-written',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -317,7 +321,7 @@ class X {
           default: {
             memberTypes: 'never',
             order: 'as-written',
-            optionalityOrder: 'optional-first',
+            optionalityOrder: 'required-first',
           },
         },
       ],
@@ -333,7 +337,7 @@ class X {
         },
       ],
     },
-    // optionalityOrder - required-first
+    // optionalityOrder - optional-first
     {
       code: `
 interface X {
@@ -347,7 +351,7 @@ interface X {
           default: {
             memberTypes: 'never',
             order: 'alphabetically',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
@@ -372,7 +376,7 @@ interface X {
           default: {
             memberTypes: ['call-signature', 'field', 'method'],
             order: 'as-written',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
@@ -405,7 +409,7 @@ class Test {
           default: {
             memberTypes: 'never',
             order: 'as-written',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
@@ -436,7 +440,7 @@ class Test {
           default: {
             memberTypes: 'never',
             order: 'as-written',
-            optionalityOrder: 'required-first',
+            optionalityOrder: 'optional-first',
           },
         },
       ],
