chore: Add documenter tests

Author: taheramr

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

@@ -1,6 +1,6 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`definition for 'code-view' matches the snapshot 1`] = `
+exports[`definition for code-view matches the snapshot > code-view 1`] = `
 {
   "dashCaseName": "code-view",
   "events": [],

src/__tests__/documenter.test.ts

@@ -2,8 +2,15 @@
 // SPDX-License-Identifier: Apache-2.0
 import { expect, test } from "vitest";
 
-import apiDocs from "../../lib/components/internal/api-docs/components";
+import componentDefinitions from "../../lib/components/internal/api-docs/components";
+import { getAllComponents } from "./utils";
 
-test.each(Object.entries(apiDocs))("definition for $0 matches the snapshot", (_name, definition) => {
-  expect(definition).toMatchSnapshot();
+test.each<string>(getAllComponents())(`definition for %s matches the snapshot`, (componentName: string) => {
+  const definition = componentDefinitions[componentName];
+  // overriding with a fake value so that when there are icon changes in components this test doesn't block it
+  const iconNameDefinition = definition.properties.find(({ name }: { name: string }) => name === "iconName");
+  if (iconNameDefinition && iconNameDefinition.inlineType?.type === "union") {
+    iconNameDefinition.inlineType.values = ["comes from @cloudscape-design/components"];
+  }
+  expect(definition).toMatchSnapshot(componentName);
 });

src/__tests__/utils.ts

@@ -0,0 +1,27 @@
+/* eslint-env node */
+/* eslint-disable header/header */
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import * as fs from "node:fs";
+import * as path from "node:path";
+
+const componentsDir = path.resolve(__dirname, "../../lib/components");
+
+export function getAllComponents(): string[] {
+  return fs
+    .readdirSync(componentsDir)
+    .filter(
+      (name) =>
+        name !== "internal" &&
+        name !== "test-utils" &&
+        !name.includes(".") &&
+        !name.includes("LICENSE") &&
+        !name.includes("NOTICE"),
+    );
+}
+
+export async function requireComponent(componentName: string) {
+  // eslint-disable-next-line no-unsanitized/method
+  const { default: Component } = await import(path.join(componentsDir, componentName));
+  return Component;
+}