supernets/hardlounge
supernets/hardlounge
4
Fork 0
Code Issues 1 Pull Requests Packages Projects Releases Wiki Activity

Update CLI help with regard to recent deprecation of --home option

Browse Source 
- Mark the option as deprecated (cannot be removed from the help, unfortunately)
- Add details to `lounge config` regarding `LOUNGE_HOME`
- Remove mention of `--home` in default config file
This commit is contained in:
Jérémie Astori 2017-08-15 23:30:01 -04:00
parent f93634df39
commit 5e7a7a3870
No known key found for this signature in database
GPG Key ID: B9A4F245CD67BDE8
3 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
defaults/config.js
View File

@ -73,7 +73,7 @@ module.exports = {
// which in result fixes mixed content warnings.
//
// If storage is enabled, The Lounge will fetch and store images and thumbnails
// in ~/.lounge/storage folder, or %HOME%/storage if --home is used.
// in the `${LOUNGE_HOME}/storage` folder.
//
// Images are deleted when they are no longer referenced by any message (controlled by maxHistory),
// and the folder is cleaned up on every The Lounge restart.

2
src/command-line/config.js
View File

@ -7,7 +7,7 @@ var Helper = require("../helper");
program
.command("config")
.description(`Edit configuration file located at ${colors.green(Helper.CONFIG_PATH)}.`)
.description(`Edit configuration file located at ${colors.green(Helper.CONFIG_PATH)}. Set the ${colors.green("LOUNGE_HOME")} environment variable to change.`)
.action(function() {
var child_spawn = child.spawn(
process.env.EDITOR || "vi",

6
src/command-line/index.js
View File

@ -10,12 +10,12 @@ var path = require("path");
var Helper = require("../helper");
program.version(Helper.getVersion(), "-v, --version")
.option("--home <path>", "path to configuration folder")
.option("--home <path>", `${colors.bold("[DEPRECATED]")} Use the ${colors.green("LOUNGE_HOME")} environment variable instead.`)
.parseOptions(process.argv);
if (program.home) {
log.warn(`${colors.green("--home")} is deprecated and will be removed in a future version.`);
log.warn(`Use ${colors.green("LOUNGE_HOME")} environment variable instead.`);
log.warn(`${colors.green("--home")} is ${colors.bold("deprecated")} and will be removed in a future version.`);
log.warn(`Use the ${colors.green("LOUNGE_HOME")} environment variable instead.`);
}
let home = program.home || process.env.LOUNGE_HOME;