create-reciple 7.11.10 → 7.11.12

package/README.md

@@ -1,35 +1,38 @@
-<h1 align="center">
-    <img src="https://i.imgur.com/DWM0tJL.png" width="50%">
-    <br>
-</h1>
-
-<h3 align="center">
-    <a href="https://npmjs.org/package/reciple">
-        <img src="https://img.shields.io/npm/v/reciple?label=latest%20npm%20release%20">
-    </a>
-    <a href="https://github.com/FalloutStudios/Reciple/blob/main/LICENSE">
-        <img src="https://img.shields.io/github/license/FalloutStudios/Reciple">
-    </a>
-    <a href="https://www.codefactor.io/repository/github/falloutstudios/reciple/overview/main">
-        <img src="https://www.codefactor.io/repository/github/falloutstudios/reciple/badge/main">
-    </a>
-</h3>
-
-## About
-
-`create-reciple` is a tool used to easily create Reciple projects.
-
-## Installation
-
-```bash
-npm create reciple@latest
-yarn create reciple@latest
-pnpm create reciple@latest
-```
-
-## Templates
-- Javascript (CommonJS)
-- Javascript (ES Modules)
-- Typescript (CommonJS)
-- Typescript (ES Modules)
-
+<h1 align="center">
+    <img src="https://i.imgur.com/DWM0tJL.png" width="50%">
+    <br>
+</h1>
+
+<h3 align="center">
+    <a href="https://discord.gg/VzP8qW7Z8d">
+        <img src="https://img.shields.io/discord/993105237000855592?color=5865F2&logo=discord&logoColor=white">
+    </a>
+    <a href="https://npmjs.org/package/reciple">
+        <img src="https://img.shields.io/npm/v/reciple?label=npm">
+    </a>
+    <a href="https://github.com/FalloutStudios/Reciple/blob/main/LICENSE">
+        <img src="https://img.shields.io/npm/dt/reciple.svg?maxAge=3600">
+    </a>
+    <a href="https://www.codefactor.io/repository/github/falloutstudios/reciple/overview/main">
+        <img src="https://www.codefactor.io/repository/github/falloutstudios/reciple/badge/main">
+    </a>
+</h3>
+
+## About
+
+`create-reciple` is a tool used to easily create Reciple projects.
+
+## Installation
+
+```bash
+npm create reciple@latest
+yarn create reciple@latest
+pnpm create reciple@latest
+```
+
+## Templates
+- Javascript (CommonJS)
+- Javascript (ES Modules)
+- Typescript (CommonJS)
+- Typescript (ES Modules)
+

package/assets/README.md

