Document default values

lstrojny · Jan 3, 2023 · 0556ea6 · 0556ea6
1 parent 9831841
commit 0556ea6
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -21,17 +21,23 @@ Enable the plugin in the homebridge `config.json`:
 
 
       // Debugging enabled
+      //
+      // Default: false
       "debug": "<boolean>",
 
 
       // Publish all button press states as locks
       //
       // Pressed button is presented as unlocked, otherwise locked. Can help identify
       // the beacon
+      //
+      // Default: false
       "buttonAsLock": "<boolean>",
 
 
       // List of devices
+      //
+      // Default: []
       [
         {
           // Address

diff --git a/code-generation/config-scheme-gen.js b/code-generation/config-scheme-gen.js
@@ -57,6 +57,9 @@ function generateDocs(schema) {
                     if (definition.description) {
                         lines.push(`//\n// ${wordwrap(definition.description, 80 - indentation, '\n// ')}`)
                     }
+                    if (definition.default !== undefined) {
+                        lines.push(`//\n// Default: ${JSON.stringify(definition.default)}`)
+                    }
 
                     if (definition.type === 'array') {
                         lines.push('[')