Added jsdoc to some files

+ some minor refactoring

Author: faizanakram99

.gitignore

@@ -1,4 +1,5 @@
 node_modules
-data/*
+data/
 config.json
-.env
+.env
+.idea/

handlers/middlewares/leaveUnmanaged.js

@@ -23,16 +23,23 @@ const inline_keyboard = [ [ {
 
 const reply_markup = JSON.stringify({ inline_keyboard });
 
-const gifs = [
-	'https://media.giphy.com/media/xTk9ZBWrma4PIC9y4E/giphy.gif',
-	'https://media.giphy.com/media/l2Sqc3POpzkj5r8SQ/giphy.gif',
-	'https://media.giphy.com/media/StaMzjNkq5PqM/giphy.gif',
-	'https://media.giphy.com/media/fjYDN5flDJ756/giphy.gif',
-	'https://media.giphy.com/media/3XiQswSmbjBiU/giphy.gif',
-];
+const gifIds = ['xTk9ZBWrma4PIC9y4E', 'l2Sqc3POpzkj5r8SQ', 'StaMzjNkq5PqM', 'fjYDN5flDJ756', '3XiQswSmbjBiU' ];
 
+const gifs = gifIds.map(x => `https://media.giphy.com/media/${x}/giphy.gif`);
+
+
+/**
+ * @param {Array} [arr] An anonymous array
+ * @returns {Number} A random number
+ */
 const randomChoice = arr => arr[Math.floor(Math.random() * arr.length)];
 
