[FEAT] adds help kwarg to commands

Author: carlos3g

src/commands/coin.js

@@ -1,6 +1,18 @@
 const axios = require('axios');
 const cheerio = require('cheerio');
 
+const STRINGS = {
+  help: `
+Retorna dados de uma moeda disponível no CoinMarketCap (https://coinmarketcap.com).
+
+*uso:* \`\`\`!coin [--args] coin_name\`\`\`
+
+*args válidos:* 
+  \`\`\`--all\`\`\` -> _retorna todos os dados disponíveis._
+  \`\`\`--help\`\`\` -> _mostra essa mensagem._
+  `.trim(),
+};
+
 async function loadCheerio(url) {
   try {
     const { data } = await axios.get(url);
@@ -13,8 +25,8 @@ async function loadCheerio(url) {
 async function getCoinStats(url) {
   const $ = await loadCheerio(url);
 
-  if (!(typeof $ === 'function')) {
-    return null;
+  if (typeof $ !== 'function') {
+    throw new Error('Moeda não encontrada.');
   }
 
   const priceStatistics = $('.sc-16r8icm-0.nds9rn-0.dAxhCK')
@@ -49,34 +61,38 @@ class Coin {
   constructor() {
     this.name = 'coin';
     this.BASE_URL = 'https://coinmarketcap.com/currencies/';
-    this.defaultMessage = `
-uso: *!coin* [--flag] name
-_--all -> mostra todas as informações disponiveis_  
-
-a flag _all_ pode retornar dados em excesso, sua utilização repetida será considera spam
-    `.trim();
+    this.strings = STRINGS;
   }
 
   async execute(data, message) {
     const { args, text } = data;
 
-    if (!text) {
-      message.reply(this.defaultMessage);
+    if (args.includes('help')) {
+      message.reply(this.strings.help, undefined, { linkPreview: false });
       return;
     }
 
     const url = this.getUrl(text);
     let coinStats = await getCoinStats(url);
 
-    if (!coinStats) {
-      message.reply('Moeda não encontrada.');
-      return;
-    }
-
     if (!args.includes('all')) {
       coinStats = coinStats.slice(0, 3);
     }
 
+    const output = Coin.formatStats(coinStats);
+    message.reply(output);
+  }
+
+  getUrl(text) {
+    if (!text) {
+      throw new Error('Nenhuma moeda foi passada.');
+    }
+
+    const path = text.replace(/\s/g, '-').toLowerCase();
+    return this.BASE_URL + path;
+  }
+
+  static formatStats(coinStats) {
     let output = '';
 
     coinStats.forEach((s) => {
@@ -85,12 +101,7 @@ a flag _all_ pode retornar dados em excesso, sua utilização repetida será con
       output += string;
     });
 
-    message.reply(output.trim());
-  }
-
-  getUrl(text) {
-    const path = text.replace(/\s/g, '-').toLowerCase();
-    return this.BASE_URL + path;
+    return output.trim();
   }
 }
 

src/commands/commands.js

@@ -1,7 +1,14 @@
-class Commands {
-  constructor() {
-    this.name = 'commands';
-    this.defaultMessage = `
+const STRINGS = {
+  help: `
+Lista todos os comandos disponíveis.
+
+*uso:* \`\`\`!commands [--args]\`\`\`
+
+*args válidos:* 
+  \`\`\`--help\`\`\` -> _mostra esta mensagem._
+  `.trim(),
+
+  availableCommands: `
 Os seguintes comandos estão disponiveis:
 - !bot
 - !coin
@@ -14,11 +21,24 @@ Os seguintes comandos estão disponiveis:
 - !search
 - !suggest
 - !wiki
-    `.trim();
+  `.trim(),
+};
+
+class Commands {
+  constructor() {
+    this.name = 'commands';
+    this.strings = STRINGS;
   }
 
-  execute(_, message) {
-    message.reply(this.defaultMessage);
+  execute(data, message) {
+    const { args } = data;
+
+    if (args.includes('help')) {
+      message.reply(this.strings.help);
+      return;
+    }
+
+    message.reply(this.strings.availableCommands);
   }
 }
 

src/commands/cron.js

@@ -1,6 +1,27 @@
 const events = require('events');
 const { chattools, Time } = require('../utils');
 
+const STRINGS = {
+  help: `
+Repete uma mensagem em um determinado período de tempo. Cada mensagem é representada por uma thread.
+
+*uso:* \`\`\`!cron --args [--kwargs=<type>] ...\`\`\`
+
+*args válidos:* 
+  \`\`\`--create\`\`\` -> _cria uma nova thread._
+  \`\`\`--destroy\`\`\` -> _para e apaga uma thread._
+  \`\`\`--stop\`\`\` -> _para uma thread._
+  \`\`\`--start\`\`\` -> _inicia uma thread._
+  \`\`\`--log\`\`\` -> _mostra as threads existentes._
+  \`\`\`--help\`\`\` -> _mostra esta mensagem._
+
+*kwargs válidos:*
+  \`\`\`--s=<int>\`\`\` -> _define um periodo em segundos._
+  \`\`\`--m=<int>\`\`\` -> _define um periodo em minutos._
+  \`\`\`--h=<int>\`\`\` -> _define um periodo em horas._
+  \`\`\`--d=<int>\`\`\` -> _define um periodo em dias._
+  `.trim(),
+};
 const emitter = new events.EventEmitter();
 
 function Thread(id, text, message, timer) {
@@ -22,35 +43,18 @@ class Cron {
     this.name = 'cron';
     this.threads = [];
     this.counter = 0;
-    this.defaultMessage = `
-Repete uma mensagem em um determinado período de tempo. Cada mensagem é representada por uma thread.
-
-*uso:* \`\`\`!command [--args] [--kwargs=<type>] ...\`\`\`
-
-*args válidos:* 
-  \`\`\`--create\`\`\` -> _cria uma nova thread._
-  \`\`\`--destroy\`\`\` -> _para e apaga uma thread._
-  \`\`\`--stop\`\`\` -> _para uma thread._
-  \`\`\`--start\`\`\` -> _inicia uma thread._
-  \`\`\`--log\`\`\` -> _mostra as threads existentes._
-
-*kwargs válidos:*
-  \`\`\`--s=<int>\`\`\` -> _define um periodo em segundos._
-  \`\`\`--m=<int>\`\`\` -> _define um periodo em minutos._
-  \`\`\`--h=<int>\`\`\` -> _define um periodo em horas._
-  \`\`\`--d=<int>\`\`\` -> _define um periodo em dias._
-`.trim();
+    this.strings = STRINGS;
   }
 
   async execute(data, message) {
     const isAdm = await chattools.isAdm(message);
 
-    if (isAdm) {
-      message.reply(this.runs(data, message));
+    if (!isAdm) {
+      message.reply('staff only.');
       return;
     }
 
-    message.reply('staff only.');
+    message.reply(this.runs(data, message));
   }
 
   create(data, message) {
@@ -127,13 +131,14 @@ Repete uma mensagem em um determinado período de tempo. Cada mensagem é repres
       destroy: () => this.destroy(data.text),
       start: () => this.start(data.text),
       stop: () => this.stop(data.text),
+      help: () => this.strings.help,
     };
 
     if (methods[data.args[0]]) {
       return methods[data.args[0]]();
     }
 
-    return this.defaultMessage;
+    throw new Error('Nenhum arg válido foi passado.');
   }
 
   isIdValid(id) {

src/commands/links.js

@@ -1,7 +1,14 @@
-class Links {
-  constructor() {
-    this.name = 'links';
-    this.defaultMessage = `
+const STRINGS = {
+  help: `
+Lista links para os grupos coding.
+
+*uso:* \`\`\`!links [--args]\`\`\`
+
+*args válidos:* 
+  \`\`\`--help\`\`\` -> _mostra esta mensagem._
+  `.trim(),
+
+  groupsLinks: `
 Coding in python: 
 https://chat.whatsapp.com/I4IpHC0YFPQLUcGHJeqYdF
 
@@ -25,11 +32,24 @@ https://chat.whatsapp.com/GOXnIXSXEFH7wHvO9aTuFs
 
 Speaking in English:
 https://chat.whatsapp.com/EOirNapuFe3CVunBqbwj1Z
-    `.trim();
+  `.trim(),
+};
+
+class Links {
+  constructor() {
+    this.name = 'links';
+    this.strings = STRINGS;
   }
 
-  execute(_, message) {
-    message.reply(this.defaultMessage);
+  execute(data, message) {
+    const { args } = data;
+
+    if (args.includes('help')) {
+      message.reply(this.strings.help);
+      return;
+    }
+
+    message.reply(this.strings.groupsLinks);
   }
 }
 

src/commands/lyric.js

@@ -2,6 +2,17 @@ const axios = require('axios');
 const JSSoup = require('jssoup').default;
 const { search } = require('../utils');
 
+const STRINGS = {
+  help: `
+Retorna a letra de uma música.
+
+*uso:* \`\`\`!lyric [--args] music_name\`\`\`
+
+*args válidos:* 
+  \`\`\`--help\`\`\` -> _mostra esta mensagem._
+  `.trim(),
+};
+
 async function makeSoup(url) {
   const { data } = await axios.get(url);
   return new JSSoup(data);
@@ -20,11 +31,17 @@ function removeBr(raw) {
 class Lyric {
   constructor() {
     this.name = 'lyric';
+    this.strings = STRINGS;
   }
 
   // eslint-disable-next-line
   async execute(data, message) {
-    const { text } = data;
+    const { text, args } = data;
+
+    if (args.includes('help')) {
+      message.reply(this.strings.help);
+      return;
+    }
 
     if (!text) {
       throw new Error('Nenhum nome foi passado');

src/commands/report.js

@@ -1,14 +1,16 @@
 const { chattools } = require('../utils');
 
-const strings = {
-  defaultMessage: `
-uso: _!report [--flag] [descrição]_
+const STRINGS = {
+  help: `
+Reporte problemas no bot ou um usuário.
 
-argumentos:
-  _--bug  descreva um problema no bot_
-  _--user  denuncie um usuário_ 
+*uso:* \`\`\`!report --args ...\`\`\`
 
-⚠️ *o uso indevido dessa função resultará em ban de 3 dias* ⚠️`,
+*args válidos:* 
+  \`\`\`--bug\`\`\` -> _reporta um bug._
+  \`\`\`--user\`\`\` -> reporta um usuário._
+  \`\`\`--help\`\`\` -> _mostra esta mensagem._
+`.trim(),
   bug: 'sua solicitação será analisada. caso confirmada, abriremos uma issue',
   user: 'o usuário foi reportado a administração',
 };
@@ -17,13 +19,18 @@ class Report {
   constructor() {
     this.name = 'report';
     this.reportID = chattools.userID(process.env.REPORT_NUMBER);
-    this.strings = strings;
+    this.strings = STRINGS;
   }
 
   execute(data, message, client) {
     const { args, text } = data;
     const reportMsg = `⚠️ *${args[0]} report* ⚠️\n\n${text}`;
 
+    if (args.includes('help')) {
+      message.reply(this.strings.help);
+      return;
+    }
+
     if (args.length === 0 && text) {
       throw new Error('Nenhuma flag foi fornecida.');
     }
@@ -37,7 +44,7 @@ class Report {
       return;
     }
 
-    message.reply(this.strings.defaultMessage.trim());
+    throw new Error('Nenhum arg válido foi passado.');
   }
 }
 

src/commands/search.js

@@ -1,13 +1,29 @@
 const { search } = require('../utils');
 
+const STRINGS = {
+  help: `
+Retorna o primeiro resultado de uma pesquisa no google.
+
+*uso:* \`\`\`!cron [--args] ...\`\`\`
+
+*args válidos:*
+  \`\`\`--help\`\`\` -> _mostra esta mensagem._
+  `.trim(),
+};
+
 class Search {
   constructor() {
     this.name = 'search';
+    this.strings = STRINGS;
   }
 
-  // eslint-disable-next-line
   async execute(data, message) {
-    const { text } = data;
+    const { args, text } = data;
+
+    if (args.includes('help')) {
+      message.reply(this.strings.help);
+      return;
+    }
 
     if (!text) {
       throw new Error('Nenhum texto para pesquisa foi especificado.');