Merge documentation and current value rendering into one componenet (#…

…722) * Condense config documentation and status to show in one block. * Swap things around to make the current value prominent. Before: ![image](https://github.com/user-attachments/assets/e554b0f7-408a-4ea6-9ffa-8df53119feac) After: ![image](https://github.com/user-attachments/assets/26bcc16b-f85b-4639-9b8f-43f820158c7e)
the-draupnir-project · Feb 3, 2025 · 2482402 · 2482402
1 parent 69cf36b
commit 2482402
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 11 deletions.
diff --git a/src/commands/ProtectionsShowCommand.tsx b/src/commands/ProtectionsShowCommand.tsx
@@ -96,9 +96,6 @@ DraupnirInterfaceAdaptor.describeRenderer(DraupnirProtectionsShowCommand, {
         </span>
         <p>{protectionInfo.description.description}</p>
         <h3>Protection settings</h3>
-        {StandardPersistentConfigRenderer.renderConfigDocumentation(
-          protectionInfo.description.protectionSettings
-        )}
         {StandardPersistentConfigRenderer.renderConfigStatus({
           description: protectionInfo.description.protectionSettings,
           error: undefined,

diff --git a/src/safemode/PersistentConfigRenderer.tsx b/src/safemode/PersistentConfigRenderer.tsx
@@ -14,6 +14,7 @@ import {
 import {
   ConfigDescription,
   ConfigParseError,
+  ConfigPropertyDescription,
   ConfigPropertyError,
   ConfigPropertyUseError,
 } from "matrix-protection-suite";
@@ -126,22 +127,30 @@ function renderConfigPropertyError(
 }
 
 function renderConfigProperty(
-  propertyKey: string,
+  configProperty: ConfigPropertyDescription,
   data: Record<string, unknown>,
   errors: ConfigPropertyError[]
 ): DocumentNode {
-  const propertyValue = data[propertyKey];
-  const error = findError(propertyKey, errors);
+  const propertyValue = data[configProperty.name];
+  const error = findError(configProperty.name, errors);
   if (Array.isArray(propertyValue)) {
     return (
       <li>
         <details>
           <summary>
-            {renderConfigPropertyError(error)} <code>{propertyKey}</code>:
+            {renderConfigPropertyError(error)}{" "}
+            <code>{configProperty.name}</code>:
           </summary>
+          {configProperty.description ?? "No description provided."} default
+          value: {renderConfigPropertyValue(configProperty.default)}.
           <ul>
             {propertyValue.map((value, index) =>
-              renderConfigPropertyItem(propertyKey, index, value, errors)
+              renderConfigPropertyItem(
+                configProperty.name,
+                index,
+                value,
+                errors
+              )
             )}
           </ul>
         </details>
@@ -150,8 +159,10 @@ function renderConfigProperty(
   }
   return (
     <li>
-      {renderConfigPropertyError(error)}
-      <code>{propertyKey}</code>: {renderConfigPropertyValue(propertyValue)}
+      {renderConfigPropertyError(error)} <code>{configProperty.name}</code>:{" "}
+      {configProperty.description ?? "No description provided."} default value:{" "}
+      {renderConfigPropertyValue(configProperty.default)}.
+      <p>{renderConfigPropertyValue(propertyValue)}</p>
     </li>
   );
 }
@@ -219,7 +230,7 @@ export const StandardPersistentConfigRenderer = Object.freeze({
           .properties()
           .map((property) =>
             renderConfigProperty(
-              property.name,
+              property,
               config.data as Record<string, unknown>,
               config.error?.errors ?? []
             )