ci: add test case for circular referencing issue

Author: async3619

src/generators/__snapshots__/class.spec.ts.snap

@@ -82,5 +82,57 @@ type 'MockedClass'.
 | Description | test        |
 
 
+"
+`;
+
+exports[`generateDocsForClass() Function should not generate documentation for circular references 1`] = `
+"# Type \`MockedClass\`
+
+test
+
+## Fields
+
+- [test](#test)
+
+
+### \`test\`
+
+| Name        | Description                    |
+| ----------- | ------------------------------ |
+| Type        | [ChildClass](#type-childclass) |
+| Nullable    | ❌ No                           |
+| Description | test                           |
+
+
+
+## Type \`ChildClass\`
+
+test
+
+### Fields
+
+- [childField](#childfield)
+- [field](#field)
+
+
+#### \`childField\`
+
+| Name        | Description            |
+| ----------- | ---------------------- |
+| Type        | String                 |
+| Nullable    | ❌ No                   |
+| Description | This is a child field. |
+
+
+
+#### \`field\`
+
+| Name        | Description                    |
+| ----------- | ------------------------------ |
+| Type        | [ChildClass](#type-childclass) |
+| Nullable    | ❌ No                           |
+| Description | test                           |
+
+
 "
 `;

src/generators/class.spec.ts

@@ -2,6 +2,7 @@ import "reflect-metadata";
 
 import { generateForClass } from "@generators/class";
 import { DocField } from "@decorators/field";
+import { DocType } from "@root/decorators";
 
 describe("generateDocsForClass() Function", function () {
     it("should be defined", function () {
@@ -62,6 +63,41 @@ describe("generateDocsForClass() Function", function () {
         expect(generatedData).toMatchSnapshot();
     });
 
+    it("should not generate documentation for circular references", function () {
+        @DocType({
+            description: "test",
+        })
+        class ChildClass {
+            @DocField({
+                description: "This is a child field.",
+            })
+            public childField!: string;
+
+            @DocField({
+                description: "test",
+                nullable: false,
+            })
+            public field!: ChildClass;
+        }
+
+        @DocType({
+            description: "test",
+        })
+        class MockedClass {
+            @DocField({
+                description: "test",
+                nullable: false,
+            })
+            public test!: ChildClass;
+        }
+
+        const generatedData = generateForClass(MockedClass, {
+            combineNestedFields: true,
+        });
+
+        expect(generatedData).toMatchSnapshot();
+    });
+
     it("should throw an error if the class is not registered", function () {
         expect(() => {
             generateForClass(String);