chore: Rewrite test utils doc generator

Author: just-boris

fixtures/test-utils/glob-test/a.ts

@@ -12,6 +12,7 @@
     "components",
     "schema",
     "test-utils",
+    "test-utils-new",
     "*.js",
     "*.d.ts"
   ],

fixtures/test-utils/glob-test/b.ts

@@ -3,3 +3,4 @@
 export * from './components/interfaces';
 export { writeComponentsDocumentation } from './components';
 export { documentTestUtils } from './test-utils';
+export { writeTestUtilsDocumentation } from './test-utils-new';

fixtures/test-utils/glob-test/tsconfig.json

@@ -0,0 +1,82 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import ts from 'typescript';
+import { extractDeclaration, getDescription, isOptional, stringifyType } from '../components/type-utils';
+import { TestUtilsDoc } from '../test-utils/interfaces';
+
+function getInheritedFrom(declaration: ts.Declaration, currentClassName: string) {
+  if (!ts.isMethodDeclaration(declaration) || !ts.isClassDeclaration(declaration.parent) || !declaration.parent.name) {
+    throw new Error(`Unexpected declaration parent: ${declaration.getText()}`);
+  }
+  const parentName = declaration.parent.name.getText();
+  if (parentName === currentClassName) {
+    return undefined;
+  }
+  return { name: parentName + '.' + declaration.name.getText() };
+}
+
+function getDefaultValue(declaration: ts.Declaration) {
+  if (!ts.isParameter(declaration)) {
+    throw new Error(`Unexpected declaration: ${declaration.getText()}`);
+  }
+  if (!declaration.initializer) {
+    return undefined;
+  }
+  return declaration.initializer.getText();
+}
+
+export default function extractDocumentation(sourceFile: ts.SourceFile, checker: ts.TypeChecker): Array<TestUtilsDoc> {
+  const moduleSymbol = checker.getSymbolAtLocation(sourceFile);
+  if (!moduleSymbol) {
+    throw new Error(`Unable to resolve module: ${sourceFile.fileName}`);
+  }
+
+  const exportSymbols = checker.getExportsOfModule(moduleSymbol);
+  const definitions: Array<TestUtilsDoc> = [];
+
+  for (const symbol of exportSymbols) {
+    if (!(symbol.flags & ts.SymbolFlags.Class)) {
+      throw new Error(`Exported symbol is not a class, got ${checker.symbolToString(symbol)}`);
+    }
+    const className = symbol.getName();
+    const classType = checker.getTypeAtLocation(extractDeclaration(symbol));
+    const classDefinition: TestUtilsDoc = { name: className, methods: [] };
+    for (const property of classType.getProperties()) {
+      const declaration = extractDeclaration(property);
+      const modifiers = (ts.canHaveModifiers(declaration) && ts.getModifiers(declaration)) || [];
+      if (
+        modifiers.find(
+          modifier => modifier.kind & ts.SyntaxKind.ProtectedKeyword || modifier.kind & ts.SyntaxKind.PrivateKeyword
+        )
+      ) {
+        continue;
+      }
+      const type = checker.getTypeAtLocation(declaration);
+      if (type.getCallSignatures().length !== 1) {
+        throw new Error(`Unexpected member on ${className} – ${property.getName()}: ${stringifyType(type, checker)}`);
+      }
+      const returnType = type.getCallSignatures()[0].getReturnType();
+      classDefinition.methods.push({
+        name: property.getName(),
+        description: getDescription(property.getDocumentationComment(checker), declaration).text,
+        inheritedFrom: getInheritedFrom(declaration, className),
+        parameters: type.getCallSignatures()[0].parameters.map(parameter => {
+          const paramType = checker.getTypeAtLocation(extractDeclaration(parameter));
+          return {
+            name: parameter.name,
+            typeName: stringifyType(paramType, checker),
+            description: getDescription(parameter.getDocumentationComment(checker), declaration).text,
+            flags: { isOptional: isOptional(paramType) },
+            defaultValue: getDefaultValue(extractDeclaration(parameter)),
+          };
+        }),
+        returnType: { name: stringifyType(returnType, checker) },
+      });
+    }
+    classDefinition.methods.sort((a, b) => a.name.localeCompare(b.name));
+
+    definitions.push(classDefinition);
+  }
+
+  return definitions;
+}

package.json

