test: add check for story ids in generated docs (#5441)

* test: add check for story ids in generated docs

* merge with main

* fix: script path

* fix: script path

* fix: IconButton story id

* fix: IconButton story id

* fix: Hidden story id

* Create hungry-mugs-stare.md

* fix: InlineMessage story id

* update Portal story docs

* update TooltipV2 story docs

* Revert "merge with main"

This reverts commit 577bc64.

* deps: package-lock fix

---------

Co-authored-by: Marie Lucca <francinelucca@github.com>
Co-authored-by: Marie Lucca <40550942+francinelucca@users.noreply.github.com>

Author: joshblack

.changeset/hungry-mugs-stare.md

@@ -0,0 +1,5 @@
+---
+"@primer/react": patch
+---
+
+test: add check for story ids in generated docs

.github/workflows/ci.yml

@@ -408,8 +408,12 @@ jobs:
           cache: 'npm'
       - name: Install dependencies
         run: npm ci
+      - name: Build storybook to generate story IDs
+        run: npm run build:storybook
+        working-directory: packages/react
       - name: Build components.json
-        run: npm run build:components.json
+        run: npx tsx script/components-json/build.ts --storybook-data 'storybook-static/index.json'
+        working-directory: packages/react
 
   sizes:
     runs-on: ubuntu-latest

package-lock.json

@@ -39,7 +39,7 @@
     "clean": "rimraf dist lib lib-esm css",
     "start": "concurrently npm:start:*",
     "start:storybook": "STORYBOOK=true storybook dev -p 6006",
-    "build:storybook": "script/build-storybook",
+    "build:storybook": "storybook build",
     "build:docs": "NODE_OPTIONS=--openssl-legacy-provider script/build-docs",
     "build:docs:preview": "NODE_OPTIONS=--openssl-legacy-provider script/build-docs preview",
     "build:components.json": "tsx script/components-json/build.ts",

packages/react/package.json

@@ -2,6 +2,8 @@ import generate from '@babel/generator'
 import {parse} from '@babel/parser'
 import traverse from '@babel/traverse'
 import type {ArrowFunctionExpression, Identifier, FunctionDeclaration} from '@babel/types'
+import path from 'node:path'
+import {parseArgs} from 'node:util'
 import Ajv from 'ajv'
 import {pascalCase, kebabCase} from 'change-case'
 import glob from 'fast-glob'
@@ -11,6 +13,14 @@ import prettier from '@prettier/sync'
 import componentSchema from './component.schema.json'
 import outputSchema from './output.schema.json'
 
+const args = parseArgs({
+  options: {
+    'storybook-data': {
+      type: 'string',
+    },
+  },
+})
+
 // Only includes fields we use in this script
 type Component = {
   name: string
@@ -40,6 +50,23 @@ const storyPrefix = {
   stable: '',
 }
 
+let _storybookData: StorybookData | null = null
+
+function getStorybookData(): StorybookData {
+  const input = args.values['storybook-data']
+  if (!input) {
+    throw new Error('Unable to get value for --storybook-data')
+  }
+
+  if (_storybookData === null) {
+    const filepath = path.resolve(process.cwd(), args.values['storybook-data']!)
+    const contents = fs.readFileSync(filepath, 'utf-8')
+    _storybookData = JSON.parse(contents)
+  }
+
+  return _storybookData as StorybookData
+}
+
 const components = docsFiles.map(docsFilepath => {
   const docs = JSON.parse(fs.readFileSync(docsFilepath, 'utf-8'))
 
@@ -114,6 +141,18 @@ const components = docsFiles.map(docsFilepath => {
     }
   }
 
+  if (args.values['storybook-data']) {
+    const storybookData = getStorybookData()
+    for (const story of docs.stories) {
+      const match = Object.values(storybookData.entries).find(entry => {
+        return entry.id === story.id
+      })
+      if (!match) {
+        throw new Error(`Story "${story.id}" not found in storybook-data`)
+      }
+    }
+  }
+
   // TODO: Provide default type and description for sx and ref props
   return {
     source: `https://github.com/primer/react/tree/main/packages/react/${docsFilepath.substring(0, docsFilepath.lastIndexOf('/'))}`,
@@ -236,3 +275,12 @@ function getStoryIds(docs: Component, storyNames: string[]) {
 
   return ids.map(id => ({id}))
 }
+
+interface StorybookData {
+  v: number
+  entries: {
+    [key: string]: {
+      id: string
+    }
+  }
+}

packages/react/script/components-json/build.ts

@@ -35,7 +35,7 @@
       "id": "components-iconbutton-features--external-tooltip"
     },
     {
-      "id": "components-iconbutton-features--external-tooltip-version1"
+      "id": "components-iconbutton-features--external-tooltip-version-1"
     },
     {
       "id": "components-iconbutton-features--as-a-menu-anchor"

packages/react/src/Button/IconButton.docs.json

@@ -34,7 +34,8 @@ export const ExternalTooltip = () => (
   </Tooltip>
 )
 
-export const ExternalTooltipVersion1 = () => (
+/* eslint-disable-next-line camelcase */
+export const ExternalTooltipVersion_1 = () => (
   <TooltipV1 text="this is a supportive description for icon button" direction="se">
     <IconButton icon={HeartIcon} aria-label="HeartIcon" />
   </TooltipV1>

packages/react/src/Button/IconButton.features.stories.tsx

@@ -5,13 +5,13 @@
   "a11yReviewed": false,
   "stories": [
     {
-      "id": "drafts-components-hidden--default"
+      "id": "experimental-components-hidden--default"
     },
     {
-      "id": "drafts-components-hidden-features--hide-content"
+      "id": "experimental-components-hidden-features--hide-content"
     },
     {
-      "id": "drafts-components-hidden-features--render-content-responsively"
+      "id": "experimental-components-hidden-features--render-content-responsively"
     }
   ],
   "importPath": "@primer/react/experimental",

packages/react/src/Hidden/Hidden.docs.json

@@ -6,22 +6,22 @@
   "importPath": "@primer/react/experimental",
   "stories": [
     {
-      "id": "components-inlinemessage--default"
+      "id": "experimental-components-inlinemessage--default"
     },
     {
-      "id": "components-inlinemessage-features--critical"
+      "id": "experimental-components-inlinemessage-features--critical"
     },
     {
-      "id": "components-inlinemessage-features--success"
+      "id": "experimental-components-inlinemessage-features--success"
     },
     {
-      "id": "components-inlinemessage-features--unavailable"
+      "id": "experimental-components-inlinemessage-features--unavailable"
     },
     {
-      "id": "components-inlinemessage-features--warning"
+      "id": "experimental-components-inlinemessage-features--warning"
     },
     {
-      "id": "components-inlinemessage-features--multiline"
+      "id": "experimental-components-inlinemessage-features--multiline"
     }
   ],
   "props": [

packages/react/src/InlineMessage/InlineMessage.docs.json

@@ -5,16 +5,16 @@
   "a11yReviewed": false,
   "stories": [
     {
-      "id": "components-portal--default"
+      "id": "behaviors-portal--default"
     },
     {
-      "id": "components-portal-features--custom-portal-root-by-id"
+      "id": "behaviors-portal-features--custom-portal-root-by-id"
     },
     {
-      "id": "components-portal-features--custom-portal-root-by-registration"
+      "id": "behaviors-portal-features--custom-portal-root-by-registration"
     },
     {
-      "id": "components-portal-features--multiple-portal-roots"
+      "id": "behaviors-portal-features--multiple-portal-roots"
     }
   ],
   "importPath": "@primer/react",

packages/react/src/Portal/Portal.docs.json

@@ -7,31 +7,31 @@
   "importPath": "@primer/react/next",
   "stories": [
     {
-      "id": "components-tooltip--default"
+      "id": "components-tooltipv2--default"
     },
     {
-      "id": "components-tooltip-features--anchor-has-margin"
+      "id": "components-tooltipv2-features--anchor-has-margin"
     },
     {
-      "id": "components-tooltip-features--label-type"
+      "id": "components-tooltipv2-features--label-type"
     },
     {
-      "id": "components-tooltip-features--description-type"
+      "id": "components-tooltipv2-features--description-type"
     },
     {
-      "id": "components-tooltip-features--icon-button-with-description"
+      "id": "components-tooltipv2-features--icon-button-with-description"
     },
     {
-      "id": "components-tooltip-features--all-directions"
+      "id": "components-tooltipv2-features--all-directions"
     },
     {
-      "id": "components-tooltip-features--multiline-text"
+      "id": "components-tooltipv2-features--multiline-text"
     },
     {
-      "id": "components-tooltip-features--calculated-direction"
+      "id": "components-tooltipv2-features--calculated-direction"
     },
     {
-      "id": "components-tooltip-features--on-action-menu-anchor"
+      "id": "components-tooltipv2-features--on-action-menu-anchor"
     }
   ],
   "props": [