bug fixes, prefix updates, added enable state to modules, updated tests

The ability to use multiple prefix's as been removed as its unneeded.

As for modules, every module type has an enabled state that can be set, thus no longer requiring to make the file end with .disabled or something similar.

Various bug fixes, typos, etc.

Author: Zendrex

src/index.d.ts

@@ -481,6 +481,7 @@ declare module 'discord-akairo' {
 
     export interface AkairoModuleOptions {
         category?: string;
+        enabled?: boolean;
     }
 
     export interface AkairoOptions {

src/struct/AkairoHandler.js

@@ -99,7 +99,7 @@ class AkairoHandler extends EventEmitter {
     }
 
     /**
-     * Deregisters a module.
+     * De-registers a module.
      * @param {AkairoModule} mod - Module to use.
      * @returns {void}
      */
@@ -136,9 +136,15 @@ class AkairoHandler extends EventEmitter {
 
         if (this.modules.has(mod.id)) throw new AkairoError('ALREADY_LOADED', this.classToHandle.name, mod.id);
 
-        this.register(mod, isClass ? null : thing);
-        this.emit(AkairoHandlerEvents.LOAD, mod, isReload);
-        return mod;
+
+        if (mod.enabled) {
+            this.register(mod, isClass ? null : thing);
+            this.emit(AkairoHandlerEvents.LOAD, mod, isReload);
+            return mod;
+        } else {
+            this.emit(AkairoHandlerEvents.DISABLED, mod, isReload);
+            return null;
+        }
     }
 
     /**

src/struct/AkairoModule.js

@@ -4,13 +4,19 @@
  * @param {AkairoModuleOptions} [options={}] - Options.
  */
 class AkairoModule {
-    constructor(id, { category = 'default' } = {}) {
+    constructor(id, { category = 'default', enabled = true } = {}) {
         /**
          * ID of the module.
          * @type {string}
          */
         this.id = id;
 
+        /**
+         * Determines if module is enabled.
+         * @type {boolean}
+         */
+        this.enabled = enabled;
+
         /**
          * ID of the category this belongs to.
          * @type {string}

src/struct/ClientUtil.js

@@ -360,7 +360,7 @@ class ClientUtil {
     }
 
     /**
-     * Combination of `<Client>.fetchUser()` and `<Guild>.fetchMember()`.
+     * Combination of `<Client>.users.fetch()` and `<Guild>.members.fetch()`.
      * @param {Guild} guild - Guild to fetch in.
      * @param {string} id - ID of the user.
      * @param {boolean} cache - Whether or not to add to cache.

src/struct/commands/Command.js

@@ -12,7 +12,7 @@ const ContentParser = require('./ContentParser');
  */
 class Command extends AkairoModule {
     constructor(id, options = {}) {
-        super(id, { category: options.category });
+        super(id, { category: options.category, enabled: options.enabled });
 
         const {
             aliases = [],

src/struct/commands/CommandHandler.js

@@ -56,7 +56,7 @@ class CommandHandler extends AkairoHandler {
         this.resolver = new TypeResolver(this);
 
         /**
-         * Collecion of command aliases.
+         * Collection of command aliases.
          * @type {Collection<string, string>}
          */
         this.aliases = new Collection();
@@ -191,7 +191,7 @@ class CommandHandler extends AkairoHandler {
          * The prefix(es) for command parsing.
          * @type {string|string[]|PrefixSupplier}
          */
-        this.prefix = typeof prefix === 'function' ? prefix.bind(this) : prefix;
+        this.prefix = typeof prefix === 'function' ? prefix.bind(this)() : prefix;
 
         /**
          * Whether or not mentions are allowed for prefixing.
@@ -294,7 +294,7 @@ class CommandHandler extends AkairoHandler {
     }
 
     /**
-     * Deregisters a module.
+     * De-registers a module.
      * @param {Command} command - Module to use.
      * @returns {void}
      */

src/struct/inhibitors/Inhibitor.js

@@ -12,9 +12,10 @@ class Inhibitor extends AkairoModule {
         category,
         reason = '',
         type = 'post',
-        priority = 0
+        priority = 0,
+        enabled
     } = {}) {
-        super(id, { category });
+        super(id, { category, enabled });
 
         /**
          * Reason emitted when command is inhibited.

src/struct/listeners/Listener.js

@@ -12,9 +12,10 @@ class Listener extends AkairoModule {
         category,
         emitter,
         event,
-        type = 'on'
+        type = 'on',
+        enabled
     } = {}) {
-        super(id, { category });
+        super(id, { category, enabled });
 
         /**
          * The event emitter.

src/util/Constants.js

@@ -61,7 +61,8 @@ module.exports = {
     },
     AkairoHandlerEvents: {
         LOAD: 'load',
-        REMOVE: 'remove'
+        REMOVE: 'remove',
+        DISABLED: 'disabled'
     },
     CommandHandlerEvents: {
         MESSAGE_BLOCKED: 'messageBlocked',
@@ -82,5 +83,7 @@ module.exports = {
         OWNER: 'owner',
         GUILD: 'guild',
         DM: 'dm'
+            value: 1
+        }
     }
 };

test/commands/enabled.js

@@ -0,0 +1,18 @@
+/* eslint-disable no-console */
+
+const { Command } = require('../..');
+const sleep = require('util').promisify(setTimeout);
+
+class LockCommand extends Command {
+    constructor() {
+        super('enabled', {
+            enabled: false
+        });
+    }
+
+    exec(message) {
+        return [0, 1, 2, 3, 4].reduce((promise, num) => promise.then(() => sleep(1000)).then(() => message.util.send(num)), Promise.resolve());
+    }
+}
+
+module.exports = LockCommand;

test/listeners/disabled.js

@@ -0,0 +1,19 @@
+/* eslint-disable no-console */
+
+const { Listener } = require('../..');
+
+class DisabledCommandListener extends Listener {
+    constructor() {
+        super('command-load', {
+            emitter: 'commandHandler',
+            event: 'disabled',
+            category: 'commandHandler'
+        });
+    }
+
+    exec(command) {
+        console.log(`Command disabled: ${command.id}`);
+    }
+}
+
+module.exports = DisabledCommandListener;

test/struct/TestClient.js

@@ -1,5 +1,6 @@
 const { AkairoClient, CommandHandler, InhibitorHandler, ListenerHandler, SQLiteProvider } = require('../../src/index');
 const sqlite = require('sqlite');
+const sqlite3 = require('sqlite3');
 
 class TestClient extends AkairoClient {
     constructor() {
@@ -11,7 +12,7 @@ class TestClient extends AkairoClient {
             directory: './test/commands/',
             ignoreCooldownID: ['132266422679240704'],
             aliasReplacement: /-/g,
-            prefix: '!!',
+            prefix: '!',
             allowMention: true,
             commandUtil: true,
             commandUtilLifetime: 10000,
@@ -33,17 +34,22 @@ class TestClient extends AkairoClient {
             }
         });
 
-        this.inhibitorHandler = new InhibitorHandler(this, {
-            directory: './test/inhibitors/'
-        });
-
         this.listenerHandler = new ListenerHandler(this, {
             directory: './test/listeners/'
         });
 
-        const db = sqlite.open('./test/db.sqlite')
+        this.inhibitorHandler = new InhibitorHandler(this, {
+            directory: './test/inhibitors/'
+        });
+
+        const db = sqlite.open({
+            filename: './test/db.sqlite',
+            driver: sqlite3.Database
+        })
             .then(d => d.run('CREATE TABLE IF NOT EXISTS guilds (id TEXT NOT NULL UNIQUE, settings TEXT)').then(() => d));
-        this.settings = new SQLiteProvider(db, 'guilds', { dataColumn: 'settings' });
+        this.settings = new SQLiteProvider(db, 'guilds', {
+            dataColumn: 'settings'
+        });
 
         this.setup();
     }
@@ -58,9 +64,9 @@ class TestClient extends AkairoClient {
             listenerHandler: this.listenerHandler
         });
 
+        this.listenerHandler.loadAll();
         this.commandHandler.loadAll();
         this.inhibitorHandler.loadAll();
-        this.listenerHandler.loadAll();
 
         const resolver = this.commandHandler.resolver;
         resolver.addType('1-10', (message, phrase) => {