Merge pull request #1708 from thelounge/astorije/thelounge

Switch CLI tool from `lounge` to `thelounge`, deprecate `lounge`

README.md

@@ -40,13 +40,13 @@ Run this in a terminal to install (or upgrade) the latest stable release from
 When installation is complete, run:
 
 ```sh
-lounge start
+thelounge start
 ```
 
 For more information, read the [documentation](https://thelounge.github.io/docs/), [wiki](https://github.com/thelounge/lounge/wiki), or run:
 
 ```sh
-lounge --help
+thelounge --help
 ```
 
 ### Running from source
@@ -61,7 +61,7 @@ NODE_ENV=production npm run build
 npm start
 ```
 
-When installed like this, npm doesn't create a `lounge` executable. Use `npm start -- <command>` to run subcommands.
+When installed like this, npm doesn't create a `thelounge` executable. Use `npm start -- <command>` to run subcommands.
 
 ⚠️ While it is the most recent codebase, this is not production-ready! Run at
 your own risk. It is also not recommended to run this as root.

package.json

@@ -4,7 +4,8 @@
   "version": "2.6.0",
   "preferGlobal": true,
   "bin": {
-    "lounge": "index.js"
+    "lounge": "index.js",
+    "thelounge": "index.js"
   },
   "repository": {
     "type": "git",

src/clientManager.js

@@ -35,7 +35,7 @@ ClientManager.prototype.findClient = function(name) {
 
 ClientManager.prototype.autoloadUsers = function() {
 	const users = this.getUsers();
-	const noUsersWarning = `There are currently no users. Create one with ${colors.bold("lounge add <name>")}.`;
+	const noUsersWarning = `There are currently no users. Create one with ${colors.bold("thelounge add <name>")}.`;
 
 	if (users.length === 0) {
 		log.info(noUsersWarning);

src/command-line/index.js

@@ -58,6 +58,13 @@ require("./reset");
 require("./edit");
 require("./install");
 
+// TODO: Remove this when releasing The Lounge v3
+if (process.argv[1].endsWith(`${require("path").sep}lounge`)) {
+	log.warn(`The ${colors.red("lounge")} CLI is ${colors.bold("deprecated")} and will be removed in v3.`);
+	log.warn(`Use ${colors.green("thelounge")} instead.`);
+	process.argv[1] = "thelounge";
+}
+
 program.parse(process.argv);
 
 if (!program.args.length) {

src/command-line/list.js

@@ -34,6 +34,6 @@ program
 				log.info(`${i + 1}. ${colors.bold(user)}`);
 			});
 		} else {
-			log.info(`There are currently no users. Create one with ${colors.bold("lounge add <name>")}.`);
+			log.info(`There are currently no users. Create one with ${colors.bold("thelounge add <name>")}.`);
 		}
 	});