Improve some command formatting (#504)

* Improve formatting of command help

- Ensure args included in monospace formatting
- Show required args as `<arg>`
- Show optional args as `[arg]`

* Don't print undefined username with Jira `whoami`

* Fix typo in `feed remove` description

* Add changelog

* Relabel changes as a bugfix

changelog.d/504.bugfix

@@ -0,0 +1 @@
+Improve formatting of help commands and Jira's `whoami` command.

src/BotCommands.ts

@@ -49,10 +49,15 @@ export function compileBotCommands(...prototypes: Record<string, BotCommandFunct
             const b = Reflect.getMetadata(botCommandSymbol, prototype, propertyKey);
             if (b) {
                 const category = b.category || "default";
-                const requiredArgs = b.requiredArgs?.join(" ") || "";
+                const requiredArgs = b.requiredArgs?.map((arg: string) =>  `<${arg}>`).join(" ") || "";
                 const optionalArgs = b.optionalArgs?.map((arg: string) =>  `[${arg}]`).join(" ") || "";
+                const cmdStr =
+                    ` - \`££PREFIX££${b.prefix}` +
+                    (requiredArgs ? ` ${requiredArgs}` : "") +
+                    (optionalArgs ? ` ${optionalArgs}` : "") +
+                    `\` - ${b.help}`;
                 cmdStrs[category] = cmdStrs[category] || []
-                cmdStrs[category].push(` - \`££PREFIX££${b.prefix}\` ${requiredArgs} ${optionalArgs} - ${b.help}`);
+                cmdStrs[category].push(cmdStr);
                 // We know that these types are safe.
                 botCommands[b.prefix as string] = {
                     fn: prototype[propertyKey],

src/Connections/SetupConnection.ts

@@ -224,7 +224,7 @@ export class SetupConnection extends CommandConnection {
         }
     }
 
-    @botCommand("feed remove", { help: "Unsubscribe from an RSS/Atom.", requiredArgs: ["url"], includeUserId: true, category: "feed"})
+    @botCommand("feed remove", { help: "Unsubscribe from an RSS/Atom feed.", requiredArgs: ["url"], includeUserId: true, category: "feed"})
     public async onFeedRemove(userId: string, url: string) {
         await this.checkUserPermissions(userId, "feed", FeedConnection.CanonicalEventType);
 

src/Jira/AdminCommands.ts

@@ -59,7 +59,10 @@ export class JiraBotCommands extends AdminRoomCommandHandler {
                 continue;
             }
             const user = await clientForResource.getCurrentUser();
-            response += `\n - ${resource.name} ${user.name} (${user.displayName || ""})`;
+            response +=
+                `\n - ${resource.name}` +
+                (user.name ? ` ${user.name}` : "") +
+                (user.displayName ? ` (${user.displayName})` : "");
         }
         await this.sendNotice(response);
     }