+
+/**
+ * @param {TelegrafContext} ctx
+ * @param {Function} next
+ * @returns {Promise.<*>}
+ */
 const leaveUnmanagedHandler = async (ctx, next) => {
 	if (ctx.chat.type === 'private' || await managesGroup(ctx.chat)) {
 		return next();

index.js

@@ -4,43 +4,66 @@
 const { deleteAfter } = require('./utils/tg');
 const { logError } = require('./utils/log');
 
-// Bot
+/**
+ * @type {Telegraf}
+ * Bot
+ */
 const bot = require('./bot');
 
 bot.telegram.getMe().then((botInfo) => {
 	bot.options.username = botInfo.username;
 });
 
-// Middleware Handlers
-const leaveUnmanagedHandler = require('./handlers/middlewares/leaveUnmanaged');
-const removeCommandsHandler = require('./handlers/middlewares/removeCommands');
-const kickBannedHandler = require('./handlers/middlewares/kickBanned');
-const addUserHandler = require('./handlers/middlewares/addUser');
-const removeLinksHandler = require('./handlers/middlewares/removeLinks');
-const checkUsernameHandler = require('./handlers/middlewares/checkUsername');
-const addCustomCmdHandler = require('./handlers/middlewares/addCustomCmd');
-const runCustomCmdHandler = require('./handlers/middlewares/runCustomCmd');
-const antibotHandler = require('./handlers/middlewares/antibot');
-const addedToGroupHandler = require('./handlers/middlewares/addedToGroup');
 
-// Commmands Handlers
-const adminHandler = require('./handlers/commands/admin');
-const unAdminHandler = require('./handlers/commands/unadmin');
-const leaveCommandHandler = require('./handlers/commands/leave');
-const warnHandler = require('./handlers/commands/warn');
-const unwarnHandler = require('./handlers/commands/unwarn');
-const nowarnsHandler = require('./handlers/commands/nowarns');
-const getWarnsHandler = require('./handlers/commands/getwarns');
-const banHandler = require('./handlers/commands/ban');
-const unbanHandler = require('./handlers/commands/unban');
-const reportHandler = require('./handlers/commands/report');
-const staffHandler = require('./handlers/commands/staff');
-const linkHandler = require('./handlers/commands/link');
-const groupsHandler = require('./handlers/commands/groups');
-const commandReferenceHandler = require('./handlers/commands/commands');
-const addCommandHandler = require('./handlers/commands/addCommand');
-const removeCommandHandler = require('./handlers/commands/removeCommand');
-const helpHandler = require('./handlers/commands/help');
+/**
+ * @type {number}
+ * Time in milliseconds after which join and leave messages should be deleted
+ */
+const delTimeout = 2 * 60 * 1000;
+
+/**
+ * @type {string}
+ * Path of middlewares and commands
+ */
+const middleware = './handlers/middlewares',
+      command = './handlers/commands';
+
+/**
+ * @type {function}
+ * Middleware Handlers
+ */
+const leaveUnmanagedHandler = require(`${middleware}/leaveUnmanaged`),
+	  removeCommandsHandler = require(`${middleware}/removeCommands`),
+	  kickBannedHandler = require(`${middleware}/kickBanned`),
+	  addUserHandler = require(`${middleware}/addUser`),
+	  removeLinksHandler = require(`${middleware}/removeLinks`),
+	  checkUsernameHandler = require(`${middleware}/checkUsername`),
+	  addCustomCmdHandler = require(`${middleware}/addCustomCmd`),
+	  runCustomCmdHandler = require(`${middleware}/runCustomCmd`),
+	  antibotHandler = require(`${middleware}/antibot`),
+	  addedToGroupHandler = require(`${middleware}/addedToGroup`);
+
+/**
+ * @type {function}
+ * Commmands Handlers
+ */
+const adminHandler = require(`${command}/admin`),
+	  unAdminHandler = require(`${command}/unadmin`),
+	  leaveCommandHandler = require(`${command}/leave`),
+	  warnHandler = require(`${command}/warn`),
+	  unwarnHandler = require(`${command}/unwarn`),
+	  nowarnsHandler = require(`${command}/nowarns`),
+	  getWarnsHandler = require(`${command}/getwarns`),
+	  banHandler = require(`${command}/ban`),
+	  unbanHandler = require(`${command}/unban`),
+	  reportHandler = require(`${command}/report`),
+	  staffHandler = require(`${command}/staff`),
+	  linkHandler = require(`${command}/link`),
+	  groupsHandler = require(`${command}/groups`),
+	  commandReferenceHandler = require(`${command}/commands`),
+	  addCommandHandler = require(`${command}/addCommand`),
+	  removeCommandHandler = require(`${command}/removeCommand`),
+	  helpHandler = require(`${command}/help`);
 
 bot.on('new_chat_members', addedToGroupHandler);
 bot.use(leaveUnmanagedHandler);
@@ -52,7 +75,7 @@ bot.on('message', checkUsernameHandler);
 bot.on('message', addCustomCmdHandler);
 bot.on('message', runCustomCmdHandler);
 bot.on('new_chat_members', antibotHandler);
-bot.on([ 'new_chat_members', 'left_chat_member' ], deleteAfter(2 * 60 * 1000));
+bot.on([ 'new_chat_members', 'left_chat_member' ], deleteAfter(delTimeout));
 bot.command('admin', adminHandler);
 bot.command('unadmin', unAdminHandler);
 bot.command('leave', leaveCommandHandler);

package-lock.json

@@ -2,8 +2,16 @@
 
 const { inspect } = require('util');
 
+/**
+ * @param {Error} err
+ * Logs errors to console
+ */
 const logError = err => console.error(err);
 
+/**
+ * @param {Object} value
+ * Echos the value of a value.
+ */
 const print = value =>
 	console.log(inspect(value, { colors: true, depth: null }));
 

utils/log.js

@@ -6,6 +6,11 @@ const escapeHtml = s => s
 const link = ({ id, first_name }) =>
 	`<a href="tg://user?id=${id}">${escapeHtml(first_name)}</a>`;
 
+/**
+ * @param {number} ms
+ * Deletes messages after (ms) milliseconds
+ * @returns {undefined}
+ */
 const deleteAfter = ms => ctx =>
 	setTimeout(() =>
 		ctx.telegram.deleteMessage(ctx.chat.id, ctx.message.message_id),