Add support for class get/set accessors (resolves #297)

webpro-nl · Oct 17, 2023 · d027e97 · d027e97
1 parent 3e29758
commit d027e97
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 6 deletions.
diff --git a/fixtures/members/members.ts b/fixtures/members/members.ts
@@ -38,10 +38,29 @@ export class MyClass {
   };
 
   dUnusedMember() {}
-  dUsedExternal() {}
+  dUsedExternal() {
+    const value = this.usedGetter;
+    this.usedSetter = value;
+  }
 
   static eUnusedStatic = 1;
   static eUsedExternal = 1;
+
+  public get usedGetter(): string {
+    return 'usedGetter';
+  }
+
+  public set usedSetter(value: string) {
+    console.log(value);
+  }
+
+  public get unusedGetter(): string {
+    return 'unusedGetter';
+  }
+
+  public set unusedSetter(value: string) {
+    console.log(value);
+  }
 }
 
 MyClass.displayName = 'My Class';
diff --git a/src/typescript/ast-helpers.ts b/src/typescript/ast-helpers.ts
@@ -8,7 +8,13 @@ export function isValidImportTypeNode(node: ts.Node): node is ValidImportTypeNod
   return ts.isImportTypeNode(node);
 }
 
-export function isPrivateMember(node: ts.MethodDeclaration | ts.PropertyDeclaration): boolean {
+export function isGetOrSetAccessorDeclaration(node: ts.Node): node is ts.AccessorDeclaration {
+  return node.kind === ts.SyntaxKind.SetAccessor || node.kind === ts.SyntaxKind.GetAccessor;
+}
+
+export function isPrivateMember(
+  node: ts.MethodDeclaration | ts.PropertyDeclaration | ts.SetAccessorDeclaration | ts.GetAccessorDeclaration
+): boolean {
   return node.modifiers?.some(modifier => modifier.kind === ts.SyntaxKind.PrivateKeyword) ?? false;
 }
 

diff --git a/src/typescript/visitors/exports/exportKeyword.ts b/src/typescript/visitors/exports/exportKeyword.ts
@@ -1,7 +1,7 @@
 import ts from 'typescript';
 import { SymbolType } from '../../../types/issues.js';
 import { compact } from '../../../util/array.js';
-import { isPrivateMember, stripQuotes } from '../../ast-helpers.js';
+import { isGetOrSetAccessorDeclaration, isPrivateMember, stripQuotes } from '../../ast-helpers.js';
 import { exportVisitor as visit } from '../index.js';
 
 export default visit(
@@ -62,7 +62,10 @@ export default visit(
         const members = node.members
           .filter(
             (member): member is ts.MethodDeclaration | ts.PropertyDeclaration =>
-              (ts.isPropertyDeclaration(member) || ts.isMethodDeclaration(member)) && !isPrivateMember(member)
+              (ts.isPropertyDeclaration(member) ||
+                ts.isMethodDeclaration(member) ||
+                isGetOrSetAccessorDeclaration(member)) &&
+              !isPrivateMember(member)
           )
           .map(member => ({
             node: member,

diff --git a/test/members.test.ts b/test/members.test.ts
@@ -17,16 +17,18 @@ test('Find unused enum and class members', async () => {
   assert(issues.enumMembers['members.ts']['B_Unused']);
   assert(issues.enumMembers['members.ts']['D_Key']);
 
-  assert.equal(Object.keys(issues.classMembers['members.ts']).length, 4);
+  assert.equal(Object.keys(issues.classMembers['members.ts']).length, 6);
   assert(issues.classMembers['members.ts']['bUnusedPublic']);
   assert(issues.classMembers['members.ts']['cUnusedProp']);
   assert(issues.classMembers['members.ts']['dUnusedMember']);
   assert(issues.classMembers['members.ts']['eUnusedStatic']);
+  assert(issues.classMembers['members.ts']['unusedGetter']);
+  assert(issues.classMembers['members.ts']['unusedSetter']);
 
   assert.deepEqual(counters, {
     ...baseCounters,
     enumMembers: 2,
-    classMembers: 4,
+    classMembers: 6,
     processed: 2,
     total: 2,
   });