feat: improve CustomizeType to render basic constant values

jy95 · Jan 8, 2024 · 3a40253 · 3a40253
1 parent 27ebcc9
commit 3a40253
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 54 deletions.
diff --git a/__tests__/JSONSchemaViewer/__snapshots__/generateFriendlyName.test.tsx.snap b/__tests__/JSONSchemaViewer/__snapshots__/generateFriendlyName.test.tsx.snap
@@ -2220,15 +2220,9 @@ exports[`JSONSchemaViewer - generateFriendlyName cases test Prefer title 1`] = `
                           text
                         </strong>
                          
-                        <span
-                          style={
-                            {
-                              "opacity": "0.6",
-                            }
-                          }
-                        >
-                          string
-                        </span>
+                        <code>
+                          Hello World
+                        </code>
                          
                         <strong>
                           constant

diff --git a/__tests__/JSONSchemaViewer/__snapshots__/generic_keywords.test.tsx.snap b/__tests__/JSONSchemaViewer/__snapshots__/generic_keywords.test.tsx.snap
@@ -165,15 +165,9 @@ exports[`JSONSchemaViewer - Generic keywords test const 1`] = `
                 country
               </strong>
                
-              <span
-                style={
-                  {
-                    "opacity": "0.6",
-                  }
-                }
-              >
-                string
-              </span>
+              <code>
+                United States of America
+              </code>
                
               <strong>
                 constant

diff --git a/__tests__/JSONSchemaViewer/__snapshots__/schema_conditionally.test.tsx.snap b/__tests__/JSONSchemaViewer/__snapshots__/schema_conditionally.test.tsx.snap
@@ -330,15 +330,9 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else (multiple) 1`
                                         country
                                       </strong>
                                        
-                                      <span
-                                        style={
-                                          {
-                                            "opacity": "0.6",
-                                          }
-                                        }
-                                      >
-                                        string
-                                      </span>
+                                      <code>
+                                        United States of America
+                                      </code>
                                        
                                       <strong>
                                         constant
@@ -593,15 +587,9 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else (multiple) 1`
                                         country
                                       </strong>
                                        
-                                      <span
-                                        style={
-                                          {
-                                            "opacity": "0.6",
-                                          }
-                                        }
-                                      >
-                                        string
-                                      </span>
+                                      <code>
+                                        Canada
+                                      </code>
                                        
                                       <strong>
                                         required
@@ -860,15 +848,9 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else (multiple) 1`
                                         country
                                       </strong>
                                        
-                                      <span
-                                        style={
-                                          {
-                                            "opacity": "0.6",
-                                          }
-                                        }
-                                      >
-                                        string
-                                      </span>
+                                      <code>
+                                        Netherlands
+                                      </code>
                                        
                                       <strong>
                                         required
@@ -1265,15 +1247,9 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else 1`] = `
                               country
                             </strong>
                              
-                            <span
-                              style={
-                                {
-                                  "opacity": "0.6",
-                                }
-                              }
-                            >
-                              string
-                            </span>
+                            <code>
+                              United States of America
+                            </code>
                              
                             <strong>
                               constant

diff --git a/src/theme/JSONSchemaViewer/utils/generateFriendlyName.tsx b/src/theme/JSONSchemaViewer/utils/generateFriendlyName.tsx
@@ -17,6 +17,7 @@ import type {
   JSONSchemaNS,
   TypeValues,
 } from "@theme/JSONSchemaViewer/types"
+import { printSchemaType } from "@theme/JSONSchemaViewer/utils/QualifierMessages"
 
 // common function I need below
 function shouldAddSeparator(idx: number, length: number): boolean {
@@ -137,6 +138,16 @@ function CustomizeType({ schema, type }: CustomizeProps): JSX.Element {
     return <CustomizeArray schema={schema as JSONSchemaNS.Array} />
   }
 
+  // For constant values
+  if (!["array", "object"].includes(type)) {
+    if (schema.const !== undefined) {
+      return printSchemaType(schema.const)
+    }
+    if (schema.enum !== undefined && schema.enum.length === 1) {
+      return printSchemaType(schema.enum[0])
+    }
+  }
+
   // By default, render the type as it
   return <TypeLabelSwitch type={type} />
 }