generated/components.json - includes link to component code on GitHub (…

…#5344)
primer · Dec 3, 2024 · 00da88a · 00da88a
1 parent e231b5f
commit 00da88a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/packages/react/script/components-json/build.ts b/packages/react/script/components-json/build.ts
@@ -22,6 +22,7 @@ type Component = {
     | '@primer/react/experimental'
     | '@primer/react/drafts'
   stories: Array<{id: string; code?: string}>
+  source?: string
 }
 
 const ajv = new Ajv()
@@ -114,7 +115,10 @@ const components = docsFiles.map(docsFilepath => {
   }
 
   // TODO: Provide default type and description for sx and ref props
-  return docs
+  return {
+    source: `https://github.com/primer/react/tree/main/packages/react/${docsFilepath.substring(0, docsFilepath.lastIndexOf('/'))}`,
+    ...docs,
+  }
 })
 
 const data = {schemaVersion: 2, components: keyBy(components, 'id')}

diff --git a/packages/react/script/components-json/component.schema.json b/packages/react/script/components-json/component.schema.json
@@ -77,6 +77,10 @@
       "type": "string",
       "description": "The path to import the component from. i.e. '@primer/react/experimental'"
     },
+    "source": {
+      "type": "string",
+      "description": "Link to the component source on GitHub"
+    },
 
     "stories": {
       "type": "array",