Merge pull request #264 from Microsoft/tweaks

Command description tweaks

Author: lostintangent

cli/script/command-executor.ts

@@ -105,36 +105,36 @@ export var confirm = (): Promise<boolean> => {
 function accessKeyAdd(command: cli.IAccessKeyAddCommand): Promise<void> {
     return sdk.addAccessKey(command.name, command.ttl)
         .then((accessKey: AccessKey) => {
-            log(`Successfully created a new access key "${command.name}": ${accessKey.key}`);
-            log(`(Expires: ${new Date(accessKey.expires).toString()})`);
-            log(`Please save this key as it will only be shown once!`);
+            log(`Successfully created the "${command.name}" access key: ${accessKey.key}`);
+            log("Make sure to save this key value somewhere safe, since you won't be able to view it from the CLI again!");
         });
 }
 
 function accessKeyPatch(command: cli.IAccessKeyPatchCommand): Promise<void> {
-    var willUpdateName: boolean = isCommandOptionSpecified(command.newName) && command.oldName !== command.newName;
-    var willUpdateTtl: boolean = isCommandOptionSpecified(command.ttl);
+    const willUpdateName: boolean = isCommandOptionSpecified(command.newName) && command.oldName !== command.newName;
+    const willUpdateTtl: boolean = isCommandOptionSpecified(command.ttl);
 
     if (!willUpdateName && !willUpdateTtl) {
         throw new Error("A new name and/or TTL must be provided.");
     }
 
     return sdk.patchAccessKey(command.oldName, command.newName, command.ttl)
         .then((accessKey: AccessKey) => {
-            var logMessage: string = "Successfully ";
+            let logMessage: string = "Successfully ";
             if (willUpdateName) {
                 logMessage += `renamed the access key "${command.oldName}" to "${command.newName}"`;
             }
 
             if (willUpdateTtl) {
+                const expirationDate = moment(accessKey.expires).format("LLLL");
                 if (willUpdateName) {
-                    logMessage += ` and changed its expiry to ${new Date(accessKey.expires).toString()}`;
+                    logMessage += ` and changed its expiration date to ${expirationDate}`;
                 } else {
-                    logMessage += `changed the access key "${command.oldName}"'s expiry to ${new Date(accessKey.expires).toString()}`;
+                    logMessage += `changed the expiration date of the "${command.oldName}" access key to ${expirationDate}`;
                 }
             }
 
-            log(logMessage + ".");
+            log(`${logMessage}.`);
         });
 }
 
@@ -153,7 +153,7 @@ function accessKeyRemove(command: cli.IAccessKeyRemoveCommand): Promise<void> {
             if (wasConfirmed) {
                 return sdk.removeAccessKey(command.accessKey)
                     .then((): void => {
-                        log("Successfully removed the \"" + command.accessKey + "\" access key.");
+                        log(`Successfully removed the "${command.accessKey}" access key.`);
                     });
             }
 
@@ -1430,14 +1430,14 @@ function sessionList(command: cli.ISessionListCommand): Promise<void> {
 
 function sessionRemove(command: cli.ISessionRemoveCommand): Promise<void> {
     if (os.hostname() === command.machineName) {
-        throw new Error("Cannot remove the current session via this command. Please run 'code-push logout' if you would like to end it.");
+        throw new Error("Cannot remove the current login session via this command. Please run 'code-push logout' instead.");
     } else {
         return confirm()
             .then((wasConfirmed: boolean): Promise<void> => {
                 if (wasConfirmed) {
                     return sdk.removeSession(command.machineName)
                         .then((): void => {
-                            log(`Successfully removed the existing session for "${command.machineName}".`);
+                            log(`Successfully removed the login session for "${command.machineName}".`);
                         });
                 }
 

cli/script/command-parser.ts

@@ -44,9 +44,9 @@ function accessKeyAdd(commandName: string, yargs: yargs.Argv): void {
     isValidCommand = true;
     yargs.usage(USAGE_PREFIX + " access-key " + commandName + " <accessKeyName>")
         .demand(/*count*/ 3, /*max*/ 3)  // Require exactly three non-option arguments.
-        .example("access-key " + commandName + " \"VSTS Integration\"", "Creates a new access key with the name \"VSTS Integration\" which expires by default in 60 days")
-        .example("access-key " + commandName + " \"One time key\" --ttl 5m", "Creates a new access key with the name \"One time key\" which expires in 5 minutes")
-        .option("ttl", { default: null, demand: false, description: "A duration string specifying the time for which the access key remains valid for use", type: "string" });
+        .example("access-key " + commandName + " \"VSTS Integration\"", "Creates a new access key with the name \"VSTS Integration\", which expires in 60 days")
+        .example("access-key " + commandName + " \"One time key\" --ttl 5m", "Creates a new access key with the name \"One time key\", which expires in 5 minutes")
+        .option("ttl", { default: "60d", demand: false, description: "Duration string which specifies the amount of time that the access key should remain valid for (e.g 5m, 60d, 1y)", type: "string" });
 
     addCommonConfiguration(yargs);
 }
@@ -56,9 +56,9 @@ function accessKeyPatch(commandName: string, yargs: yargs.Argv): void {
     yargs.usage(USAGE_PREFIX + " access-key " + commandName + " <accessKeyName>")
         .demand(/*count*/ 3, /*max*/ 3)  // Require exactly three non-option arguments.
         .example("access-key " + commandName + " \"Key for build server\" --name \"Key for CI machine\"", "Renames the access key named \"Key for build server\" to \"Key for CI machine\"")
-        .example("access-key " + commandName + " \"Key for build server\" --ttl 7d", "Edits the access key named \"Key for build server\" to expire in 7 days")
-        .option("name", { default: null, demand: false, description: "New name for the access key", type: "string" })
-        .option("ttl", { default: null, demand: false, description: "Duration string specifying the time for which the access key remains valid for use", type: "string" });
+        .example("access-key " + commandName + " \"Key for build server\" --ttl 7d", "Updates the access key named \"Key for build server\" to expire in 7 days")
+        .option("name", { default: null, demand: false, description: "Display name for the access key", type: "string" })
+        .option("ttl", { default: null, demand: false, description: "Duration string which specifies the amount of time that the access key should remain valid for (e.g 5m, 60d, 1y)", type: "string" });
     addCommonConfiguration(yargs);
 }
 
@@ -77,7 +77,7 @@ function accessKeyRemove(commandName: string, yargs: yargs.Argv): void {
     isValidCommand = true;
     yargs.usage(USAGE_PREFIX + " access-key " + commandName + " <accessKeyName>")
         .demand(/*count*/ 3, /*max*/ 3)  // Require exactly three non-option arguments.
-        .example("access-key " + commandName + " 8d6513de-050c-4788-96f7-b2a50dd9684v", "Removes the \"8d6513de-050c-4788-96f7-b2a50dd9684v\" access key");
+        .example("access-key " + commandName + " \"VSTS Integration\"", "Removes the \"VSTS Integration\" access key");
 
     addCommonConfiguration(yargs);
 }
@@ -196,7 +196,7 @@ var argv = yargs.usage(USAGE_PREFIX + " <command>")
         yargs.usage(USAGE_PREFIX + " access-key <command>")
             .demand(/*count*/ 2, /*max*/ 2)  // Require exactly two non-option arguments.
             .command("add", "Create a new access key associated with your account", (yargs: yargs.Argv) => accessKeyAdd("add", yargs))
-            .command("patch", "Update the name and expiry of an access key", (yargs: yargs.Argv) => accessKeyPatch("patch", yargs))
+            .command("patch", "Update the name and/or TTL of an existing access key", (yargs: yargs.Argv) => accessKeyPatch("patch", yargs))
             .command("remove", "Remove an existing access key", (yargs: yargs.Argv) => accessKeyRemove("remove", yargs))
             .command("rm", "Remove an existing access key", (yargs: yargs.Argv) => accessKeyRemove("rm", yargs))
             .command("list", "List the access keys associated with your account", (yargs: yargs.Argv) => accessKeyList("list", yargs))