Make StateLabel's 'status' prop required (#2993)

* makes 'status' prop required * adds changeset * Update generated/components.json * rm shouldAcceptCallWithNoProps test --------- Co-authored-by: mperrotti <mperrotti@users.noreply.github.com>
primer · Mar 15, 2023 · 6aa9205 · 6aa9205
1 parent baa6395
commit 6aa9205
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 7 deletions.
diff --git a/.changeset/serious-balloons-teach.md b/.changeset/serious-balloons-teach.md
@@ -0,0 +1,5 @@
+---
+'@primer/react': patch
+---
+
+Makes StateLabel's 'status' prop required
diff --git a/generated/components.json b/generated/components.json
@@ -3914,7 +3914,8 @@
         },
         {
           "name": "status",
-          "type": "'issueOpened' | 'issueClosed' | 'issueClosedNotPlanned' | 'pullOpened' | 'pullClosed' | 'pullMerged' | 'draft' | 'issueDraft'"
+          "type": "'issueOpened' | 'issueClosed' | 'issueClosedNotPlanned' | 'pullOpened' | 'pullClosed' | 'pullMerged' | 'draft' | 'issueDraft'",
+          "required": true
         },
         {
           "name": "sx",

diff --git a/src/StateLabel/StateLabel.docs.json b/src/StateLabel/StateLabel.docs.json
@@ -12,7 +12,8 @@
     },
     {
       "name": "status",
-      "type": "'issueOpened' | 'issueClosed' | 'issueClosedNotPlanned' | 'pullOpened' | 'pullClosed' | 'pullMerged' | 'draft' | 'issueDraft'"
+      "type": "'issueOpened' | 'issueClosed' | 'issueClosedNotPlanned' | 'pullOpened' | 'pullClosed' | 'pullMerged' | 'draft' | 'issueDraft'",
+      "required": true
     },
     {
       "name": "sx",

diff --git a/src/StateLabel/StateLabel.tsx b/src/StateLabel/StateLabel.tsx
@@ -82,7 +82,7 @@ const sizeVariants = variant({
 
 type StyledStateLabelBaseProps = {
   variant?: 'small' | 'normal'
-  status?: keyof typeof octiconMap
+  status: keyof typeof octiconMap
 } & SxProp
 
 const StateLabelBase = styled.span<StyledStateLabelBaseProps>`

diff --git a/src/StateLabel/__tests__/StateLabel.types.test.tsx b/src/StateLabel/__tests__/StateLabel.types.test.tsx
@@ -1,10 +1,6 @@
 import React from 'react'
 import StateLabel from '../StateLabel'
 
-export function shouldAcceptCallWithNoProps() {
-  return <StateLabel />
-}
-
 export function shouldNotAcceptSystemProps() {
   // @ts-expect-error system props should not be accepted
   return <StateLabel backgroundColor="bisque" />