From 98bfe349d95e6adb62c205869ab52c36439b8242 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=A9mie=20Astori?= Date: Mon, 21 Aug 2017 01:49:32 -0400 Subject: [PATCH] Add documentation for LOUNGE_HOME environment variable in the CLI helper --- src/command-line/add.js | 2 ++ src/command-line/config.js | 4 +++- src/command-line/edit.js | 2 ++ src/command-line/index.js | 2 ++ src/command-line/list.js | 2 ++ src/command-line/remove.js | 2 ++ src/command-line/reset.js | 2 ++ src/command-line/start.js | 2 ++ src/command-line/utils.js | 18 ++++++++++++++++++ 9 files changed, 35 insertions(+), 1 deletion(-) create mode 100644 src/command-line/utils.js diff --git a/src/command-line/add.js b/src/command-line/add.js index 7c0214c5..184292c3 100644 --- a/src/command-line/add.js +++ b/src/command-line/add.js @@ -4,10 +4,12 @@ var ClientManager = new require("../clientManager"); var colors = require("colors/safe"); var program = require("commander"); var Helper = require("../helper"); +const Utils = require("./utils"); program .command("add ") .description("Add a new user") + .on("--help", Utils.extraHelp) .action(function(name) { var manager = new ClientManager(); var users = manager.getUsers(); diff --git a/src/command-line/config.js b/src/command-line/config.js index e95763d5..908b3dcc 100644 --- a/src/command-line/config.js +++ b/src/command-line/config.js @@ -4,10 +4,12 @@ var program = require("commander"); var child = require("child_process"); var colors = require("colors/safe"); var Helper = require("../helper"); +const Utils = require("./utils"); program .command("config") - .description(`Edit configuration file located at ${colors.green(Helper.CONFIG_PATH)}. Set the ${colors.green("LOUNGE_HOME")} environment variable to change.`) + .description(`Edit configuration file located at ${colors.green(Helper.CONFIG_PATH)}.`) + .on("--help", Utils.extraHelp) .action(function() { var child_spawn = child.spawn( process.env.EDITOR || "vi", diff --git a/src/command-line/edit.js b/src/command-line/edit.js index f33f9e1c..eb6ec671 100644 --- a/src/command-line/edit.js +++ b/src/command-line/edit.js @@ -5,10 +5,12 @@ var program = require("commander"); var child = require("child_process"); var colors = require("colors/safe"); var Helper = require("../helper"); +const Utils = require("./utils"); program .command("edit ") .description(`Edit user file located at ${colors.green(Helper.getUserConfigPath(""))}.`) + .on("--help", Utils.extraHelp) .action(function(name) { var users = new ClientManager().getUsers(); if (users.indexOf(name) === -1) { diff --git a/src/command-line/index.js b/src/command-line/index.js index 556644d8..48825be1 100644 --- a/src/command-line/index.js +++ b/src/command-line/index.js @@ -8,9 +8,11 @@ var fs = require("fs"); var fsextra = require("fs-extra"); var path = require("path"); var Helper = require("../helper"); +const Utils = require("./utils"); program.version(Helper.getVersion(), "-v, --version") .option("--home ", `${colors.bold("[DEPRECATED]")} Use the ${colors.green("LOUNGE_HOME")} environment variable instead.`) + .on("--help", Utils.extraHelp) .parseOptions(process.argv); if (program.home) { diff --git a/src/command-line/list.js b/src/command-line/list.js index 8020edda..8ca63ea7 100644 --- a/src/command-line/list.js +++ b/src/command-line/list.js @@ -3,10 +3,12 @@ var ClientManager = new require("../clientManager"); var program = require("commander"); var colors = require("colors/safe"); +const Utils = require("./utils"); program .command("list") .description("List all users") + .on("--help", Utils.extraHelp) .action(function() { var users = new ClientManager().getUsers(); if (!users.length) { diff --git a/src/command-line/remove.js b/src/command-line/remove.js index 3e90b658..e0a971bc 100644 --- a/src/command-line/remove.js +++ b/src/command-line/remove.js @@ -3,10 +3,12 @@ var ClientManager = new require("../clientManager"); var program = require("commander"); var colors = require("colors/safe"); +const Utils = require("./utils"); program .command("remove ") .description("Remove an existing user") + .on("--help", Utils.extraHelp) .action(function(name) { var manager = new ClientManager(); if (manager.removeUser(name)) { diff --git a/src/command-line/reset.js b/src/command-line/reset.js index 018b73d5..9546435e 100644 --- a/src/command-line/reset.js +++ b/src/command-line/reset.js @@ -5,10 +5,12 @@ var fs = require("fs"); var program = require("commander"); var colors = require("colors/safe"); var Helper = require("../helper"); +const Utils = require("./utils"); program .command("reset ") .description("Reset user password") + .on("--help", Utils.extraHelp) .action(function(name) { var users = new ClientManager().getUsers(); if (users.indexOf(name) === -1) { diff --git a/src/command-line/start.js b/src/command-line/start.js index f1c6ca10..4da4b499 100644 --- a/src/command-line/start.js +++ b/src/command-line/start.js @@ -5,6 +5,7 @@ var program = require("commander"); var colors = require("colors/safe"); var server = require("../server"); var Helper = require("../helper"); +const Utils = require("./utils"); program .command("start") @@ -14,6 +15,7 @@ program .option(" --public", "start in public mode") .option(" --private", "start in private mode") .description("Start the server") + .on("--help", Utils.extraHelp) .action(function(options) { var users = new ClientManager().getUsers(); diff --git a/src/command-line/utils.js b/src/command-line/utils.js new file mode 100644 index 00000000..1b2cd454 --- /dev/null +++ b/src/command-line/utils.js @@ -0,0 +1,18 @@ +"use strict"; + +const colors = require("colors/safe"); + +class Utils { + static extraHelp() { + [ + "", + "", + " Environment variable:", + "", + ` LOUNGE_HOME Path for all configuration files and folders. Defaults to ${colors.green("~/.lounge")}.`, + "", + ].forEach((e) => console.log(e)); + } +} + +module.exports = Utils;