Fix some inline issue in doc (#25)

dej611 · Mar 31, 2021 · b249f4b · b249f4b
1 parent 5314873
commit b249f4b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ The SPIDButtonProps object contains the following properties:
 
 #### configuration
 
-**Possible values**: `{            method : "GET"        } | {            extraFields ?: Record<string | string>fieldName : stringmethod : "POST"        }`  
+**Possible values**: `{            method : "GET"        } | {            extraFields ?: Record<string | string>, fieldName : string, method : "POST"        }`  
 
 **Type**: `ConfigurationGET | ConfigurationPOST`  
 

diff --git a/scripts/doc.js b/scripts/doc.js
@@ -52,7 +52,7 @@ function getChildren({ kindString, children, type }) {
   throw Error('No children found');
 }
 
-function typeDescription({ type, ...props }) {
+function typeDescription({ type, ...props }, inline = false) {
   if (type === 'literal') {
     return '"' + props.value + '"';
   }
@@ -87,7 +87,9 @@ function typeDescription({ type, ...props }) {
     if (props.declaration.children) {
       // object shaped
       return `{
-            ${props.declaration.children.map(typeDescription).join('\n')}
+            ${props.declaration.children
+              .map(typeDescription)
+              .join(inline ? ', ' : '\n')}
         }`;
     }
     if (props.declaration.signatures) {
@@ -109,7 +111,8 @@ function unrollType(record, array) {
     const referenced = array.find(({ name }) => name === record.name);
     if (referenced) {
       const value = typeDescription(
-        referenced.type ? referenced.type : referenced
+        referenced.type ? referenced.type : referenced,
+        true
       );
       return value && value.replace(/\n/g, '');
     }