Merge branch 'main' into 0.3.0

Author: pklaschka

.env.example

@@ -2,23 +2,26 @@
 # This file is used to store environment variables for the application
 # It is not meant to be checked into version control
 
-# Section
+# Another section
 #
-# Description of REQUIRED_VARIABLE
-REQUIRED_VARIABLE=
-# REQUIRED_VARIABLE=EXAMPLE_VALUE_1
-# REQUIRED_VARIABLE=EXAMPLE_VALUE_2
-# REQUIRED_VARIABLE_FILE=/run/secrets/required_variable
+# Description of OPTIONAL_VARIABLE_WITH_DEFAULT
+# OPTIONAL_VARIABLE_WITH_DEFAULT=EXAMPLE_VALUE_1
+# OPTIONAL_VARIABLE_WITH_DEFAULT=EXAMPLE_VALUE_2
+#
+# OPTIONAL_VARIABLE_WITH_DEFAULT_FILE=/run/secrets/optional_variable_with_default
+
+# Section
 #
 # Description of OPTIONAL_VARIABLE
 # OPTIONAL_VARIABLE=
 # OPTIONAL_VARIABLE=EXAMPLE_VALUE_1
 # OPTIONAL_VARIABLE=EXAMPLE_VALUE_2
+#
 # OPTIONAL_VARIABLE_FILE=/run/secrets/optional_variable
-
-# Another section
 #
-# Description of OPTIONAL_VARIABLE_WITH_DEFAULT
-# OPTIONAL_VARIABLE_WITH_DEFAULT=EXAMPLE_VALUE_1
-# OPTIONAL_VARIABLE_WITH_DEFAULT=EXAMPLE_VALUE_2
-# OPTIONAL_VARIABLE_WITH_DEFAULT_FILE=/run/secrets/optional_variable_with_default
+# Description of REQUIRED_VARIABLE
+REQUIRED_VARIABLE=
+# REQUIRED_VARIABLE=EXAMPLE_VALUE_1
+# REQUIRED_VARIABLE=EXAMPLE_VALUE_2
+#
+# REQUIRED_VARIABLE_FILE=/run/secrets/required_variable

main.ts

@@ -9,33 +9,47 @@ if (import.meta.main) {
   const docs = new Command()
     .arguments("<path:file>")
     .description("Generate documentation from .env files")
-    .action(async (_options, path: string) => {
-      console.log(
-        await parseAndConvert(
-          path,
-          new DocsWriter(),
-        ),
+    .option("-o, --output <path:string>", "Output file path")
+    .action(async ({ output }, path) => {
+      const markdown = await parseAndConvert(
+        path,
+        new DocsWriter(),
       );
+      if (output) {
+        await Deno.writeTextFile(output, markdown);
+        console.log(`File written: ${output}`);
+      } else {
+        console.log(markdown);
+      }
     });
 
   const envExample = new Command()
     .arguments("<path:string>")
     .description("Generate example .env file")
-    .action(async (_options, path: string) => {
-      console.log(
-        await parseAndConvert(
-          path,
-          new EnvExampleWriter(),
-        ),
+    .option("-r, --replace", "Replace existing .env file")
+    .option("-o, --output <path:string>", "Output file path")
+    .action(async ({ replace, output }, path: string) => {
+      const fileContents = await parseAndConvert(
+        path,
+        new EnvExampleWriter(),
       );
+      if (replace || output) {
+        await Deno.writeTextFile(output ?? path, fileContents);
+        console.log(`File written: ${output ?? path}`);
+      } else {
+        console.log(fileContents);
+      }
     });
 
   await new Command()
     .name("envardoc")
     .version(metadata.version)
     .description(metadata.description)
-    .meta('Deno', Deno.version.deno)
-    .meta('FS Read Permissions', Deno.permissions.querySync({ name: "read" }).state)
+    .meta("Deno", Deno.version.deno)
+    .meta(
+      "FS Read Permissions",
+      Deno.permissions.querySync({ name: "read" }).state,
+    )
     .command("docs", docs)
     .command("example", envExample)
     .parse(Deno.args);