Merge pull request #1461 from opencomponents/no-robots-option

ricardo-devis-agullo · web-flow · commit de6e75c1a878 · 2025-11-06T13:13:07.000+01:00
add no robots option
diff --git a/preview/fakeVM.ts b/preview/fakeVM.ts
@@ -79,6 +79,7 @@ export const mockComponentHistory: ComponentHistory[] = [
 
 // Mock data for Index VM (main registry page)
 export const mockIndexVM: IndexVm = {
+  robots: true,
   availableDependencies: [
     {
       core: true,
@@ -407,6 +408,7 @@ export const mockIndexVM: IndexVm = {
 
 // Mock data for Info VM (component detail page)
 export const mockInfoVM: InfoVm = {
+  robots: true,
   parsedAuthor: {
     name: 'Jane Smith',
     email: 'jane.smith@company.com',
diff --git a/src/registry/domain/options-sanitiser.ts b/src/registry/domain/options-sanitiser.ts
@@ -24,6 +24,7 @@ export interface RegistryOptions<T = any>
         experimental?: boolean;
         api?: boolean;
         validate?: boolean;
+        robots?: boolean;
       }
     | boolean;
   /**
@@ -85,6 +86,10 @@ export default function optionsSanitiser(input: RegistryOptions): Config {
     typeof options.discovery === 'boolean'
       ? options.discovery
       : (options.discovery?.ui ?? true);
+  const showRobots =
+    typeof options.discovery === 'boolean'
+      ? true
+      : (options.discovery?.robots ?? true);
   const showExperimental = !showApi
     ? false
     : typeof options.discovery === 'boolean'
@@ -102,7 +107,8 @@ export default function optionsSanitiser(input: RegistryOptions): Config {
     ui: showUI,
     experimental: showExperimental,
     api: showApi,
-    validate: showValidation
+    validate: showValidation,
+    robots: showRobots
   };
 
   if (typeof options.pollingInterval === 'undefined') {
diff --git a/src/registry/routes/component-info.ts b/src/registry/routes/component-info.ts
@@ -85,7 +85,8 @@ function componentInfo(
           repositoryUrl,
           sandBoxDefaultQs: urlBuilder.queryString(params),
           title: 'Component Info',
-          theme
+          theme,
+          robots: res.conf.discovery.robots
         })
       );
     });
diff --git a/src/registry/routes/component-preview.ts b/src/registry/routes/component-preview.ts
@@ -32,6 +32,7 @@ function componentPreview(
   if (isHtmlRequest) {
     res.send(
       previewView({
+        robots: res.conf.discovery.robots,
         component,
         importmap: getOcConfig(res.conf.path)?.development?.importmap,
         fallbackClient: res.conf.fallbackClient
diff --git a/src/registry/views/index.tsx b/src/registry/views/index.tsx
@@ -19,7 +19,13 @@ export default function indexView(vm: VM) {
 ${indexJS}</script>`;
 
   return (
-    <Layout scripts={scripts} href={vm.href} title={vm.title} theme={vm.theme}>
+    <Layout
+      scripts={scripts}
+      href={vm.href}
+      title={vm.title}
+      theme={vm.theme}
+      robots={vm.robots}
+    >
       <section class="hero">
         <h1>OpenComponents Registry</h1>
 
diff --git a/src/registry/views/info.tsx b/src/registry/views/info.tsx
@@ -18,6 +18,7 @@ export interface Vm {
   title: string;
   theme: 'light' | 'dark';
   repositoryUrl: string | null;
+  robots: boolean;
 }
 
 function formatDate(date: Date | string) {
@@ -224,7 +225,13 @@ export default function Info(vm: Vm) {
   `;
 
   return (
-    <Layout scripts={scripts} href={href} title={vm.title} theme={vm.theme}>
+    <Layout
+      scripts={scripts}
+      href={href}
+      title={vm.title}
+      theme={vm.theme}
+      robots={vm.robots}
+    >
       <section class="hero">
         <nav class="breadcrumb">
           <a href={href}>← All components</a>
diff --git a/src/registry/views/partials/layout.tsx b/src/registry/views/partials/layout.tsx
@@ -7,10 +7,18 @@ interface LayoutProps {
   children: JSX.Element | JSX.Element[];
   scripts: string;
   theme: 'light' | 'dark';
+  robots: boolean;
 }
 
 // const imgSrc = '/logo.png';
-const Layout = ({ title, href, children, scripts, theme }: LayoutProps) => {
+const Layout = ({
+  title,
+  href,
+  children,
+  scripts,
+  theme,
+  robots
+}: LayoutProps) => {
   const normalizedHref = href
     .replace('http://', '//')
     .replace('https://', '//');
@@ -25,7 +33,10 @@ const Layout = ({ title, href, children, scripts, theme }: LayoutProps) => {
         <head>
           <title safe>{title}</title>
           <meta charset="UTF-8" />
-          <meta name="robots" content="index, follow" />
+          <meta
+            name="robots"
+            content={robots ? 'index, follow' : 'noindex, nofollow'}
+          />
           <meta name="language" content="EN" />
           <meta name="distribution" content="global" />
           <meta
diff --git a/src/registry/views/preview.ts b/src/registry/views/preview.ts
@@ -7,6 +7,7 @@ export default function preview(vm: {
   qs: string;
   liveReload: string;
   templates: TemplateInfo[];
+  robots: boolean;
   importmap?: {
     imports?: Record<string, string>;
   };
@@ -167,7 +168,7 @@ export default function preview(vm: {
           color: #cfe3ff;
         }
       </style>
-      <meta name="robots" content="index, follow" />
+      <meta name="robots" content="${vm.robots ? 'index, follow' : 'noindex, nofollow'}" />
       <meta charset="utf-8" />
       <meta name="viewport" content="width=device-width, initial-scale=1" />
       ${
diff --git a/src/types.ts b/src/types.ts
@@ -129,6 +129,7 @@ export interface VM {
   title: string;
   theme: 'light' | 'dark';
   type: 'oc-registry' | 'oc-registry-local';
+  robots: boolean;
 }
 
 export type Authentication<T = any> = {
@@ -206,6 +207,12 @@ export interface Config<T = any> {
    * Configuration object to enable/disable the HTML discovery page and the API
    */
   discovery: {
+    /**
+     * Appends a <meta name="robots" content="index, follow" /> to the HTML head
+     * False to append a <meta name="robots" content="noindex, nofollow" />
+     * @default true
+     */
+    robots: boolean;
     /**
      * Enables API discovery endpoints
      * @default true
