fix(usage): render valueHint for positional args

unjs · Feb 14, 2024 · dbd1d92 · dbd1d92
1 parent 0e73aad
commit dbd1d92
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/playground/commands/build.ts b/playground/commands/build.ts
@@ -35,6 +35,7 @@ export default defineCommand({
       type: "positional",
       required: false,
       description: "path to output directory",
+      default: ".output",
     },
   },
   run({ args }) {

diff --git a/playground/commands/deploy.ts b/playground/commands/deploy.ts
@@ -47,10 +47,10 @@ export default defineCommand({
       type: "boolean",
       description: "Dry run the deployment process",
     },
-    outputDir: {
+    provider: {
       type: "positional",
-      description: "Path to the build output directory",
-      default: ".output",
+      description: "Deployment provider",
+      valueHint: "foo|bar|baz|qux",
     },
   },
   run({ args }) {

diff --git a/src/usage.ts b/src/usage.ts
@@ -37,8 +37,12 @@ export async function renderUsage<T extends ArgsDef = ArgsDef>(
       const name = arg.name.toUpperCase();
       const isRequired = arg.required !== false && arg.default === undefined;
       // (isRequired ? " (required)" : " (optional)"
-      const usageHint = arg.default ? `="${arg.default}"` : "";
-      posLines.push(["`" + name + usageHint + "`", arg.description || ""]);
+      const defaultHint = arg.default ? `="${arg.default}"` : "";
+      posLines.push([
+        "`" + name + defaultHint + "`",
+        arg.description || "",
+        arg.valueHint ? `<${arg.valueHint}>` : "",
+      ]);
       usageLine.push(isRequired ? `<${name}>` : `[${name}]`);
     } else {
       const isRequired = arg.required === true && arg.default === undefined;