fix: improve documentation for boolean script arguments (#21)

octoherd · Mar 14, 2021 · 02a210b · 02a210b
1 parent bf41381
commit 02a210b
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/lib/create-readme.js b/lib/create-readme.js
@@ -67,10 +67,24 @@ ${usage}
 `;
 
       Object.entries(scriptOptions).forEach(
-        ([name, { type, required, description }]) => {
-          content += `| \`--${decamelize(name, {
+        ([name, { type, required, description, default: defaultValue }]) => {
+          const CliOption = decamelize(name, {
             separator: "-",
-          })}\` | ${type} | ${required ? `**(required)**` : ""} ${description} |
+          });
+          let optionNames = `\`--${CliOption}\``;
+          if (type === "boolean") {
+            optionNames += ` or \`--no-${CliOption}\``;
+          }
+
+          content += `| ${optionNames} | ${type} | ${
+            required ? `**(required)**` : ""
+          } ${description} ${
+            defaultValue
+              ? `. Defaults to ${
+                  type === "string" ? `"${defaultValue}"` : defaultValue
+                }`
+              : ""
+          } |
 `;
         }
       );

diff --git a/lib/prompts.js b/lib/prompts.js
@@ -142,7 +142,7 @@ export default async function prompts({
     {
       type: "input",
       name: "path",
-      message: `Folder path to initialize the project in, relative to current path. If the path it does not yet exist it will be created. Current path is ${process.cwd()})`,
+      message: `Folder path to initialize the project in, relative to current path. If the path does not yet exist it will be created. Current path is ${process.cwd()})`,
       default: () => answers1.repository.split("/")[1],
     },
   ]);