Remove default throws

JCQuintas · Aug 16, 2024 · f9267b1 · f9267b1
1 parent acb938b
commit f9267b1
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 42 deletions.
diff --git a/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts b/packages/api-docs-builder/ApiBuilders/ComponentApiBuilder.ts
@@ -458,7 +458,7 @@ const attachPropsTable = (reactApi: ComponentReactApi) => {
   const propErrors: Array<[propName: string, error: Error]> = [];
   type Pair = [string, ComponentReactApi['propsTable'][string]];
   const componentProps: ComponentReactApi['propsTable'] = _.fromPairs(
-    Object.entries(reactApi.props!).map(([propName, propDescriptor]): Pair => {
+    Object.entries(reactApi.props).map(([propName, propDescriptor]): Pair => {
       let prop: DescribablePropDescriptor | null;
       try {
         prop = createDescribableProp(propDescriptor, propName);
@@ -645,8 +645,6 @@ export default async function generateComponentApi(
   }
 
   const filename = componentInfo.filename;
-  let reactApi: ComponentReactApi | undefined;
-
   const options = {
     savePropValueAsString: false,
     shouldExtractLiteralValuesFromEnum: true,
@@ -655,20 +653,7 @@ export default async function generateComponentApi(
     shouldIncludePropTagMap: true,
   };
 
-  if (componentInfo.isSystemComponent || componentInfo.name === 'Grid2') {
-    try {
-      reactApi = componentDocToComponentApi(docgenParse(src, options)?.at(0));
-    } catch (error) {
-      // fallback to default logic if there is no `create*` definition.
-      if ((error as Error).message === 'No suitable component definition found.') {
-        reactApi = componentDocToComponentApi(docgenParse(src, options)?.at(0));
-      } else {
-        throw error;
-      }
-    }
-  } else {
-    reactApi = componentDocToComponentApi(docgenParse(src, options)?.at(0));
-  }
+  const reactApi = componentDocToComponentApi(docgenParse(componentInfo.filename, options)?.at(0));
 
   if (!reactApi) {
     throw new Error(`No suitable component definition found in ${filename}`);

diff --git a/packages/api-docs-builder/utils/createDescribableProp.ts b/packages/api-docs-builder/utils/createDescribableProp.ts
@@ -26,7 +26,7 @@ export default function createDescribableProp(
   prop: PropItem,
   propName: string,
 ): DescribablePropDescriptor | null {
-  const { defaultValue, description, required, type } = prop;
+  const { defaultValue, description, required, type, tags } = prop;
 
   const renderedDefaultValue = defaultValue?.value.replace(/\r?\n/g, '');
   const renderDefaultValue = Boolean(
@@ -44,32 +44,13 @@ export default function createDescribableProp(
   });
 
   if (
-    annotation.description.trim() === '' ||
-    annotation.tags.some((tag) => tag.title === 'ignore')
+    description.trim() === '' ||
+    // @ts-expect-error empty object type
+    tags?.ignore
   ) {
     return null;
   }
 
-  if (defaultValue === undefined) {
-    // Assume that this prop:
-    // 1. Is typed by another component
-    // 2. Is forwarded to that component
-    // Then validation is handled by the other component.
-    // Though this does break down if the prop is used in other capacity in the implementation.
-    // So let's hope we don't make this mistake too often.
-  } else if (defaultValue !== undefined && renderDefaultValue) {
-    const shouldHaveDefaultAnnotation =
-      // Discriminator for polymorphism which is not documented at the component level.
-      // The documentation of `component` does not know in which component it is used.
-      propName !== 'component';
-
-    if (shouldHaveDefaultAnnotation) {
-      throw new Error(
-        `JSDoc @default annotation not found. Add \`@default ${defaultValue.value}\` to the JSDoc of this prop.`,
-      );
-    }
-  }
-
   return {
     annotation,
     defaultValue: renderDefaultValue ? renderedDefaultValue! : null,

diff --git a/packages/api-docs-builder/utils/generatePropTypeDescription.ts b/packages/api-docs-builder/utils/generatePropTypeDescription.ts
@@ -105,9 +105,9 @@ export default function generatePropTypeDescription(type: PropItemType): string
 
     case 'union':
       return (
-        type.value
+        (type.value as { value: string }[])
           .map((type2) => {
-            return generatePropTypeDescription(type2);
+            return escapeCell(type2.value);
           })
           // Display one value per line as it's better for visibility.
           .join('<br>&#124;&nbsp;')