commandkit 0.1.2 → 0.1.3

package/README.md

@@ -5,11 +5,11 @@
 
 # CommandKit
 
-CommandKit is a library that makes it easy to handle commands (+ validations), and events in your Discord.js projects.
+CommandKit is a library that makes it easy to handle commands and events in your Discord.js projects.
 
 **Supports Discord.js version 14**
 
-# Features
+## Features
 
 -   Very beginner friendly 🚀
 -   Support for slash and context menu commands ✅
@@ -18,11 +18,11 @@ CommandKit is a library that makes it easy to handle commands (+ validations), a
 -   Supports multiple users as bot developers 👥
 -   Object oriented 💻
 
-# Documentation
+## Documentation
 
-You can find the full documentation [here](https://commandkit.underctrl.io)
+You can find the full documentation [here](https://commandkit.js.org)
 
-# Installation
+## Installation
 
 [![npm](https://nodei.co/npm/commandkit.png)](https://nodei.co/npm/commandkit/)
 
@@ -54,9 +54,11 @@ To install the development version of CommandKit, run the following command:
 npm install underctrl-io/commandkit#dev-build
 ```
 
-# Usage
+> ⚠️ The development version is likely to have bugs.
 
-This is a simple overview of how to set up this library with all the options. You can read more in the [full documentation](https://commandkit.underctrl.io)
+## Usage
+
+This is a simple overview of how to set up this library with all the options. You can read more in the [full documentation](https://commandkit.js.org)
 
 ```js
 // index.js

package/dist/index.d.mts

@@ -75,12 +75,20 @@ type CommandObject = Omit<CommandFileObject, 'run'>;
 declare class CommandKit {
     #private;
     constructor({ ...options }: CommandKitOptions);
-    /**
-     * Returns all the commands that CommandKit is handling.
-     *
-     * @returns An array of command objects
-     */
+    /** @returns An array of objects of all the commands that CommandKit is handling. */
     get commands(): CommandObject[];
+    /** @returns The path to the commands folder which was set when instantiating CommandKit. */
+    get commandsPath(): string | undefined;
+    /** @returns The path to the events folder which was set when instantiating CommandKit. */
+    get eventsPath(): string | undefined;
+    /** @returns The path to the validations folder which was set when instantiating CommandKit. */
+    get validationsPath(): string | undefined;
+    /** @returns An array of all the developer user IDs which was set when instantiating CommandKit. */
+    get devUserIds(): string[];
+    /** @returns An array of all the developer guild IDs which was set when instantiating CommandKit. */
+    get devGuildIds(): string[];
+    /** @returns An array of all the developer role IDs which was set when instantiating CommandKit. */
+    get devRoleIds(): string[];
 }
 
 export { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, SlashCommandProps, ValidationFunctionProps };

package/dist/index.d.ts

@@ -75,12 +75,20 @@ type CommandObject = Omit<CommandFileObject, 'run'>;
 declare class CommandKit {
     #private;
     constructor({ ...options }: CommandKitOptions);
-    /**
-     * Returns all the commands that CommandKit is handling.
-     *
-     * @returns An array of command objects
-     */
+    /** @returns An array of objects of all the commands that CommandKit is handling. */
     get commands(): CommandObject[];
+    /** @returns The path to the commands folder which was set when instantiating CommandKit. */
+    get commandsPath(): string | undefined;
+    /** @returns The path to the events folder which was set when instantiating CommandKit. */
+    get eventsPath(): string | undefined;
+    /** @returns The path to the validations folder which was set when instantiating CommandKit. */
+    get validationsPath(): string | undefined;
+    /** @returns An array of all the developer user IDs which was set when instantiating CommandKit. */
+    get devUserIds(): string[];
+    /** @returns An array of all the developer guild IDs which was set when instantiating CommandKit. */
+    get devGuildIds(): string[];
+    /** @returns An array of all the developer role IDs which was set when instantiating CommandKit. */
+    get devRoleIds(): string[];
 }
 
 export { CommandData, CommandKit, CommandObject, CommandOptions, CommandProps, CommandType, ContextMenuCommandProps, SlashCommandProps, ValidationFunctionProps };

package/dist/index.js

@@ -632,11 +632,7 @@ var CommandKit = class {
       this.#data.commands = commandHandler.commands;
     }
   }
-  /**
-   * Returns all the commands that CommandKit is handling.
-   *
-   * @returns An array of command objects
-   */
+  /** @returns An array of objects of all the commands that CommandKit is handling. */
   get commands() {
     const commands = this.#data.commands.map((cmd) => {
       const { run, ...command } = cmd;
@@ -644,6 +640,30 @@ var CommandKit = class {
     });
     return commands;
   }
+  /** @returns The path to the commands folder which was set when instantiating CommandKit. */
+  get commandsPath() {
+    return this.#data.commandsPath;
+  }
+  /** @returns The path to the events folder which was set when instantiating CommandKit. */
+  get eventsPath() {
+    return this.#data.eventsPath;
+  }
+  /** @returns The path to the validations folder which was set when instantiating CommandKit. */
+  get validationsPath() {
+    return this.#data.validationsPath;
+  }
+  /** @returns An array of all the developer user IDs which was set when instantiating CommandKit. */
+  get devUserIds() {
+    return this.#data.devUserIds || [];
+  }
+  /** @returns An array of all the developer guild IDs which was set when instantiating CommandKit. */
+  get devGuildIds() {
+    return this.#data.devGuildIds || [];
+  }
+  /** @returns An array of all the developer role IDs which was set when instantiating CommandKit. */
+  get devRoleIds() {
+    return this.#data.devRoleIds || [];
+  }
 };
 
 // src/types/index.ts

package/dist/index.mjs

@@ -595,11 +595,7 @@ var CommandKit = class {
       this.#data.commands = commandHandler.commands;
     }
   }
-  /**
-   * Returns all the commands that CommandKit is handling.
-   *
-   * @returns An array of command objects
-   */
+  /** @returns An array of objects of all the commands that CommandKit is handling. */
   get commands() {
     const commands = this.#data.commands.map((cmd) => {
       const { run, ...command } = cmd;
@@ -607,6 +603,30 @@ var CommandKit = class {
     });
     return commands;
   }
+  /** @returns The path to the commands folder which was set when instantiating CommandKit. */
+  get commandsPath() {
+    return this.#data.commandsPath;
+  }
+  /** @returns The path to the events folder which was set when instantiating CommandKit. */
+  get eventsPath() {
+    return this.#data.eventsPath;
+  }
+  /** @returns The path to the validations folder which was set when instantiating CommandKit. */
+  get validationsPath() {
+    return this.#data.validationsPath;
+  }
+  /** @returns An array of all the developer user IDs which was set when instantiating CommandKit. */
+  get devUserIds() {
+    return this.#data.devUserIds || [];
+  }
+  /** @returns An array of all the developer guild IDs which was set when instantiating CommandKit. */
+  get devGuildIds() {
+    return this.#data.devGuildIds || [];
+  }
+  /** @returns An array of all the developer role IDs which was set when instantiating CommandKit. */
+  get devRoleIds() {
+    return this.#data.devRoleIds || [];
+  }
 };
 
 // src/types/index.ts

package/package.json

@@ -1,6 +1,7 @@
 {
     "name": "commandkit",
-    "version": "0.1.2",
+    "description": "Beginner friendly command & event handler for Discord.js",
+    "version": "0.1.3",
     "license": "MIT",
     "main": "./dist/index.js",
     "module": "./dist/index.mjs",