fix(command): single quotes in option description breaks fish complet…

…ions (#518)
c4spar · Dec 19, 2022 · c09c74a · c09c74a
1 parent eb53cd2
commit c09c74a
Show file tree

Hide file tree

Showing 4 changed files with 116 additions and 98 deletions.
diff --git a/command/_utils.ts b/command/_utils.ts
@@ -161,5 +161,7 @@ export function getDescription(
   description: string,
   short?: boolean,
 ): string {
-  return short ? description.trim().split("\n", 1)[0] : dedent(description);
+  return short
+    ? description.trim().split("\n", 1)[0].trim()
+    : dedent(description);
 }
diff --git a/command/completions/_fish_completions_generator.ts b/command/completions/_fish_completions_generator.ts
@@ -126,12 +126,20 @@ ${this.generateCompletions(this.cmd).trim()}`;
     options.standalone && cmd.push("-x");
     cmd.push("-k");
     cmd.push("-f");
+
     if (options.arguments) {
       options.required && cmd.push("-r");
       cmd.push("-a", options.arguments);
     }
-    options.description &&
-      cmd.push("-d", `'${getDescription(options.description, true)}'`);
+
+    if (options.description) {
+      const description: string = getDescription(options.description, true)
+        // escape single quotes
+        .replace(/'/g, "\\'");
+
+      cmd.push("-d", `'${description}'`);
+    }
+
     return cmd.join(" ");
   }