preview new test-utils

Author: just-boris

build-tools/tasks/docs.js

@@ -1,8 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 const path = require('path');
-const { writeComponentsDocumentation, documentTestUtils } = require('@cloudscape-design/documenter');
-const { writeFile } = require('../utils/files');
+const { writeComponentsDocumentation, writeTestUtilsDocumentation } = require('../../test-utils-new');
 const workspace = require('../utils/workspace');
 
 module.exports = function docs() {
@@ -15,27 +14,17 @@ module.exports = function docs() {
       TagEditor: ['getTagsDiff'],
     },
   });
-  testUtilDocs();
+  writeTestUtilsDocumentation({
+    outDir: path.join(workspace.apiDocsPath, 'test-utils-doc'),
+    tsconfigPath: require.resolve('../../src/test-utils/tsconfig.json'),
+    domUtils: {
+      root: 'src/test-utils/dom/index.ts',
+      extraExports: ['default', 'ElementWrapper'],
+    },
+    selectorsUtils: {
+      root: 'src/test-utils/selectors/index.ts',
+      extraExports: ['default', 'ElementWrapper'],
+    },
+  });
   return Promise.resolve();
 };
-
-function testUtilDocs() {
-  ['dom', 'selectors'].forEach(testUtilType => {
-    const baseWrapperDefinitions = require(`@cloudscape-design/test-utils-core/test-utils-doc/${testUtilType}`);
-    const componentWrapperDefinitions = documentTestUtils(
-      {
-        tsconfig: require.resolve('../../src/test-utils/tsconfig.json'),
-      },
-      `**/{${testUtilType},types}/**/*`
-    );
-
-    const definitions = [...baseWrapperDefinitions.classes, ...componentWrapperDefinitions];
-    const indexContent = `module.exports = {
-      classes: ${JSON.stringify(definitions)}
-    }
-    `;
-
-    const outPath = path.join(workspace.apiDocsPath, 'test-utils-doc', `${testUtilType}.js`);
-    writeFile(outPath, indexContent);
-  });
-}

eslint.config.mjs

@@ -25,7 +25,7 @@ export default tsEslint.config(
   includeIgnoreFile(path.resolve('.gitignore')),
   {
     // this code does not run, only used as a text content
-    ignores: ['pages/code-editor/samples/**'],
+    ignores: ['pages/code-editor/samples/**', 'test-utils-new'],
   },
   {
     settings: {

src/__tests__/snapshot-tests/documenter.test.ts

@@ -1,9 +1,7 @@
 // Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 // SPDX-License-Identifier: Apache-2.0
 import definitions from '../../../lib/components-definitions/components';
-// @ts-expect-error no typings
 import testUtilDomDefinitions from '../../../lib/components-definitions/test-utils-doc/dom';
-// @ts-expect-error no typings
 import testUtilSelectorsDefinitions from '../../../lib/components-definitions/test-utils-doc/selectors';
 import { getAllComponents } from '../utils';
 

test-utils-new/bootstrap/index.d.ts

@@ -0,0 +1,2 @@
+import { TypeDocAndTSOptions, ProjectReflection } from 'typedoc';
+export declare function bootstrapProject(options: Partial<TypeDocAndTSOptions>, filteringGlob?: string, additionalInputFilePaths?: string[]): ProjectReflection;

test-utils-new/bootstrap/index.js

@@ -0,0 +1,2 @@
+import ts from 'typescript';
+export declare function bootstrapTypescriptProject(tsconfigPath: string): ts.Program;

test-utils-new/bootstrap/index.js.map

@@ -0,0 +1,4 @@
+import ts from 'typescript';
+import type { ComponentDefinition } from './interfaces';
+import type { ExpandedProp, ExtractedDescription } from './extractor';
+export declare function buildComponentDefinition(name: string, dashCaseName: string, props: Array<ExpandedProp>, functions: Array<ExpandedProp>, defaultValues: Record<string, string>, componentDescription: ExtractedDescription, checker: ts.TypeChecker): ComponentDefinition;