removed Babel, added possibility to be run from a submodule directory

TimeWaster · TimeWaster · commit 7c4fea293b43 · 2021-05-25T21:36:33.000+02:00
diff --git a/.babelrc b/.babelrc
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,30 @@
+# Changelog
+
+## 1.1.0 (2021-05-25)
+
+### Release Highlights
+
+Added the possibility to include HomarusBot into an existing GIT project via GIT submodules, follow the instructions in [README.md](README.md).
+
+### Features
+
+- Added support to be run as a GIT submodule
+- Removed Babel due to configuration problems, this introduces a breaking change in imports/exports
+
+### Bugfixes
+
+- Removed unused code
+
+## 1.0.0 (2021-05-23)
+
+### Release Highlights
+
+This is the initial release.
+
+### Features
+
+- Pattern matching engine based on the Discord.js "message" and "messageDelete" events
+
+### Bugfixes
+
+-
diff --git a/README.md b/README.md
@@ -84,3 +84,17 @@ cd /home/directory/you/want/HomarusBot
 npm update
 ./start.sh
 ```
+
+## Including HomarusBot in your own GIT repository
+
+It is possible to add HomarusBot to your GIT project without forking it, in a directory you see fit in your project run:
+
+```bash
+git submodule add git@github.com:SebiTimeWaster/HomarusBot.git
+```
+
+This adds HomarusBot as a subdirectory with its own .git configuration/namespace.
+
+Now copy the `rules` directory and the `config.js` from the `HomarusBot` directory one directory above and start to change/use it, it is part of your repository.
+
+You still need to run the `npm install` and other commands from the HomarusBot directory itself, but you can easily write scripts to do that for you.
diff --git a/config.js b/config.js
@@ -1,11 +1,13 @@
-// General configuration
-export default {
+const config = {
+    // General configuration
     botToken: '', // the discord bot token
     commandPrefix: '!', // the prefix used for commands defined in the rule files
-    adminChannelID: '', // the channel where administrative messages (responses.admin) will be sent to
+    adminChannelID: '', // the channel where administrative messages (responses.admin) will be sent to (Optional)
     rules: {
         // which rule files should be loaded on startup. order is important and as a rule of thumb it should be: policing, commands, everything else
         message: ['policing', 'help', 'various'],
         messageDelete: [],
     },
 };
+
+module.exports = config;
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "HomarusBot",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "description": "A reaction Bot for Discord Servers running on NodeJS",
     "author": "TimeWaster",
     "license": "Unlicense",
@@ -10,18 +10,14 @@
     },
     "main": "src/server.js",
     "scripts": {
-        "run": "npx babel-node src/server.js",
-        "run-dev": "nodemon --exec babel-node src/server.js",
-        "run-dev-test": "nodemon --exec babel-node src/test.js"
+        "run": "npx src/server.js",
+        "run-dev": "nodemon --watch ../ src/server.js",
+        "changelog": "git log --pretty='- %s'"
     },
     "dependencies": {
         "discord.js": "^12.5.3"
     },
     "devDependencies": {
-        "@babel/cli": "^7.13.16",
-        "@babel/core": "^7.14.2",
-        "@babel/node": "^7.14.2",
-        "@babel/preset-env": "^7.14.2",
         "nodemon": "^2.0.7"
     }
 }
diff --git a/rules/README.md b/rules/README.md
@@ -17,13 +17,13 @@ The rules name (In the example above 'daily-quote') must be added to the rules A
 A rule file must contain one or more rules in the following format:
 
 ```js
-export default [{ ruleConfiguration }, { ruleConfiguration }];
+module.exports = [{ ruleConfiguration }, { ruleConfiguration }];
 ```
 
 or
 
 ```js
-export default { ruleConfiguration };
+module.exports = { ruleConfiguration };
 ```
 
 ## Rule configuration
@@ -83,8 +83,8 @@ The rule configuration Object literal can contain the following properties (All
  *                                                      This behaviour differs from the emojis added as reactions!
  * @property {(object|object[])} [error]            - Sends a message if the user is not allowed to use the rule due to channel or role restrictions, works exactly the same as the "normal" property
  * @property {(object|object[])} [admin]            - Sends a message to the admin channel as specified in "adminChannelID" in config.js, works exactly the same as the "normal" property
- * @property {boolean}           [normalIsPM=false] - If the normal message should be sent as a private message
- * @property {boolean}           [errorIsPM=false]  - If the error message should be sent as a private message
+ * @property {boolean}           [normalIsPM=false] - If the normal message should be sent as a private message instead
+ * @property {boolean}           [errorIsPM=false]  - If the error message should be sent as a private message instead
  */
 ```
 
diff --git a/rules/message.help.js b/rules/message.help.js
@@ -1,5 +1,5 @@
 // shows help to the user
