Ignore Class, Interface, Namespace for parser

Author: veehz

lib/buildtools/src/build/docs/__tests__/json.test.ts

@@ -115,6 +115,34 @@ describe(buildJson, () => {
       retType: 'number'
     });
   });
+
+  test('Classes, interfaces, and namespaces are ignored for JSON building', async ({ testBundle, project }) => {
+    project.addChild(new td.DeclarationReflection(
+      'TestClass',
+      td.ReflectionKind.Class
+    ));
+    project.addChild(new td.DeclarationReflection(
+      'TestInterface',
+      td.ReflectionKind.Interface
+    ));
+    project.addChild(new td.DeclarationReflection(
+      'TestNamespace',
+      td.ReflectionKind.Namespace
+    ));
+
+    const result = await buildJson(testBundle, outDir, project);
+    expectSuccess(result.severity);
+
+    expect(fs.writeFile).toHaveBeenCalledOnce();
+    const { calls: [[path, data]] } = mockedWriteFile.mock;
+
+    expect(path).toEqual(pathlib.join(outDir, 'jsons', 'test0.json'));
+
+    const parsed = JSON.parse(data as string);
+    expect(parsed).not.toHaveProperty('TestClass');
+    expect(parsed).not.toHaveProperty('TestInterface');
+    expect(parsed).not.toHaveProperty('TestNamespace');
+  });
 });
 
 describe('Test parsers', () => {

lib/buildtools/src/build/docs/json.ts

@@ -64,6 +64,13 @@ function getInvalidExamples(parts: td.CommentTag[]): string[] {
 }
 
 const typeToName = (type: td.SomeType) => type.stringify(td.TypeContext.none);
+const ignoredKinds = new Set<td.ReflectionKind>([
+  td.ReflectionKind.Class,
+  td.ReflectionKind.Interface,
+  td.ReflectionKind.Namespace,
+  td.ReflectionKind.TypeAlias
+]);
+
 export const parsers: {
   [K in td.ReflectionKind]?: (obj: td.DeclarationReflection) => ParserResult
 } = {
@@ -156,8 +163,7 @@ export async function buildJson(bundle: ResolvedBundle, outDir: string, reflecti
   const [jsonData, warnings, errors] = reflection.children!.reduce<
     [Record<string, unknown>, string[], string[]]
   >(([res, warnings, errors], element) => {
-    if (element.kind === td.ReflectionKind.TypeAlias) {
-      // Ignore Type Aliases for JSON documentation
+    if (ignoredKinds.has(element.kind)) {
       return [res, warnings, errors];
     }
 

yarn.lock

@@ -17121,6 +17121,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typescript@npm:^5.8.2":
+  version: 5.9.3
+  resolution: "typescript@npm:5.9.3"
+  bin:
+    tsc: bin/tsc
+    tsserver: bin/tsserver
+  checksum: 10c0/6bd7552ce39f97e711db5aa048f6f9995b53f1c52f7d8667c1abdc1700c68a76a308f579cd309ce6b53646deb4e9a1be7c813a93baaf0a28ccd536a30270e1c5
+  languageName: node
+  linkType: hard
+
 "typescript@npm:^6.0.2":
   version: 6.0.2
   resolution: "typescript@npm:6.0.2"
@@ -17161,6 +17171,16 @@ __metadata:
   languageName: node
   linkType: hard
 
+"typescript@patch:typescript@npm%3A^5.8.2#optional!builtin<compat/typescript>":
+  version: 5.9.3
+  resolution: "typescript@patch:typescript@npm%3A5.9.3#optional!builtin<compat/typescript>::version=5.9.3&hash=5786d5"
+  bin:
+    tsc: bin/tsc
+    tsserver: bin/tsserver
+  checksum: 10c0/ad09fdf7a756814dce65bc60c1657b40d44451346858eea230e10f2e95a289d9183b6e32e5c11e95acc0ccc214b4f36289dcad4bf1886b0adb84d711d336a430
+  languageName: node
+  linkType: hard
+
 "typescript@patch:typescript@npm%3A^6.0.2#optional!builtin<compat/typescript>":
   version: 6.0.2
   resolution: "typescript@patch:typescript@npm%3A6.0.2#optional!builtin<compat/typescript>::version=6.0.2&hash=5786d5"