@@ -0,0 +1,62 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import fs from 'node:fs';
+import pathe from 'pathe';
+import { bootstrapTypescriptProject } from '../bootstrap/typescript';
+import extractDocumentation from './extractor';
+import { TestUtilsDoc } from '../test-utils/interfaces';
+
+export interface TestUtilsDocumenterOptions {
+  tsconfigPath: string;
+  domUtilsRoot: string;
+  selectorsUtilsRoot: string;
+}
+
+interface TestUtilsDefinitions {
+  domDefinitions: Array<TestUtilsDoc>;
+  selectorsDefinitions: Array<TestUtilsDoc>;
+}
+
+export function documentTestUtilsNew(options: TestUtilsDocumenterOptions): TestUtilsDefinitions {
+  const domUtilsRoot = pathe.resolve(options.domUtilsRoot);
+  const selectorsUtilsRoot = pathe.resolve(options.selectorsUtilsRoot);
+  const program = bootstrapTypescriptProject(options.tsconfigPath);
+  const checker = program.getTypeChecker();
+
+  const domUtilsFile = program.getSourceFiles().find(file => file.fileName === domUtilsRoot);
+  if (!domUtilsFile) {
+    throw new Error(`File '${domUtilsRoot}' not found`);
+  }
+
+  const selectorsUtilsFile = program.getSourceFiles().find(file => file.fileName === selectorsUtilsRoot);
+  if (!selectorsUtilsFile) {
+    throw new Error(`File '${selectorsUtilsFile}' not found`);
+  }
+  return {
+    domDefinitions: extractDocumentation(domUtilsFile, checker),
+    selectorsDefinitions: extractDocumentation(selectorsUtilsFile, checker),
+  };
+}
+
+export function writeTestUtilsDocumentation({
+  outDir,
+  ...rest
+}: TestUtilsDocumenterOptions & { outDir: string }): void {
+  const { domDefinitions, selectorsDefinitions } = documentTestUtilsNew(rest);
+  fs.mkdirSync(outDir, { recursive: true });
+  fs.writeFileSync(
+    pathe.join(outDir, 'dom.js'),
+    `module.exports = { classes: ${JSON.stringify(domDefinitions, null, 2)} };`
+  );
+  fs.writeFileSync(
+    pathe.join(outDir, 'selectors.js'),
+    `module.exports = { classes: ${JSON.stringify(selectorsDefinitions, null, 2)} };`
+  );
+  fs.copyFileSync(require.resolve('./interfaces.d.ts'), pathe.join(outDir, 'interfaces.d.ts'));
+  const dtsTemplate = `import { TestUtilsDefinition } from './interfaces';
+  declare const definitions: TestUtilsDefinition;
+  export = definitions;
+  `;
+  fs.writeFileSync(pathe.join(outDir, 'dom.d.ts'), dtsTemplate);
+  fs.writeFileSync(pathe.join(outDir, 'selectors.d.ts'), dtsTemplate);
+}

src/index.ts

@@ -0,0 +1,30 @@
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+export interface Parameter {
+  name: string;
+  typeName?: string;
+  description?: string;
+  flags: { isOptional?: boolean };
+  defaultValue?: string;
+}
+
+export interface TestUtilMethod {
+  name: string;
+  description?: string;
+  returnType?: {
+    name: string;
+  };
+  parameters: Array<Parameter>;
+  inheritedFrom?: {
+    name: string;
+  };
+}
+
+export interface TestUtilsDoc {
+  name: string;
+  methods: Array<TestUtilMethod>;
+}
+
+export interface TestUtilsDefinition {
+  classes: Array<TestUtilsDoc>;
+}

src/test-utils-new/extractor.ts

@@ -4,9 +4,7 @@ exports[`Generate documentation > For simple cases 1`] = `
 [
   {
     "defaultValue": undefined,
-    "description": "
-
-",
+    "description": undefined,
     "flags": {
       "isOptional": false,
     },
@@ -25,7 +23,7 @@ exports[`Generate documentation > deal with more complex types 1`] = `
       "isOptional": false,
     },
     "name": "all",
