chore: re-enable documenter snapshot tests (#57)

Author: just-boris

scripts/docs.js

@@ -9,8 +9,6 @@ import { dashCase, listPublicDirs, writeSourceFile } from "./utils.js";
 const publicDirs = listPublicDirs("src");
 const targetDir = "lib/components/internal/api-docs";
 
-const importedCoreComponents = ["icon"];
-
 componentDocs();
 testUtilDocs();
 
@@ -22,17 +20,8 @@ function validatePublicFiles(definitionFiles) {
   }
 }
 
-function getNodeModulesInterfacePath(componentName) {
-  return path.resolve("node_modules/@cloudscape-design/components", componentName, "interfaces.d.ts");
-}
-
 function componentDocs() {
-  const nodeModulesDependencyFilePaths = importedCoreComponents.map(getNodeModulesInterfacePath);
-  const definitions = documentComponents(
-    path.resolve("tsconfig.json"),
-    "src/*/index.tsx",
-    nodeModulesDependencyFilePaths,
-  );
+  const definitions = documentComponents(path.resolve("tsconfig.json"), "src/*/index.tsx");
   const outDir = path.join(targetDir, "components");
   const fileNames = definitions
     .filter((definition) => {

src/__tests__/__snapshots__/documenter.test.ts.snap

@@ -10,8 +10,8 @@ exports[`definition for avatar matches the snapshot > avatar 1`] = `
       "description": "Text to describe the avatar for assistive technology.
 When more than one avatar is used, provide a unique label for each.
 For example, "Avatar of John Doe" or "Avatar of generative AI assistant".
-If \`tooltipText\` is used make sure to include it in the \`ariaLabel\`.
-",
+
+If \`tooltipText\` is used make sure to include it in the \`ariaLabel\`.",
       "name": "ariaLabel",
       "optional": false,
       "type": "string",
@@ -36,8 +36,8 @@ Use \`gen-ai\` for AI assistants and \`default\` otherwise.",
       "defaultValue": ""user-profile"",
       "description": "Specifies the icon to be displayed as Avatar.
 Use \`gen-ai\` icon for AI assistants. By default \`user-profile\` icon is used.
-If you set both \`iconName\` and \`initials\`, \`initials\` will take precedence.
-",
+
+If you set both \`iconName\` and \`initials\`, \`initials\` will take precedence.",
       "inlineType": {
         "name": "IconProps.Name",
         "type": "union",
@@ -76,8 +76,8 @@ Use it to define initials that uniquely identify the avatar's owner.",
     },
     {
       "description": "The text content shown in the avatar's tooltip.
-When you use this property, make sure to include it in the \`ariaLabel\`.
-",
+
+When you use this property, make sure to include it in the \`ariaLabel\`.",
       "name": "tooltipText",
       "optional": true,
       "type": "string",

src/__tests__/documenter.test.ts

@@ -4,7 +4,7 @@ import { expect, test } from "vitest";
 
 import { getAllComponents, requireComponentDefinition } from "./utils";
 
-test.skip.each<string>(getAllComponents())(`definition for %s matches the snapshot`, (componentName: string) => {
+test.each<string>(getAllComponents())(`definition for %s matches the snapshot`, (componentName: string) => {
   const definition = requireComponentDefinition(componentName);
 
   // overriding with a fake value so that when there are icon changes in components this test doesn't block it