Merge branch 'main' into erikarowland/source-alias-subcommand-aliases-from-subcommand-structs

kodiakhq[bot] · web-flow · commit 60436124604a · 2024-11-01T23:56:50.000Z
diff --git a/.changeset/fast-walls-enjoy.md b/.changeset/fast-walls-enjoy.md
@@ -0,0 +1,5 @@
+---
+'vercel': patch
+---
+
+Don't print empty "Examples" section in `--help` output
diff --git a/packages/cli/src/commands/help.ts b/packages/cli/src/commands/help.ts
@@ -270,6 +270,9 @@ export function buildSubcommandLines(
 }
 
 export function buildCommandExampleLines(command: Command) {
+  if (!command.examples?.length) {
+    return null;
+  }
   const outputArray: string[] = [`${INDENT}${chalk.dim('Examples:')}`, ''];
   for (const example of command.examples) {
     const nameLine: string[] = [INDENT];
diff --git a/packages/cli/test/unit/commands/__snapshots__/help.test.ts.snap b/packages/cli/test/unit/commands/__snapshots__/help.test.ts.snap
@@ -189,8 +189,6 @@ exports[`help command > alias help output snapshots > alias list subcommand > al
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -218,8 +216,6 @@ exports[`help command > alias help output snapshots > alias remove subcommand >
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -242,8 +238,6 @@ exports[`help command > alias help output snapshots > alias set subcommand > ali
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -440,8 +434,6 @@ exports[`help command > certs help output snapshots > certs add help output snap
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -1109,8 +1101,6 @@ exports[`help command > dns help output snapshots > dns add help output snapshot
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -1371,8 +1361,6 @@ exports[`help command > dns help output snapshots > dns import help output snaps
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -1401,8 +1389,6 @@ exports[`help command > dns help output snapshots > dns list help output snapsho
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -1425,8 +1411,6 @@ exports[`help command > dns help output snapshots > dns remove help output snaps
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 
@@ -2590,8 +2574,6 @@ exports[`help command > integration help output snapshots > integration help col
                               number    
 
 
-  Examples:
-
 "
 `;
 
@@ -2623,8 +2605,6 @@ exports[`help command > integration help output snapshots > integration help col
   -v,  --version              Output the version number                         
 
 
-  Examples:
-
 "
 `;
 
@@ -2655,8 +2635,6 @@ exports[`help command > integration help output snapshots > integration help col
   -v,  --version              Output the version number                                                                 
 
 
-  Examples:
-
 "
 `;
 

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'vercel': patch
 +---
++
 +Don't print empty "Examples" section in `--help` output
Original file line number	Diff line number	Diff line change
`@@ -270,6 +270,9 @@ export function buildSubcommandLines(`
`270`	`270`	`}`
`271`	`271`
`272`	`272`	`export function buildCommandExampleLines(command: Command) {`
	`273`	`+ if (!command.examples?.length) {`
	`274`	`+ return null;`
	`275`	`+ }`
`273`	`276`	const outputArray: string[] = [`${INDENT}${chalk.dim('Examples:')}`, ''];
`274`	`277`	`for (const example of command.examples) {`
`275`	`278`	`const nameLine: string[] = [INDENT];`
Original file line number	Diff line number	Diff line change
@@ -189,8 +189,6 @@ exports[`help command > alias help output snapshots > alias list subcommand > al
`189`	`189`	`-v, --version Output the version number`
`190`	`190`
`191`	`191`
`192`		`- Examples:`
`193`		`-`
`194`	`192`	`"`
`195`	`193`	`;
`196`	`194`
@@ -218,8 +216,6 @@ exports[`help command > alias help output snapshots > alias remove subcommand >
`218`	`216`	`-v, --version Output the version number`
`219`	`217`
`220`	`218`
`221`		`- Examples:`
`222`		`-`
`223`	`219`	`"`
`224`	`220`	`;
`225`	`221`
@@ -242,8 +238,6 @@ exports[`help command > alias help output snapshots > alias set subcommand > ali
`242`	`238`	`-v, --version Output the version number`
`243`	`239`
`244`	`240`
`245`		`- Examples:`
`246`		`-`
`247`	`241`	`"`
`248`	`242`	`;
`249`	`243`
@@ -440,8 +434,6 @@ exports[`help command > certs help output snapshots > certs add help output snap
`440`	`434`	`-v, --version Output the version number`
`441`	`435`
`442`	`436`
`443`		`- Examples:`
`444`		`-`
`445`	`437`	`"`
`446`	`438`	`;
`447`	`439`
@@ -1109,8 +1101,6 @@ exports[`help command > dns help output snapshots > dns add help output snapshot
`1109`	`1101`	`-v, --version Output the version number`
`1110`	`1102`
`1111`	`1103`
`1112`		`- Examples:`
`1113`		`-`
`1114`	`1104`	`"`
`1115`	`1105`	`;
`1116`	`1106`
@@ -1371,8 +1361,6 @@ exports[`help command > dns help output snapshots > dns import help output snaps
`1371`	`1361`	`-v, --version Output the version number`
`1372`	`1362`
`1373`	`1363`
`1374`		`- Examples:`
`1375`		`-`
`1376`	`1364`	`"`
`1377`	`1365`	`;
`1378`	`1366`
@@ -1401,8 +1389,6 @@ exports[`help command > dns help output snapshots > dns list help output snapsho
`1401`	`1389`	`-v, --version Output the version number`
`1402`	`1390`
`1403`	`1391`
`1404`		`- Examples:`
`1405`		`-`
`1406`	`1392`	`"`
`1407`	`1393`	`;
`1408`	`1394`
@@ -1425,8 +1411,6 @@ exports[`help command > dns help output snapshots > dns remove help output snaps
`1425`	`1411`	`-v, --version Output the version number`
`1426`	`1412`
`1427`	`1413`
`1428`		`- Examples:`
`1429`		`-`
`1430`	`1414`	`"`
`1431`	`1415`	`;
`1432`	`1416`
@@ -2590,8 +2574,6 @@ exports[`help command > integration help output snapshots > integration help col
`2590`	`2574`	`number`
`2591`	`2575`
`2592`	`2576`
`2593`		`- Examples:`
`2594`		`-`
`2595`	`2577`	`"`
`2596`	`2578`	`;
`2597`	`2579`
@@ -2623,8 +2605,6 @@ exports[`help command > integration help output snapshots > integration help col
`2623`	`2605`	`-v, --version Output the version number`
`2624`	`2606`
`2625`	`2607`
`2626`		`- Examples:`
`2627`		`-`
`2628`	`2608`	`"`
`2629`	`2609`	`;
`2630`	`2610`
@@ -2655,8 +2635,6 @@ exports[`help command > integration help output snapshots > integration help col
`2655`	`2635`	`-v, --version Output the version number`
`2656`	`2636`
`2657`	`2637`
`2658`		`- Examples:`
`2659`		`-`
`2660`	`2638`	`"`
`2661`	`2639`	`;
`2662`	`2640`