radiant-docs-validator 0.1.9 → 0.1.11

package/dist/index.d.ts

@@ -205,8 +205,14 @@ type RadiantComponentValidationOptions = {
     sourceFile: string;
     validateLinkHref?: (href: string) => void;
     validateAssetHref?: (href: string) => void;
+    validateIconHref?: (href: string, context: IconValidationContext) => void;
+};
+type IconValidationContext = {
+    componentName: string;
+    propName: string;
+    sourceFile: string;
 };
 declare function validateRadiantComponentProps(componentName: string, props: Record<string, unknown>, options: RadiantComponentValidationOptions): void;
 declare function validateRadiantComponentNode(node: MdxJsxElementNode, options: RadiantComponentValidationOptions): void;
 
-export { type AssistantButtonConfig, type AssistantButtonSize, type AssistantConfig, type AssistantIcon, type AssistantNavbarButtonConfig, BASE_COLOR_OPTIONS, type BaseColorByMode, type BaseColorOption, type CardButtonTheme, type CardCoverTheme, type CardTheme, type CodeSyntaxThemeConfig, type CodeTheme, DEFAULT_THEME_COLOR_DARK, DEFAULT_THEME_COLOR_LIGHT, type DocsConfig, type DocsHrefResolution, type DocsTheme, type DocsValidatorOptions, type Footer, type FooterLink, type HiddenPageRoute, type Logo, type LogoVariant, type NavGroup, type NavMenu, type NavMenuItem, type NavOpenApi, type NavOpenApiPage, type NavOpenApiPageRef, type NavPage, type NavTag, type NavbarItem, type NavigationItem, PUBLISHABLE_STATIC_ASSET_EXTENSIONS, type RadiantComponentValidationOptions, type SocialPlatform, type TagTheme, type ThemeColorByMode, configureDocsValidator, getConfig, isPublishableStaticAssetPath, loadOpenApiSpec, resolveDocsHref, resolveDocsPageHref, validateMdxContent, validateRadiantComponentNode, validateRadiantComponentProps };
+export { type AssistantButtonConfig, type AssistantButtonSize, type AssistantConfig, type AssistantIcon, type AssistantNavbarButtonConfig, BASE_COLOR_OPTIONS, type BaseColorByMode, type BaseColorOption, type CardButtonTheme, type CardCoverTheme, type CardTheme, type CodeSyntaxThemeConfig, type CodeTheme, DEFAULT_THEME_COLOR_DARK, DEFAULT_THEME_COLOR_LIGHT, type DocsConfig, type DocsHrefResolution, type DocsTheme, type DocsValidatorOptions, type Footer, type FooterLink, type HiddenPageRoute, type IconValidationContext, type Logo, type LogoVariant, type NavGroup, type NavMenu, type NavMenuItem, type NavOpenApi, type NavOpenApiPage, type NavOpenApiPageRef, type NavPage, type NavTag, type NavbarItem, type NavigationItem, PUBLISHABLE_STATIC_ASSET_EXTENSIONS, type RadiantComponentValidationOptions, type SocialPlatform, type TagTheme, type ThemeColorByMode, configureDocsValidator, getConfig, isPublishableStaticAssetPath, loadOpenApiSpec, resolveDocsHref, resolveDocsPageHref, validateMdxContent, validateRadiantComponentNode, validateRadiantComponentProps };

package/dist/index.js

@@ -239,6 +239,21 @@ function assertHexColor(componentName, propName, value, sourceFile) {
     );
   }
 }