@@ -1,257 +1,257 @@
-# Reciple
-
-Reciple is a discord.js command handler framework that just works.
-
-## Reciple Modules
-
-- Reciple scans the directory assigned in `reciple.yml` under `modules.modulesFolders` property.
-- `modules.modulesFolders` can be the path of the folder of modules or glob pattern
-
-### Folder Structure
-
-##### Example Structure
-```yml
-# Modules config
-
-modules:
-  modulesFolders:
-    - './modules' # Scans the modules folder for module files
-```
-
-```
-# Dir structure
-
-modules/
-├─ Module1.js
-├─ Module2.js
-```
-
-##### Example Structure with Glob patterns
-```yml
-# Modules config
-
-modules:
-  modulesFolders:
-    - './modules' # Scans the modules folder for module files
-    - './modules/*' # Scans the folders of modules folder for module files
-```
-
-```
-# Dir structure
-
-modules/
-├─ moreModules/
-│  ├─ Module1.js
-│  ├─ Module2.js
-├─ Module3.js
-├─ Module4.js
-```
-
-### Module Structure
-
-Module files can be ES Modules or CommonJs.
-
-##### Supported module file types
-
-- `.js` *This can be an ESM or CJS*
-- `.mjs`
-- `.cjs`
-
-#### Module file structure
-
-- [RecipleModuleScript](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript)
-
-#### ESM module example
-
-```js
-// Usage without classes
-
-export default {
-    versions: '^7',
-    onStart: async client => {
-        return true;
-    },
-    onLoad: async client => {},
-    onUnload: async ({ client }) => {}
-};
-```
-```js
-// Usage with classes
-
-export class MyModule {
-    versions = '^7';
-    commands = [];
-
-    async onStart(client) {
-        return true;
-    }
-
-    async onLoad(client) {}
-    async onUnload(unloadData) {}
-}
-
-export default new MyModule();
-```
-
-#### CommonJS module example
-
-```js
-// Usage without classes
-
-module.exports = {
-    versions: '^7',
-    onStart: async client => {
-        return true;
-    },
-    onLoad: async client => {},
-    onUnload: async ({ client }) => {}
-};
-```
-```js
-// Usage with classes
-
-class MyModule {
-    versions = '^7';
-    commands = [];
-
-    async onStart(client) {
-        return true;
-    }
-
-    async onLoad(client) {}
-    async onUnload(unloadData) {}
-}
-
-module.exports = new MyModule();
-```
-
-## Reciple Commands
-
-instead of importing builders from `discord.js`, import command builders from `reciple` or `@reciple/client`.
-
-```diff
-- const { SlashCommandBuilder, ContextMenuCommandBuilder } = require('discord.js');
-- import { SlashCommandBuilder, ContextMenuCommandBuilder } from 'discord.js';
-+ const { SlashCommandBuilder, ContextMenuCommandBuilder } = require('reciple');
-+ import { SlashCommandBuilder, ContextMenuCommandBuilder } from 'reciple';
-```
-
-You can add your commands in the commands property of your module script.
-
-```js
-export default {
-    versions: '^7',
-    commands: [
-        new SlashCommandBuilder()
-            .setName('ping')
-            .setDescription('Just a ping command')
-            .setExecute(async ({ interaction }) => {
-                await interaction.reply('Pong');
-            })
-    ],
-    onStart: async client => {
-        return true;
-    }
-};
-```
-
-### Interaction command execute params
-
-- [ContextMenuCommandExecuteData](https://reciple.js.org/docs/client/main/typedefs/ContextMenuCommandExecuteData)
-- [SlashCommandExecuteData](https://reciple.js.org/docs/client/main/typedefs/SlashCommandExecuteData)
-
-### Message command execute params
-
-- [MessageCommandExecuteData](https://reciple.js.org/docs/client/main/typedefs/MessageCommandExecuteData)
-
-### Handling command execute errors
-
-Command halt function can handle command cooldown and errors. Return `true` if the error or cooldown is handled.
-
-```js
-new SlashCommandBuilder()
-    .setName('ping')
-    .setDescription('Just a ping command')
-    .setExecute(async ({ interaction }) => {
-        await interaction.reply('Pong');
-    })
-    .setHalt(async haltData => {
-        switch (haltData.reason) {
-            case CommandHaltReason.Cooldown:
-                await haltData.executeData.interaction.followUp(`You've been cooled-down`);
-                return true;
-            case CommandHaltReason.Error:
-                await haltData.executeData.interaction.followUp('An error occured');
-                return true;
-        }
-
-        // The rest is unhandled
-    })
-```
-
-### Using command preconditions
-
-Command preconditions are executed after the command is received and before executing the command's execute function.
-
-#### Module command preconditions
-
-You can define a precondition for all commands of a module.
-
-##### Valid module precondition methods
-
-- [Context meny command preconditions](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript#contextMenuCommandPrecondition)
-- [Message command preconditions](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript#messageCommandPrecondition)
-- [Slash command preconditions](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript#slashCommandPrecondition)
-
-```js
-// Example module with slash commands precondition
-export default {
-    versions: '^7',
-    commands: [
-        new SlashCommandBuilder()
-            .setName('ping')
-            .setDescription('Just a ping command')
-            .setExecute(async ({ interaction }) => {
-                await interaction.reply('Pong');
-            })
-    ],
-    onStart: async client => true,
-
-    // creates a slash command precondition
-    slashCommandPrecondition: async (({ interaction })) => {
-        return !interaction.inCachedGuild() || interaction.guild.ownerId !== interaction.user.id; // Command can only be executed by the guild owner
-    }
-};
-```
-
-#### Global command preconditions
-
-Global preconditions are added to all commands along with the existing module preconditions.
-
-##### Set & Get global preconditions
-- [CommandManager#setGlobalPrecondition](https://reciple.js.org/docs/client/main/classes/CommandManager#setGlobalPrecondition)
-- [CommandManager#getGlobalPrecondition](https://reciple.js.org/docs/client/main/classes/CommandManager#getGlobalPrecondition)
-
-```js
-// Example module with global slash commands precondition
-export default {
-    versions: '^7',
-    commands: [
-        new SlashCommandBuilder()
-            .setName('ping')
-            .setDescription('Just a ping command')
-            .setExecute(async ({ interaction }) => {
-                await interaction.reply('Pong');
-            })
-    ],
-    onStart: async client => true,
-    onLoad: async client => {
-        client.commands.setGlobalPrecondition(
-            CommandType.SlashCommand,
-            async ({ interaction }) => {
-                return interaction.inCachedGuild(); // All slash commands can only be executed if in cached guild
-            }
-        );
-    }
-};
-```
+## Reciple App
+
+This application is generated from [`create-reciple`](https://npm.im/create-reciple) templates. Reciple is a [Discord.js](https://discord.js.org) command handler framework that just works.
+
+## Reciple Modules
+
+- Reciple scans the directory assigned in `reciple.yml` under `modules.modulesFolders` property.
+- `modules.modulesFolders` can be the path of the folder of modules or glob pattern
+
+### Folder Structure
+
+##### Example Structure
+```yml
+# Modules config
+
+modules:
+  modulesFolders:
+    - './modules' # Scans the modules folder for module files
+```
+
+```
+# Dir structure
+
+modules/
+├─ Module1.js
+├─ Module2.js
+```
+
+##### Example Structure with Glob patterns
+```yml
+# Modules config
+
+modules:
+  modulesFolders:
+    - './modules' # Scans the modules folder for module files
+    - './modules/*' # Scans the folders of modules folder for module files
+```
+
+```
+# Dir structure
+
+modules/
+├─ moreModules/
+│  ├─ Module1.js
+│  ├─ Module2.js
+├─ Module3.js
+├─ Module4.js
+```
+
+### Module Structure
+
+Module files can be ES Modules or CommonJs.
+
+##### Supported module file types
+
+- `.js` *This can be an ESM or CJS*
+- `.mjs`
+- `.cjs`
+
+#### Module file structure
+
+- [RecipleModuleScript](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript)
+
+#### ESM module example
+
+```js
+// Usage without classes
+
+export default {
+    versions: '^7',
+    onStart: async client => {
+        return true;
+    },
+    onLoad: async client => {},
+    onUnload: async ({ client }) => {}
+};
+```
+```js
+// Usage with classes
+
+export class MyModule {
+    versions = '^7';
+    commands = [];
+
+    async onStart(client) {
+        return true;
+    }
+
+    async onLoad(client) {}
+    async onUnload(unloadData) {}
+}
+
+export default new MyModule();
+```
+
+#### CommonJS module example
+
+```js
+// Usage without classes
+
+module.exports = {
+    versions: '^7',
+    onStart: async client => {
+        return true;
+    },
+    onLoad: async client => {},
+    onUnload: async ({ client }) => {}
+};
+```
+```js
+// Usage with classes
+
+class MyModule {
+    versions = '^7';
+    commands = [];
+
+    async onStart(client) {
+        return true;
+    }
+
+    async onLoad(client) {}
+    async onUnload(unloadData) {}
+}
+
+module.exports = new MyModule();
+```
+
+## Reciple Commands
+
+instead of importing builders from `discord.js`, import command builders from `reciple` or `@reciple/client`.
+
+```diff
+- const { SlashCommandBuilder, ContextMenuCommandBuilder } = require('discord.js');
+- import { SlashCommandBuilder, ContextMenuCommandBuilder } from 'discord.js';
++ const { SlashCommandBuilder, ContextMenuCommandBuilder } = require('reciple');
++ import { SlashCommandBuilder, ContextMenuCommandBuilder } from 'reciple';
+```
+
+You can add your commands in the commands property of your module script.
+
+```js
+export default {
+    versions: '^7',
+    commands: [
+        new SlashCommandBuilder()
+            .setName('ping')
+            .setDescription('Just a ping command')
+            .setExecute(async ({ interaction }) => {
+                await interaction.reply('Pong');
+            })
+    ],
+    onStart: async client => {
+        return true;
+    }
+};
+```
+
+### Interaction command execute params
+
+- [ContextMenuCommandExecuteData](https://reciple.js.org/docs/client/main/typedefs/ContextMenuCommandExecuteData)
+- [SlashCommandExecuteData](https://reciple.js.org/docs/client/main/typedefs/SlashCommandExecuteData)
+
+### Message command execute params
+
+- [MessageCommandExecuteData](https://reciple.js.org/docs/client/main/typedefs/MessageCommandExecuteData)
+
+### Handling command execute errors
+
+Command halt function can handle command cooldown and errors. Return `true` if the error or cooldown is handled.
+
+```js
+new SlashCommandBuilder()
+    .setName('ping')
+    .setDescription('Just a ping command')
+    .setExecute(async ({ interaction }) => {
+        await interaction.reply('Pong');
+    })
+    .setHalt(async haltData => {
+        switch (haltData.reason) {
+            case CommandHaltReason.Cooldown:
+                await haltData.executeData.interaction.followUp(`You've been cooled-down`);
+                return true;
+            case CommandHaltReason.Error:
+                await haltData.executeData.interaction.followUp('An error occured');
+                return true;
+        }
+
+        // The rest is unhandled
+    })
+```
+
+### Using command preconditions
+
+Command preconditions are executed after the command is received and before executing the command's execute function.
+
+#### Module command preconditions
+
+You can define a precondition for all commands of a module.
+
+##### Valid module precondition methods
+
+- [Context meny command preconditions](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript#contextMenuCommandPrecondition)
+- [Message command preconditions](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript#messageCommandPrecondition)
+- [Slash command preconditions](https://reciple.js.org/docs/client/main/typedefs/RecipleModuleScript#slashCommandPrecondition)
+
+```js
+// Example module with slash commands precondition
+export default {
+    versions: '^7',
+    commands: [
+        new SlashCommandBuilder()
+            .setName('ping')
+            .setDescription('Just a ping command')
+            .setExecute(async ({ interaction }) => {
+                await interaction.reply('Pong');
+            })
+    ],
+    onStart: async client => true,
+
+    // creates a slash command precondition
+    slashCommandPrecondition: async (({ interaction })) => {
+        return !interaction.inCachedGuild() || interaction.guild.ownerId !== interaction.user.id; // Command can only be executed by the guild owner
+    }
+};
+```
+
+#### Global command preconditions
+
+Global preconditions are added to all commands along with the existing module preconditions.
+
+##### Set & Get global preconditions
+- [CommandManager#setGlobalPrecondition](https://reciple.js.org/docs/client/main/classes/CommandManager#setGlobalPrecondition)
+- [CommandManager#getGlobalPrecondition](https://reciple.js.org/docs/client/main/classes/CommandManager#getGlobalPrecondition)
+
+```js
+// Example module with global slash commands precondition
+export default {
+    versions: '^7',
+    commands: [
+        new SlashCommandBuilder()
+            .setName('ping')
+            .setDescription('Just a ping command')
+            .setExecute(async ({ interaction }) => {
+                await interaction.reply('Pong');
+            })
+    ],
+    onStart: async client => true,
+    onLoad: async client => {
+        client.commands.setGlobalPrecondition(
+            CommandType.SlashCommand,
+            async ({ interaction }) => {
+                return interaction.inCachedGuild(); // All slash commands can only be executed if in cached guild
+            }
+        );
+    }
+};
+```

package/package.json

@@ -2,7 +2,7 @@
   "name": "create-reciple",
   "description": "A Reciple Discord bot project builder",
   "license": "GPL-3.0",
-  "version": "7.11.10",
+  "version": "7.11.12",
   "type": "module",
   "types": "./bin/bin.d.ts",
   "bin": "./bin/bin.js",
@@ -32,9 +32,9 @@
     "@types/node": "^20.4.8",
     "discord.js": "^14.12.1",
     "nodemon": "^3.0.1",
-    "reciple": "^7.9.8",
+    "reciple": "^7.9.9",
     "rimraf": "^5.0.1",
     "typescript": "^5.1.6"
   },
-  "gitHead": "6a2b6ed078f1996bf5716512a1495a265ae86ef2"
+  "gitHead": "7c302a789085d8c27a3265eade530d07d2565f78"
 }

package/templates/javascript/package.json

@@ -3,7 +3,7 @@
   "private": true,
   "scripts": {
     "start": "reciple",
-    "dev": "nodemon --ext js,mjs,cjs,json,yml,yaml --exec \"SCRIPT_RUN start\" --signal SIGHUP"
+    "dev": "nodemon --ext js,mjs,cjs,json,yml,yaml --exec \"reciple\" --signal SIGHUP"
   },
   "dependencies": {
     "discord.js": "DISCORDJS",

package/templates/javascript-esm/package.json

@@ -4,7 +4,7 @@
   "type": "module",
   "scripts": {
     "start": "reciple",
-    "dev": "nodemon --ext js,mjs,cjs,json,yml,yaml --exec \"SCRIPT_RUN start\" --signal SIGHUP"
+    "dev": "nodemon --ext js,mjs,cjs,json,yml,yaml --exec \"reciple\" --signal SIGHUP"
   },
   "dependencies": {
     "discord.js": "DISCORDJS",

package/templates/typescript/package.json

@@ -1,20 +1,20 @@
-{
-  "name": "reciple-app",
-  "private": true,
-  "scripts": {
-    "build": "rimraf ./modules && tsc",
-    "start": "reciple",
-    "build:start": "SCRIPT_RUN build && reciple",
-    "dev": "nodemon --ext ts,mts,cts,json,yml,yaml --ignore ./modules --exec \"SCRIPT_RUN build && reciple\" --signal SIGHUP"
-  },
-  "dependencies": {
-    "discord.js": "DISCORDJS",
-    "reciple": "RECIPLE"
-  },
-  "devDependencies": {
-    "@types/node": "TYPES_NODE",
-    "nodemon": "NODEMON",
-    "typescript": "TYPESCRIPT",
-    "rimraf": "RIMRAF"
-  }
+{
+  "name": "reciple-app",
+  "private": true,
+  "scripts": {
+    "build": "rimraf ./modules && tsc",
+    "start": "reciple",
+    "build:start": "SCRIPT_RUN build && reciple",
+    "dev": "nodemon --ext ts,mts,cts,json,yml,yaml --ignore ./modules --exec \"SCRIPT_RUN build && reciple\" --signal SIGHUP"
+  },
+  "dependencies": {
+    "discord.js": "DISCORDJS",
+    "reciple": "RECIPLE"
+  },
+  "devDependencies": {
+    "@types/node": "TYPES_NODE",
+    "nodemon": "NODEMON",
+    "typescript": "TYPESCRIPT",
+    "rimraf": "RIMRAF"
+  }
 }

package/templates/typescript-esm/package.json

@@ -1,21 +1,21 @@
-{
-  "name": "reciple-app",
-  "private": true,
-  "type": "module",
-  "scripts": {
-    "build": "rimraf ./modules && tsc",
-    "start": "reciple",
-    "build:start": "SCRIPT_RUN build && reciple",
-    "dev": "nodemon --ext ts,mts,cts,json,yml,yaml --ignore ./modules --exec \"SCRIPT_RUN build && reciple\" --signal SIGHUP"
-  },
-  "dependencies": {
-    "discord.js": "DISCORDJS",
-    "reciple": "RECIPLE"
-  },
-  "devDependencies": {
-    "@types/node": "TYPES_NODE",
-    "nodemon": "NODEMON",
-    "typescript": "TYPESCRIPT",
-    "rimraf": "RIMRAF"
-  }
+{
+  "name": "reciple-app",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "build": "rimraf ./modules && tsc",
+    "start": "reciple",
+    "build:start": "SCRIPT_RUN build && reciple",
+    "dev": "nodemon --ext ts,mts,cts,json,yml,yaml --ignore ./modules --exec \"SCRIPT_RUN build && reciple\" --signal SIGHUP"
+  },
+  "dependencies": {
+    "discord.js": "DISCORDJS",
+    "reciple": "RECIPLE"
+  },
+  "devDependencies": {
+    "@types/node": "TYPES_NODE",
+    "nodemon": "NODEMON",
+    "typescript": "TYPESCRIPT",
+    "rimraf": "RIMRAF"
+  }
 }