feat: [member-ordering] add accessor support for member-ordering (#7927)

* Add accessor support for member-ordering * Add test and docs --------- Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>
typescript-eslint · Nov 14, 2023 · 3c8312d · 3c8312d
1 parent 7e353cb
commit 3c8312d
Show file tree

Hide file tree

Showing 4 changed files with 152 additions and 1 deletion.
diff --git a/packages/eslint-plugin/docs/rules/member-ordering.md b/packages/eslint-plugin/docs/rules/member-ordering.md
@@ -126,6 +126,37 @@ The default configuration looks as follows:
 
     "constructor",
 
+    // Accessors
+    "public-static-accessor",
+    "protected-static-accessor",
+    "private-static-accessor",
+    "#private-static-accessor",
+
+    "public-decorated-accessor",
+    "protected-decorated-accessor",
+    "private-decorated-accessor",
+
+    "public-instance-accessor",
+    "protected-instance-accessor",
+    "private-instance-accessor",
+    "#private-instance-accessor",
+
+    "public-abstract-accessor",
+    "protected-abstract-accessor",
+
+    "public-accessor",
+    "protected-accessor",
+    "private-accessor",
+    "#private-accessor",
+
+    "static-accessor",
+    "instance-accessor",
+    "abstract-accessor",
+
+    "decorated-accessor",
+
+    "accessor",
+
     // Getters
     "public-static-get",
     "protected-static-get",

diff --git a/packages/eslint-plugin/src/rules/member-ordering.ts b/packages/eslint-plugin/src/rules/member-ordering.ts
@@ -19,6 +19,7 @@ type ReadonlyType = 'readonly-field' | 'readonly-signature';
 
 type MemberKind =
   | ReadonlyType
+  | 'accessor'
   | 'call-signature'
   | 'constructor'
   | 'field'
@@ -30,6 +31,7 @@ type MemberKind =
 
 type DecoratedMemberKind =
   | Exclude<ReadonlyType, 'readonly-signature'>
+  | 'accessor'
   | 'field'
   | 'get'
   | 'method'
@@ -170,6 +172,37 @@ export const defaultOrder: MemberType[] = [
 
   'constructor',
 
+  // Accessors
+  'public-static-accessor',
+  'protected-static-accessor',
+  'private-static-accessor',
+  '#private-static-accessor',
+
+  'public-decorated-accessor',
+  'protected-decorated-accessor',
+  'private-decorated-accessor',
+
+  'public-instance-accessor',
+  'protected-instance-accessor',
+  'private-instance-accessor',
+  '#private-instance-accessor',
+
+  'public-abstract-accessor',
+  'protected-abstract-accessor',
+
+  'public-accessor',
+  'protected-accessor',
+  'private-accessor',
+  '#private-accessor',
+
+  'static-accessor',
+  'instance-accessor',
+  'abstract-accessor',
+
+  'decorated-accessor',
+
+  'accessor',
+
   // Getters
   'public-static-get',
   'protected-static-get',
@@ -274,6 +307,7 @@ const allMemberTypes = Array.from(
       'method',
       'call-signature',
       'constructor',
+      'accessor',
       'get',
       'set',
       'static-initialization',
@@ -293,12 +327,13 @@ const allMemberTypes = Array.from(
           all.add(`${accessibility}-${type}`); // e.g. `public-field`
         }
 
-        // Only class instance fields, methods, get and set can have decorators attached to them
+        // Only class instance fields, methods, accessors, get and set can have decorators attached to them
         if (
           accessibility !== '#private' &&
           (type === 'readonly-field' ||
             type === 'field' ||
             type === 'method' ||
+            type === 'accessor' ||
             type === 'get' ||
             type === 'set')
         ) {
@@ -355,6 +390,8 @@ function getNodeType(node: Member): MemberKind | null {
       return 'constructor';
     case AST_NODE_TYPES.TSAbstractPropertyDefinition:
       return node.readonly ? 'readonly-field' : 'field';
+    case AST_NODE_TYPES.AccessorProperty:
+      return 'accessor';
     case AST_NODE_TYPES.PropertyDefinition:
       return node.value && functionExpressions.includes(node.value.type)
         ? 'method'

diff --git a/packages/eslint-plugin/tests/rules/member-ordering.test.ts b/packages/eslint-plugin/tests/rules/member-ordering.test.ts
@@ -2055,6 +2055,20 @@ class Foo {
         },
       ],
     },
+    {
+      code: `
+class Foo {
+  accessor bar;
+
+  baz() {}
+}
+      `,
+      options: [
+        {
+          default: ['accessor', 'method'],
+        },
+      ],
+    },
   ],
   invalid: [
     {
@@ -5065,6 +5079,31 @@ interface Foo {
         },
       ],
     },
+    {
+      code: `
+class Foo {
+  accessor bar;
+
+  baz() {}
+}
+      `,
+      options: [
+        {
+          default: ['method', 'accessor'],
+        },
+      ],
+      errors: [
+        {
+          messageId: 'incorrectGroupOrder',
+          data: {
+            name: 'baz',
+            rank: 'accessor',
+          },
+          line: 5,
+          column: 3,
+        },
+      ],
+    },
   ],
 };