add option to generate summary only

CesiumGS · Mar 25, 2022 · 80bc43b · 80bc43b
1 parent 798352d
commit 80bc43b
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 12 deletions.
diff --git a/bin/wetzel.js b/bin/wetzel.js
@@ -27,7 +27,8 @@ if (!defined(argv._[0]) || defined(argv.h) || defined(argv.help)) {
         '                                artifacts useful in debugging wetzel.\n' +
         '  -w,  --suppressWarnings   Will not print out WETZEL_WARNING strings indicating identified\n' +
         '                                conversion problems. Default: false\n' +
-        '  -z,  --detailedSummary    Adds more details in the summary table. Default: false\n'
+        '  --detailedSummary         Adds more details in the summary table. Default: false\n' +
+        '  --summary                 Only write the summary and skip the detailed section, useful for a more concise documentation. Default: false\n'
     process.stdout.write(help);
     return;
 }
@@ -82,7 +83,8 @@ var options = {
     suppressWarnings: defaultValue(defaultValue(argv.w, argv.suppressWarnings), false),
     autoLink: autoLink,
     ignorableTypes: ignorableTypes,
-    detailedSummary: defaultValue(defaultValue(argv.z, argv.detailedSummary), false),
+    detailedSummary: defaultValue(argv.detailedSummary, false),
+    summaryOnly: defaultValue(argv.summary, false)
 };
 
 if (defined(embedOutput)) {

diff --git a/lib/generateMarkdown.js b/lib/generateMarkdown.js
@@ -76,6 +76,7 @@ function generateMarkdown(options) {
             orderedTypesDescending,
             options.autoLink,
             options.embedMode,
+            options.summaryOnly,
             options.detailedSummary);
     }
 
@@ -155,7 +156,7 @@ function getRecursiveTOC(orderedTypes, parentTitle, depth) {
 * @param  {string} embedMode              Emum value indicating if we are embedding JSON schema include directives.
 * @return {string}                        The markdown for the schema.
 */
-function getSchemaMarkdown(schema, fileName, headerLevel, suppressWarnings, schemaRelativeBasePath, knownTypes, autoLink, embedMode, detailedSummary) {
+function getSchemaMarkdown(schema, fileName, headerLevel, suppressWarnings, schemaRelativeBasePath, knownTypes, autoLink, embedMode, summaryOnly, detailedSummary) {
     var md = '';
 
     if (schema === undefined) {
@@ -200,12 +201,15 @@ function getSchemaMarkdown(schema, fileName, headerLevel, suppressWarnings, sche
         // Render table with summary of each property
         md += createPropertiesSummary(schema, knownTypes, autoLink, detailedSummary);
 
-        value = schema.additionalProperties;
-        if (defined(value) && !value) {
-            md += 'Additional properties are not allowed.\n\n';
-        } else {
-            md += 'Additional properties are allowed.\n\n';
-            // TODO: display their schema
+        if (!summaryOnly)
+        {
+            value = schema.additionalProperties;
+            if (defined(value) && !value) {
+                md += 'Additional properties are not allowed.\n\n';
+            } else {
+                md += 'Additional properties are allowed.\n\n';
+                // TODO: display their schema
+            }
         }
 
         // Schema reference
@@ -219,9 +223,12 @@ function getSchemaMarkdown(schema, fileName, headerLevel, suppressWarnings, sche
         }
 
         // Render section for each property
-        var title = defaultValue(schema.title, suppressWarnings ? '' : 'WETZEL_WARNING: title not defined');
-        md += createPropertiesDetails(schema, title, headerLevel + 1, knownTypes, autoLink);
-        md += createExamples(schema, headerLevel);
+        if (!summaryOnly)
+        {
+            var title = defaultValue(schema.title, suppressWarnings ? '' : 'WETZEL_WARNING: title not defined');
+            md += createPropertiesDetails(schema, title, headerLevel + 1, knownTypes, autoLink);
+            md += createExamples(schema, headerLevel);
+        }
     }
 
     return md;