+function validateIconProp(componentName, propName, value, options) {
+  if (typeof value !== "string") return;
+  if (value.trim().length === 0) {
+    componentError(
+      componentName,
+      `Invalid prop "${propName}": expected an Iconify name like "lucide:settings", an HTTP(S) URL, or a docs-root absolute local path like "/icons/settings.svg"`,
+      options.sourceFile
+    );
+  }
+  options.validateIconHref?.(value, {
+    componentName,
+    propName,
+    sourceFile: options.sourceFile
+  });
+}
 function validateCard(props, options) {
   const componentName = "Card";
   assertNoUnknownProps(
@@ -251,6 +266,7 @@ function validateCard(props, options) {
   assertType(componentName, "title", props.title, ["string"], options.sourceFile);
   assertType(componentName, "href", props.href, ["string"], options.sourceFile);
   assertType(componentName, "icon", props.icon, ["string"], options.sourceFile);
+  validateIconProp(componentName, "icon", props.icon, options);
   if (typeof props.href === "string") {
     options.validateLinkHref?.(props.href);
   }
@@ -268,6 +284,7 @@ function validateCard(props, options) {
     assertType("Card.cover", "colors", props.cover.colors, ["array"], options.sourceFile);
     assertType("Card.cover", "patternSeed", props.cover.patternSeed, ["string"], options.sourceFile);
     assertType("Card.cover", "colorSeed", props.cover.colorSeed, ["string"], options.sourceFile);
+    validateIconProp("Card.cover", "icon", props.cover.icon, options);
     if (Array.isArray(props.cover.colors)) {
       if (props.cover.colors.length < 1 || props.cover.colors.length > 4) {
         componentError(
@@ -408,12 +425,14 @@ function validateRadiantComponentProps(componentName, props, options) {
     assertRequired("Tab", "label", props.label, options.sourceFile);
     assertType("Tab", "label", props.label, ["string"], options.sourceFile);
     assertType("Tab", "icon", props.icon, ["string"], options.sourceFile);
+    validateIconProp("Tab", "icon", props.icon, options);
     return;
   }
   if (componentName === "Accordion") {
     assertRequired("Accordion", "title", props.title, options.sourceFile);
     assertType("Accordion", "title", props.title, ["string"], options.sourceFile);
     assertType("Accordion", "icon", props.icon, ["string"], options.sourceFile);
+    validateIconProp("Accordion", "icon", props.icon, options);
     assertType("Accordion", "defaultOpen", props.defaultOpen, ["boolean"], options.sourceFile);
     assertEnum(
       "Accordion",
@@ -434,6 +453,7 @@ function validateRadiantComponentProps(componentName, props, options) {
     );
     assertType("Callout", "title", props.title, ["string", "boolean"], options.sourceFile);
     assertType("Callout", "icon", props.icon, ["string", "boolean"], options.sourceFile);
+    validateIconProp("Callout", "icon", props.icon, options);
     assertType("Callout", "accent", props.accent, ["boolean"], options.sourceFile);
     assertType("Callout", "color", props.color, ["string"], options.sourceFile);
     if (props.title === true) {
@@ -725,6 +745,22 @@ function validateIcon(icon, currentPath) {
     );
   }
 }
+function validateComponentIcon(icon, currentPath) {
+  const trimmedIcon = icon.trim();
+  if (trimmedIcon !== icon) {
+    throwConfigError(
+      "Component icon cannot include leading or trailing whitespace.",
+      currentPath
+    );
+  }
+  if (!isUrl(icon) && !icon.startsWith("/") && !icon.includes(":")) {
+    throwConfigError(
+      `Invalid component icon "${icon}". Component icons must use an Iconify name like "lucide:settings", an HTTP(S) URL, or a docs-root absolute local path like "/icons/settings.svg". Bare icon names are ambiguous.`,
+      currentPath
+    );
+  }
+  validateIcon(icon, currentPath);
+}
 var AVAILABLE_COMPONENTS = [
   "Callout",
   "Tabs",
@@ -1309,39 +1345,59 @@ async function validateNavigationNode(item, currentPath, groupDepth = 0) {
     return;
   }
 }
-function getFirstPagePathFromPageItems(items) {
+function getFirstRouteFromPageItems(items) {
   for (const item of items) {
     if (typeof item === "string") {
-      return item;
+      return {
+        type: "mdx",
+        filePath: item
+      };
     }
     if ("page" in item) {
-      return item.page;
+      return {
+        type: "mdx",
+        filePath: item.page
+      };
+    }
+    if ("openapi" in item) {
+      return {
+        type: "openapi"
+      };
     }
     if ("group" in item) {
-      const nestedPath = getFirstPagePathFromPageItems(item.pages);
-      if (nestedPath) {
-        return nestedPath;
+      const nestedRoute = getFirstRouteFromPageItems(item.pages);
+      if (nestedRoute) {
+        return nestedRoute;
       }
     }
   }
   return void 0;
 }
-function getFirstPagePathFromNavigation(navigation) {
+function getFirstRouteFromNavigation(navigation) {
   if (navigation.pages) {
-    return getFirstPagePathFromPageItems(navigation.pages);
+    return getFirstRouteFromPageItems(navigation.pages);
   }
   if (navigation.menu) {
     for (const menuItem of navigation.menu.items) {
       const submenuPages = menuItem.submenu.pages;
-      if (!submenuPages) {
-        continue;
+      if (submenuPages) {
+        const firstRoute = getFirstRouteFromPageItems(submenuPages);
+        if (firstRoute) {
+          return firstRoute;
+        }
       }
-      const firstPath = getFirstPagePathFromPageItems(submenuPages);
-      if (firstPath) {
-        return firstPath;
+      if (menuItem.submenu.openapi) {
+        return {
+          type: "openapi"
+        };
       }
     }
   }
+  if (navigation.openapi) {
+    return {
+      type: "openapi"
+    };
+  }
   return void 0;
 }
 async function validateNavOpenApi(navOpenApi, currentPath) {
@@ -2526,12 +2582,12 @@ async function validateConfig(config) {
   await validateNavigation(config.navigation);
   config.home = validateHome(config.home);
   if (config.home === void 0) {
-    const fallbackHome = getFirstPagePathFromNavigation(config.navigation);
-    if (fallbackHome) {
-      config.home = fallbackHome;
-    } else if (!config.navigation.openapi) {
+    const fallbackRoute = getFirstRouteFromNavigation(config.navigation);
+    if (fallbackRoute?.type === "mdx") {
+      config.home = fallbackRoute.filePath;
+    } else if (!fallbackRoute) {
       throwConfigError(
-        "Home is undefined and no documentation page exists in navigation to use as fallback.",
+        "Home is undefined and no navigation route exists to use as fallback.",
         ["home"]
       );
     }
@@ -2913,6 +2969,13 @@ function createComponentValidationPlugin(args) {
             linkIndex: args.linkIndex,
             expectedTarget: "asset"
           });
+        },
+        validateIconHref: (href, context) => {
+          validateComponentIcon(href, [
+            context.sourceFile,
+            context.componentName,
+            context.propName
+          ]);
         }
       });
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "radiant-docs-validator",
-  "version": "0.1.9",
+  "version": "0.1.11",
   "description": "Shared validation for Radiant documentation repositories",
   "type": "module",
   "scripts": {