refactor(CircleBadge): move files into folder, add e2e tests. (#3118)

* Reorganize CircleBadge, add e2e tests.

* Update generated/components.json

* test(vrt): update snapshots

* Update docs reference.

---------

Co-authored-by: radglob <radglob@users.noreply.github.com>

docs/content/CircleBadge.mdx

@@ -5,7 +5,7 @@ status: Alpha
 source: https://github.com/primer/react/blob/main/src/CircleBadge.tsx
 ---
 
-import data from '../../src/CircleBadge.docs.json'
+import data from '../../src/CircleBadge/CircleBadge.docs.json'
 
 ```js
 import {CircleBadge} from '@primer/react'

e2e/components/CircleBadge.test.ts

@@ -0,0 +1,61 @@
+import {test, expect} from '@playwright/test'
+import {visit} from '../test-helpers/storybook'
+import {themes} from '../test-helpers/themes'
+
+test.describe('CircleBadge', () => {
+  test.describe('Default', () => {
+    for (const theme of themes) {
+      test.describe(theme, () => {
+        test('default @vrt', async ({page}) => {
+          await visit(page, {
+            id: 'components-circlebadge--default',
+            globals: {
+              colorScheme: theme,
+            },
+          })
+
+          // Default state
+          expect(await page.screenshot()).toMatchSnapshot(`CircleBadge.Default.${theme}.png`)
+        })
+
+        test('axe @aat', async ({page}) => {
+          await visit(page, {
+            id: 'components-circlebadge--default',
+            globals: {
+              colorScheme: theme,
+            },
+          })
+          await expect(page).toHaveNoViolations()
+        })
+      })
+    }
+  })
+
+  test.describe('Playground', () => {
+    for (const theme of themes) {
+      test.describe(theme, () => {
+        test('default @vrt', async ({page}) => {
+          await visit(page, {
+            id: 'components-circlebadge--playground',
+            globals: {
+              colorScheme: theme,
+            },
+          })
+
+          // Default state
+          expect(await page.screenshot()).toMatchSnapshot(`CircleBadge.Playground.${theme}.png`)
+        })
+
+        test('axe @aat', async ({page}) => {
+          await visit(page, {
+            id: 'components-circlebadge--playground',
+            globals: {
+              colorScheme: theme,
+            },
+          })
+          await expect(page).toHaveNoViolations()
+        })
+      })
+    }
+  })
+})

generated/components.json

@@ -19,62 +19,6 @@
       ],
       "subcomponents": []
     },
-    "circle_badge": {
-      "id": "circle_badge",
-      "name": "CircleBadge",
-      "status": "alpha",
-      "a11yReviewed": false,
-      "stories": [],
-      "props": [
-        {
-          "name": "variant",
-          "type": "'small' | 'medium' | 'large'",
-          "defaultValue": "'medium'",
-          "description": "Creates a smaller or larger badge. Has no effect if the `size` prop is set"
-        },
-        {
-          "name": "size",
-          "type": "number",
-          "defaultValue": "",
-          "description": "Sets the size of the badge in pixels. Overrides the `variant` prop when set"
-        },
-        {
-          "name": "inline",
-          "type": "boolean",
-          "defaultValue": "false",
-          "description": "Styles the badge to `display: inline`"
-        },
-        {
-          "name": "ref",
-          "type": "React.RefObject<HTMLDivElement>"
-        },
-        {
-          "name": "as",
-          "type": "React.ElementType",
-          "defaultValue": "\"div\""
-        },
-        {
-          "name": "sx",
-          "type": "SystemStyleObject"
-        }
-      ],
-      "subcomponents": [
-        {
-          "name": "CircleBadge.Icon",
-          "props": [
-            {
-              "name": "as",
-              "type": "React.ElementType",
-              "defaultValue": "StyledOcticon"
-            }
-          ],
-          "passthrough": {
-            "element": "StyledOcticon",
-            "url": "/StyledOcticon"
-          }
-        }
-      ]
-    },
     "circle_octicon": {
       "id": "circle_octicon",
       "name": "CircleOcticon",
@@ -1741,6 +1685,67 @@
         }
       ]
     },
+    "circle_badge": {
+      "id": "circle_badge",
+      "name": "CircleBadge",
+      "status": "alpha",
+      "a11yReviewed": false,
+      "stories": [
+        {
+          "id": "components-circlebadge--default",
+          "code": "() => (\n  <CircleBadge>\n    <CircleBadge.Icon icon={ZapIcon} />\n  </CircleBadge>\n)"
+        }
+      ],
+      "props": [
+        {
+          "name": "variant",
+          "type": "'small' | 'medium' | 'large'",
+          "defaultValue": "'medium'",
+          "description": "Creates a smaller or larger badge. Has no effect if the `size` prop is set"
+        },
+        {
+          "name": "size",
+          "type": "number",
+          "defaultValue": "",
+          "description": "Sets the size of the badge in pixels. Overrides the `variant` prop when set"
+        },
+        {
+          "name": "inline",
+          "type": "boolean",
+          "defaultValue": "false",
+          "description": "Styles the badge to `display: inline`"
+        },
+        {
+          "name": "ref",
+          "type": "React.RefObject<HTMLDivElement>"
+        },
+        {
+          "name": "as",
+          "type": "React.ElementType",
+          "defaultValue": "\"div\""
+        },
+        {
+          "name": "sx",
+          "type": "SystemStyleObject"
+        }
+      ],
+      "subcomponents": [
+        {
+          "name": "CircleBadge.Icon",
+          "props": [
+            {
+              "name": "as",
+              "type": "React.ElementType",
+              "defaultValue": "StyledOcticon"
+            }
+          ],
+          "passthrough": {
+            "element": "StyledOcticon",
+            "url": "/StyledOcticon"
+          }
+        }
+      ]
+    },
     "counter_label": {
       "id": "counter_label",
       "name": "CounterLabel",

script/generate-e2e-tests.js

@@ -310,6 +310,21 @@ const components = new Map([
       ],
     },
   ],
+  [
+    'CircleBadge',
+    {
+      stories: [
+        {
+          id: 'components-circlebadge--default',
+          name: 'Default',
+        },
+        {
+          id: 'components-circlebadge--playground',
+          name: 'Playground',
+        },
+      ],
+    },
+  ],
   [
     'CounterLabel',
     {

src/CircleBadge/CircleBadge.stories.tsx

@@ -0,0 +1,47 @@
+import React from 'react'
+import {Meta, ComponentStory} from '@storybook/react'
+import CircleBadge from './CircleBadge'
+import {ZapIcon} from '@primer/octicons-react'
+
+export default {
+  title: 'Components/CircleBadge',
+  component: CircleBadge,
+} as Meta<typeof CircleBadge>
+
+export const Default = () => (
+  <CircleBadge>
+    <CircleBadge.Icon icon={ZapIcon} />
+  </CircleBadge>
+)
+
+export const Playground: ComponentStory<typeof CircleBadge> = args => (
+  <CircleBadge {...args}>
+    <CircleBadge.Icon icon={ZapIcon} />
+  </CircleBadge>
+)
+
+Playground.args = {
+  variant: 'medium',
+  size: null,
+  inline: false,
+  as: 'div',
+}
+
+Playground.argTypes = {
+  variant: {
+    control: {
+      type: 'radio',
+    },
+    options: ['small', 'medium', 'large'],
+  },
+  size: {
+    control: {
+      type: 'number',
+    },
+  },
+  inline: {
+    control: {
+      type: 'boolean',
+    },
+  },
+}

src/CircleBadge.tsx → src/CircleBadge/CircleBadge.tsx

@@ -1,9 +1,9 @@
 import styled from 'styled-components'
-import {get} from './constants'
-import StyledOcticon from './StyledOcticon'
-import sx, {SxProp} from './sx'
-import isNumeric from './utils/isNumeric'
-import {ComponentProps} from './utils/types'
+import {get} from '../constants'
+import StyledOcticon from '../StyledOcticon'
+import sx, {SxProp} from '../sx'
+import isNumeric from '../utils/isNumeric'
+import {ComponentProps} from '../utils/types'
 
 const variantSizes = {
   small: 56,

src/CircleBadge/index.ts

@@ -0,0 +1 @@
+export {default, CircleBadgeProps, CircleBadgeIconProps} from './CircleBadge'