fix: do not compute definition of ignored fields (YousefED#299) (YousefED#390)

Co-authored-by: Dominik Moritz <[email protected]>

Author: loopingz

test/programs/annotation-tjs/main.ts

@@ -1,4 +1,7 @@
 // All of these formats are defined in this specification: http://json-schema.org/latest/json-schema-validation.html#rfc.section.8.3
+
+interface MyRef {}
+
 interface MyObject {
     /**
      * @TJS-format date-time
@@ -51,7 +54,7 @@ interface MyObject {
     regexPattern: string;
 
     /**
-     * @TJS-pattern ^[a-zA-Z0-9]{4}-abc_123$    
+     * @TJS-pattern ^[a-zA-Z0-9]{4}-abc_123$
      */
     regexPatternWithWhitespace: string;
 
@@ -79,4 +82,9 @@ interface MyObject {
      * @TJS-hide false
      */
     booleanAnnotationWithFalse: string;
+
+    /**
+     * @TJS-ignore
+     */
+    complexWithRefIgnored: MyRef;
 }

typescript-json-schema.ts

@@ -1089,6 +1089,16 @@ export class JsonSchemaGenerator {
 
         let returnedDefinition = definition; // returned definition, may be a $ref
 
+        // Parse property comments now to skip recursive if ignore.
+        if (prop) {
+            const defs = {};
+            const others = {};
+            this.parseCommentsIntoDefinition(prop, defs, others);
+            if (defs.hasOwnProperty("ignore")) {
+                return defs;
+            }
+        }
+
         const symbol = typ.getSymbol();
         // FIXME: We can't just compare the name of the symbol - it ignores the namespace
         const isRawType =
@@ -1176,7 +1186,6 @@ export class JsonSchemaGenerator {
         if (prop) {
             this.parseCommentsIntoDefinition(prop, returnedDefinition, otherAnnotations);
         }
-
         // Create the actual definition only if is an inline definition, or
         // if it will be a $ref and it is not yet created
         if (!asRef || !this.reffedDefinitions[fullTypeName]) {