-export default {
+module.exports = {
     keywords: ['\\!help'],
     startsWith: true,
     responses: {
@@ -16,6 +16,10 @@ export default {
                     { name: 'good night', value: 'Answers "Sleep tight!"' },
                     { name: 'haha', value: 'Adds an Emoji reaction to the users message' },
                     { name: '!avatar', value: 'Responds with the users avatar image' },
+                    {
+                        name: '"keyword1", "keyword2", "keyword3"',
+                        value: 'Responds with a random message',
+                    },
                     { name: '!help', value: 'Answers with this message' },
                 ],
             },
diff --git a/rules/message.policing.js b/rules/message.policing.js
@@ -1,5 +1,5 @@
 // police speech example
-export default {
+module.exports = {
     keywords: ['testword1', 'testword2', 'testword3'],
     wordBounds: false,
     deleteMessage: true,
diff --git a/rules/message.various.js b/rules/message.various.js
@@ -1,8 +1,17 @@
 // various small response examples
-export default [
+module.exports = [
     { keywords: ['ping'], responses: { normal: { content: 'pong' } }, dontStopChecking: true },
     { keywords: ['ping pong'], responses: { normal: { content: 'what?' } } },
     { keywords: ['good night'], responses: { normal: { content: 'Sleep tight!' } } },
     { keywords: ['haha'], reactions: ['😄'] },
     { keywords: ['\\!avatar'], startsWith: true, responses: (message) => ({ normal: { content: message.author.displayAvatarURL() } }) },
+    {
+        keywords: ['keyword1', 'keyword2', 'keyword3'],
+        responses: (message) => {
+            const responses = ['Response1: :smile: %userMention%.', 'Response2: %keyword%? Awesome!', 'Response3: Live is beautiful.'];
+            const randNum = Math.floor(Math.random() * responses.length);
+
+            return { normal: { content: responses[randNum] } };
+        },
+    },
 ];
diff --git a/src/handlers/MessageHandler.js b/src/handlers/MessageHandler.js
@@ -1,4 +1,4 @@
-import { log, getOptParam } from '../utils/index.js';
+const { log, getOptParam } = require('../utils/');
 
 class MessageHandler {
     constructor(config, messageObj) {
@@ -105,4 +105,4 @@ class MessageHandler {
     }
 }
 
-export default MessageHandler;
+module.exports = MessageHandler;
diff --git a/src/handlers/index.js b/src/handlers/index.js
@@ -1 +1 @@
-export { default as MessageHandler } from './message.js';
+module.exports.MessageHandler = require('./MessageHandler.js');
diff --git a/src/server.js b/src/server.js
@@ -1,18 +1,19 @@
-import fs from 'fs';
-import Discord from 'discord.js';
-import { log } from './utils/index.js';
-import { MessageHandler } from './handlers/index.js';
-import config from '../config.js';
+const fs = require('fs');
+const Discord = require('discord.js');
+const { log } = require('./utils/');
+const { MessageHandler } = require('./handlers/');
+const config = require('../../config') || require('../config');
 
 const loadRules = (ruleNames, eventName) => {
     let rules = [];
 
     ruleNames.forEach((ruleName) => {
-        const rule = require(`../rules/${eventName}.${ruleName}.js`).default;
+        const rulePath = `../rules/${eventName}.${ruleName}.js`;
+        const rule = require(`../${rulePath}`) || require(rulePath);
 
         if (Array.isArray(rule)) rules.push(...rule);
         else if (typeof rule === 'object') rules.push(rule);
-        else throw `Error: Unknown error loading rule file "/rules/${eventName}.${ruleName}.js"`;
+        else throw `Error: Unknown error loading rule file "./rules/${eventName}.${ruleName}.js"`;
     });
 
     return { rules };
@@ -24,11 +25,10 @@ try {
     const client = new Discord.Client();
 
     client.once('ready', log('The bot is up and running!', 0));
-
     if (messageConfig.rules.length) client.on('message', (messageObj) => new MessageHandler(messageConfig, messageObj).handle());
     if (messageDeleteConfig.rules.length) client.on('messageDelete', (messageObj) => new MessageHandler(messageDeleteConfig, messageObj).handle());
 
-    client.login(config.botToken);
+    client.login(config.botToken).catch(console.error);
 } catch (e) {
     console.error(e);
 }
diff --git a/src/utils/getOptParam.js b/src/utils/getOptParam.js
@@ -1 +1,3 @@
-export default (param, def) => (param !== undefined ? param : def);
+const getOptParam = (param, def) => (param !== undefined ? param : def);
+
+module.exports = getOptParam;
diff --git a/src/utils/index.js b/src/utils/index.js
@@ -1,2 +1,2 @@
-export { default as log } from './log.js';
-export { default as getOptParam } from './getOptParam.js';
+module.exports.log = require('./log.js');
+module.exports.getOptParam = require('./getOptParam.js');
diff --git a/src/utils/log.js b/src/utils/log.js
@@ -1,8 +1,10 @@
 const verbosity = process.env.VERBOSITY || 0;
 
-export default (message, level) => () => {
+const log = (message, level) => () => {
     const nf = '2-digit';
     const date = new Intl.DateTimeFormat('en-GB', { timeZone: 'UTC', year: 'numeric', month: nf, day: nf, hour: nf, minute: nf, second: nf }).format(new Date());
 
     if (level <= verbosity) console.log(level < 2 ? `[${date}]` : '    ', message.replace('\n', ''));
 };
+
+module.exports = log;
