feat: constant modifier in summary

jy95 · Jan 8, 2024 · 47e0ad9 · 47e0ad9
1 parent 3d21631
commit 47e0ad9
Show file tree

Hide file tree

Showing 8 changed files with 58 additions and 0 deletions.
diff --git a/__tests__/JSONSchemaViewer/__snapshots__/constructor.test.tsx.snap b/__tests__/JSONSchemaViewer/__snapshots__/constructor.test.tsx.snap
@@ -435,6 +435,10 @@ exports[`JSONSchemaViewer - constructor Overwrite default ValueComponent value 1
               >
                 object
               </span>
+               
+              <strong>
+                constant
+              </strong>
             </summary>
             <div>
               <div>

diff --git a/__tests__/JSONSchemaViewer/__snapshots__/generateFriendlyName.test.tsx.snap b/__tests__/JSONSchemaViewer/__snapshots__/generateFriendlyName.test.tsx.snap
@@ -2229,6 +2229,10 @@ exports[`JSONSchemaViewer - generateFriendlyName cases test Prefer title 1`] = `
                         >
                           string
                         </span>
+                         
+                        <strong>
+                          constant
+                        </strong>
                       </summary>
                       <div>
                         <div>

diff --git a/__tests__/JSONSchemaViewer/__snapshots__/generic_keywords.test.tsx.snap b/__tests__/JSONSchemaViewer/__snapshots__/generic_keywords.test.tsx.snap
@@ -174,6 +174,10 @@ exports[`JSONSchemaViewer - Generic keywords test const 1`] = `
               >
                 string
               </span>
+               
+              <strong>
+                constant
+              </strong>
             </summary>
             <div>
               <div>

diff --git a/__tests__/JSONSchemaViewer/__snapshots__/schema_conditionally.test.tsx.snap b/__tests__/JSONSchemaViewer/__snapshots__/schema_conditionally.test.tsx.snap
@@ -339,6 +339,10 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else (multiple) 1`
                                       >
                                         string
                                       </span>
+                                       
+                                      <strong>
+                                        constant
+                                      </strong>
                                     </summary>
                                     <div>
                                       <div>
@@ -602,6 +606,10 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else (multiple) 1`
                                       <strong>
                                         required
                                       </strong>
+                                       
+                                      <strong>
+                                        constant
+                                      </strong>
                                     </summary>
                                     <div>
                                       <div>
@@ -865,6 +873,10 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else (multiple) 1`
                                       <strong>
                                         required
                                       </strong>
+                                       
+                                      <strong>
+                                        constant
+                                      </strong>
                                     </summary>
                                     <div>
                                       <div>
@@ -1262,6 +1274,10 @@ exports[`JSONSchemaViewer - schema conditionally test If Then Else 1`] = `
                             >
                               string
                             </span>
+                             
+                            <strong>
+                              constant
+                            </strong>
                           </summary>
                           <div>
                             <div>

diff --git a/src/theme/JSONSchemaViewer/components/SchemaItem/SchemaItem.tsx b/src/theme/JSONSchemaViewer/components/SchemaItem/SchemaItem.tsx
@@ -8,6 +8,7 @@ import {
   DeprecatedLabel,
   WriteOnlyLabel,
   ReadOnlyLabel,
+  ConstantLabel
 } from "@theme/JSONSchemaViewer/labels"
 
 import { GenerateFriendlyName } from "@theme/JSONSchemaViewer/utils"
@@ -43,6 +44,10 @@ export default function SchemaItem({
     typeof typedSchema !== "boolean" && typedSchema.readOnly === true
   let isWriteOnly =
     typeof typedSchema !== "boolean" && typedSchema.writeOnly === true
+  let isConstant =
+    typeof typedSchema !== "boolean" &&
+    (typedSchema.const !== undefined ||
+      (Array.isArray(typedSchema.enum) && typedSchema.enum.length === 1))
   let isRequired = !isDeprecated && required
 
   // Header
@@ -58,6 +63,8 @@ export default function SchemaItem({
       {isReadOnly && <ReadOnlyLabel />}
       {isWriteOnly && <>&nbsp;</>}
       {isWriteOnly && <WriteOnlyLabel />}
+      {isConstant && <>&nbsp;</>}
+      {isConstant && <ConstantLabel />}
     </>
   )
 

diff --git a/src/theme/JSONSchemaViewer/labels/Constant/Constant.tsx b/src/theme/JSONSchemaViewer/labels/Constant/Constant.tsx
@@ -0,0 +1,18 @@
+import React from "react"
+import Translate from "@docusaurus/Translate"
+
+import styles from "./styles.module.css"
+
+export default function ConstantLabel(): JSX.Element {
+    return (
+      <strong className={styles.constant}>
+        <Translate
+          values={{
+            id: "json-schema.keywords.const",
+          }}
+        >
+          {"constant"}
+        </Translate>
+      </strong>
+    )
+  }
diff --git a/src/theme/JSONSchemaViewer/labels/Constant/styles.module.css b/src/theme/JSONSchemaViewer/labels/Constant/styles.module.css
@@ -0,0 +1,4 @@
+.constant {
+    font-size: var(--ifm-code-font-size);
+    color: var(--ifm-color-secondary-darkest);
+}
diff --git a/src/theme/JSONSchemaViewer/labels/index.ts b/src/theme/JSONSchemaViewer/labels/index.ts
@@ -22,3 +22,4 @@ export { default as AndLabel } from "@theme/JSONSchemaViewer/labels/And"
 export { default as OrLabel } from "@theme/JSONSchemaViewer/labels/Or"
 export { default as NotLabel } from "@theme/JSONSchemaViewer/labels/Not"
 export { default as XorLabel } from "@theme/JSONSchemaViewer/labels/Xor"
+export { default as ConstantLabel } from "@theme/JSONSchemaViewer/labels/Constant/Constant"