Better management of the /help default command

Author: ALCC01

README.md

@@ -7,6 +7,8 @@ Nodeogram is a simple yet complete Node.JS module for Telegram bots.
 * **Promises**. The entire library is promise-based
 * **Event based**. Nodeogram provides an event-based handling of updates, allowing you to interact more easily with messages, commands, callback and inline queries.
 
+Nodeogram is an open-source project available on `GitHub <https://github.com/ALCC01/nodeogram>`_ and `npm <https://www.npmjs.com/package/nodeogram>`_.
+
 ## Getting started
 
 First, you'll need to install the module
@@ -25,7 +27,7 @@ bot.init();
 bot.on('message', message => message.reply("Hello World!"));
 ```
 
-And you are done.
+And you are done. You can see more extensive examples in the [library overview](https://dev.albertocoscia.me/nodeogram/quickstart.html)
 
 ## Documentation
 Please refer to the [Nodeogram documentation](https://dev.albertocoscia.me/nodeogram/)

docs/index.rst

@@ -33,7 +33,7 @@ Once the package is installed, you can start working on your bot.
    bot.init();
    bot.on('message', message => message.reply("Hello World!"));
 
-And you are done. You can more extensive examples in the :doc:`quickstart`
+And you are done. You can see more extensive examples in the :doc:`quickstart`
 
 =======
 License

docs/objects/Bot.rst

@@ -19,14 +19,16 @@ This object represents a Telegram bot.
 
     .. code-block:: javascript
 
-    {
-        // File to which profiles should be saved
-        profiles_path: __dirname +'/profiles.json',
-        // Whether or not users should be saved
-        saveUsers: true;
-        // Whether or not chats should be saved
-        saveChats: true
-    }
+        {
+            // File to which profiles should be saved
+            profiles_path: __dirname +'/profiles.json',
+            // Whether or not users should be saved
+            saveUsers: true,
+            // Whether or not chats should be saved
+            saveChats: true,
+            // Whether or not the /help command should be registered by default
+            enableHelp: true
+        }
 
 .. _init:
 .. js:function:: init()
@@ -39,11 +41,12 @@ This object represents a Telegram bot.
     shouldn't be called manually. The first call made by the bot will be with a -1 offset that will erase any backlog updates.
     Updates older than 2 seconds are also ignored. Updates are retrieved 100 at a time, with a 30 seconds timeout.
 
-.. js:function:: command(command, description, callback)
+.. js:function:: command(command, description, hidden, callback)
 
     :param string command: The command, without the opening /
-    :param string description: <String> The command's description, will be used for the /help message
-    :param function callback: <Function> This function will be called whenever the command is triggered with an array of arguments ``args`` along with the :doc:`Message` ``message`` responsible for triggering the command
+    :param string description: The command's description, will be used for the default /help message
+    :param boolean hidden: Set this to true in order to hide this command from the default /help message
+    :param function callback: This function will be called whenever the command is triggered with an array of arguments ``args`` along with the :doc:`Message` ``message`` responsible for triggering the command
 
     Registers a command handler for the specified ``command``, with the provided ``description`` and ``callback``, also
     adding the command to the /help message.

docs/quickstart.rst

@@ -82,12 +82,13 @@ the arguments provided.
 .. code-block:: javascript
     :linenos:
 
-    bot.command('echo', 'Echoes your voice', (args, message) => {
+    bot.command('echo', 'Echoes your voice', false, (args, message) => {
         if (args[0] != '') message.reply(args.join(' '), {});
     });
 
 This registers a new handler for the command ``/echo`` with the description *Echoes your voice* and acts as defined in
-the callback. Oh, did I mention that it also adds it automagically to the ``/help`` command?
+the callback. Oh, did I mention that it also adds it automagically to the ``/help`` command? If you don't want your users
+to know about the command, just make it a secret between you and the bot setting the third argument to ``true``.
 
 ****************
 Service messages

docs/style.rst

@@ -22,7 +22,7 @@ Nodeogram does not introduce intrusive error handling and as a result you should
 ``catch`` function.
 
 Nodeogram's functions can fail at any time - querying the API, attempting to send a message to a chat the
-bot was kicked out of, etc - and not handling errors properly might result in unexpected behaviours or worse - getting
+bot was kicked out, etc - and not handling errors properly might result in unexpected behaviours or worse - getting
 your bot or IP address tempbanned from Telegram's server could really ruin your day.
 
 ==============

lib/Bot.js

@@ -26,10 +26,13 @@ function Bot(token, options) {
     this.emitter = new events.EventEmitter();
     this.saveUsers = true;
     this.saveChats = true;
+    this.enableHelp = true;
     extend(this, options);
 
     this.handleAPIError = (err) => {
-        if (err.response) { console.log(`An error occurred while querying the Telegram API - ${err.response.text ? JSON.parse(err.response.text).error_code : ""} ${err.response.text ? JSON.parse(err.response.text).description : ""}`)}
+        if (err.response) {
+            console.log(`An error occurred while querying the Telegram API - ${err.response.text ? JSON.parse(err.response.text).error_code : ""} ${err.response.text ? JSON.parse(err.response.text).description : ""}`)
+        }
         else console.log(err)
     };
 
@@ -121,8 +124,8 @@ function Bot(token, options) {
 
     };
 
-    this.command = (command, description, callback) => {
-        this.commands.push({command: command, description: description, callback: callback});
+    this.command = (command, description, hidden, callback) => {
+        this.commands.push({command: command, description: description, callback: callback, hidden: hidden});
     };
 
     this.getChat = (chat_id) => {
@@ -434,7 +437,9 @@ function Bot(token, options) {
             profiles.chats[message.chat.id].bot = undefined;
             edited = true;
         }
-        if (edited) fs.writeFile(this.profiles_path, JSON.stringify(profiles), (err) => {if (err) console.log(err)})
+        if (edited) fs.writeFile(this.profiles_path, JSON.stringify(profiles), (err) => {
+            if (err) console.log(err)
+        })
     };
 
     this.broadcast = (filter, callback) => {
@@ -460,16 +465,29 @@ function Bot(token, options) {
         ];
         if (this.profiles_path) {
             this.messageHandlers.push(this.handleProfiles);
-            global.profiles = {users: {}, chats:{}};
-            try {global.profiles = require(this.profiles_path)} catch (err) {}
+            global.profiles = {users: {}, chats: {}};
+            try {
+                global.profiles = require(this.profiles_path)
+            } catch (err) {
+            }
         }
-        this.command('help', 'Display help for this bot', (args, message) => {
-            var text = 'Commands:\n';
-            this.commands.forEach((entry) => {
-                text += `\n/${entry.command} - ${entry.description}`
+        if (this.enableHelp) {
+            this.command('help', 'Display help for this bot', false, (args, message) => {
+                var text = 'Commands:\n';
+                var total = 0;
+                this.commands.forEach((entry) => {
+                    if (!entry.hidden) {
+                        text += `\n/${entry.command} - ${entry.description}`;
+                        total++;
+                    }
+                });
+                if (total == 1) {
+                    // Look like only the help command is registered
+                    text = 'There are no commands for this bot!';
+                }
+                message.reply(text, {});
             });
-            message.reply(text, {});
-        });
+        }
         this.getUpdates();
     };