-    "typeName": "Array",
+    "typeName": "Array<HTMLElement>",
   },
 ]
 `;

src/test-utils-new/index.ts

@@ -19,32 +19,32 @@ describe('Generate documentation', () => {
 
     const noOpMethod = methods.find(method => method.name === 'noOp');
     expect(noOpMethod).toBeDefined();
-    expect(noOpMethod?.returnType).toEqual({ name: 'void', type: 'intrinsic' });
+    expect(noOpMethod?.returnType).toEqual({ name: 'void' });
     expect(noOpMethod?.parameters).toEqual([]);
     expect(noOpMethod?.description).toBeUndefined();
     expect(noOpMethod?.inheritedFrom).toBeUndefined();
 
     const findStringMethod = methods.find(method => method.name === 'findString');
     expect(findStringMethod).toBeDefined();
-    expect(findStringMethod?.returnType).toEqual({ name: 'string', type: 'intrinsic' });
+    expect(findStringMethod?.returnType).toEqual({ name: 'string' });
     expect(findStringMethod?.parameters).toEqual([]);
     expect(findStringMethod?.description).toBe(
-      'Finds a string.\nThe function may look trivial but people have been losing their words\nsince centuries.\n'
+      'Finds a string.\n\nThe function may look trivial but people have been losing their words\nsince centuries.'
     );
     expect(findStringMethod?.inheritedFrom).toBeUndefined();
 
     const setStringMethod = methods.find(method => method.name === 'setString');
     expect(setStringMethod).toBeDefined();
-    expect(setStringMethod?.returnType).toEqual({ name: 'void', type: 'intrinsic' });
+    expect(setStringMethod?.returnType).toEqual({ name: 'void' });
     expect(setStringMethod?.parameters).toMatchSnapshot();
     expect(setStringMethod?.description).toBe('Short Text');
     expect(setStringMethod?.inheritedFrom).toBeUndefined();
 
     const findObjectMethod = methods.find(method => method.name === 'findObject');
     expect(findObjectMethod).toBeDefined();
-    expect(findObjectMethod?.returnType).toEqual({ name: 'TestReturnType', type: 'reference' });
+    expect(findObjectMethod?.returnType).toEqual({ name: 'TestReturnType' });
     expect(findObjectMethod?.parameters).toEqual([]);
-    expect(findObjectMethod?.description).toBe('Short Text.\nLong Text.\n');
+    expect(findObjectMethod?.description).toBe('Short Text.\n\nLong Text.');
     expect(findObjectMethod?.inheritedFrom).toBeUndefined();
   });
 
@@ -61,26 +61,14 @@ describe('Generate documentation', () => {
 
     const findAllMethod = methods.find(method => method.name === 'findAll');
     expect(findAllMethod).toBeDefined();
-    expect(findAllMethod?.returnType).toEqual({
-      name: 'Array',
-      type: 'reference',
-      typeArguments: [
-        {
-          type: 'reference',
-          name: 'HTMLElement',
-        },
-      ],
-    });
+    expect(findAllMethod?.returnType).toEqual({ name: 'Array<HTMLElement>' });
     expect(findAllMethod?.parameters).toEqual([]);
     expect(findAllMethod?.description).toBeUndefined();
     expect(findAllMethod?.inheritedFrom).toBeUndefined();
 
     const setAllMethod = methods.find(method => method.name === 'setAll');
     expect(setAllMethod).toBeDefined();
-    expect(setAllMethod?.returnType).toEqual({
-      name: 'void',
-      type: 'intrinsic',
-    });
+    expect(setAllMethod?.returnType).toEqual({ name: 'void' });
     expect(setAllMethod?.parameters).toMatchSnapshot();
     expect(setAllMethod?.description).toBeUndefined();
     expect(setAllMethod?.inheritedFrom).toBeUndefined();
@@ -89,7 +77,7 @@ describe('Generate documentation', () => {
   test('and deal with inheritance', () => {
     const results = buildTestUtilsProject('inheritance');
 
-    expect(results.length).toBe(2);
+    expect(results.length).toBe(1);
     const classDoc = results.find(classDoc => classDoc.name === 'TestUtilWrapper');
 
     expect(classDoc).toBeDefined();
@@ -121,11 +109,12 @@ describe('Generate documentation', () => {
         parameters: [
           {
             name: 'order',
+            typeName: '"first" | "last"',
             flags: { isOptional: false },
-            defaultValue: '"first"',
+            defaultValue: "'first'",
           },
         ],
-        returnType: { name: 'void', type: 'intrinsic' },
+        returnType: { name: 'void' },
       },
       {
         name: 'openDropdown',
@@ -137,7 +126,7 @@ describe('Generate documentation', () => {
             defaultValue: 'false',
           },
         ],
-        returnType: { name: 'void', type: 'intrinsic' },
+        returnType: { name: 'void' },
       },
       {
         name: 'selectOption',
@@ -149,7 +138,7 @@ describe('Generate documentation', () => {
             defaultValue: '1',
           },
         ],
-        returnType: { name: 'void', type: 'intrinsic' },
+        returnType: { name: 'void' },
       },
     ]);
   });