feat(compare): support ignore jsdoc for methods

Author: BossSloth

scripts/compare/compare-methods.ts

@@ -1,5 +1,5 @@
 import { MethodSignature, Node, ParameterDeclaration, SyntaxKind } from 'ts-morph';
-import { updatePropertyModifiers } from './shared';
+import { CustomJsDocTags, getJsDocTagValues, updatePropertyModifiers } from './shared';
 import { compareTypes } from './type-comparator';
 
 /**
@@ -8,6 +8,12 @@ import { compareTypes } from './type-comparator';
  * @param sourceMethod The method to use as the source of truth
  */
 export function compareAndCorrectMethodTypes(targetMethod: MethodSignature, sourceMethod: MethodSignature): void {
+  const ignore = getJsDocTagValues(targetMethod, CustomJsDocTags.ignore);
+
+  if (ignore.length > 0) {
+    return;
+  }
+
   updatePropertyModifiers(targetMethod, sourceMethod);
 
   // If it has the @native jsDoc don't compare

scripts/compare/compare-properties.ts

@@ -1,14 +1,8 @@
 import { EnumDeclaration, EnumMember, PropertySignature, TypeNode } from 'ts-morph';
 import { handleInterfaceTypeReferences } from './handle-interfaces';
-import { currentTargetSourceFile, getJsDocTagValues, isImportedType, updatePropertyModifiers } from './shared';
+import { currentTargetSourceFile, CustomJsDocTags, getJsDocTagValues, isImportedType, updatePropertyModifiers } from './shared';
 import * as TypeComparator from './type-comparator';
 
-const CustomJsDocTags = {
-  originalName: 'compareOriginalName',
-  currentValue: 'currentValue',
-  ignore: 'ignore',
-};
-
 /**
  * Compares and corrects property types
  * @param targetProp The property to be edited

scripts/compare/shared.ts

@@ -1,6 +1,12 @@
 import { Identifier, ImportSpecifier, InterfaceDeclaration, JSDocableNode, MethodSignature, Node, PropertySignature, QuestionTokenableNode, ReadonlyableNode, SourceFile, Type, TypeLiteralNode, TypeNode } from 'ts-morph';
 import { Logger } from '../logger';
 
+export const CustomJsDocTags = {
+  originalName: 'compareOriginalName',
+  currentValue: 'currentValue',
+  ignore: 'ignore',
+};
+
 /**
  * Interface to represent a task in the processing queue
  */