Merge pull request #22 from wuespace/clear-default-value-source

Specify the source of the default values in `docs`
wuespace · Dec 8, 2024 · cbe4ef2 · cbe4ef2
2 parents 1166852 + 10269d9
commit cbe4ef2
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/lib/writers/docs.ts b/lib/writers/docs.ts
@@ -35,7 +35,10 @@ export class DocsWriter implements Writer {
     }
 
     // Default value
-    prev += '#### Default Value\n\n';
+    const defaultSource = variable.optional
+      ? "used by the application if not provided"
+      : "from the example environment file, must be provided";
+    prev += `#### Default Value (${defaultSource})\n\n`;
     prev += this.markdownCodeBlock(`${variable.name}=${variable.defaultValue}`);
 
     // Example values