create-reciple 8.4.3 → 8.4.4

package/README.md

@@ -1,46 +1,46 @@
-<h1 align="center">
-    <img src="https://i.imgur.com/DWM0tJL.png" width="50%">
-    <br>
-</h1>
-
-<h3 align="center">
-    <a href="https://discord.gg/kajdev-1032785824686817291">
-        <img src="https://img.shields.io/discord/1032785824686817291?color=5865F2&logo=discord&logoColor=white">
-    </a>
-    <a href="https://npmjs.org/package/create-reciple">
-        <img src="https://img.shields.io/npm/v/create-reciple?label=npm">
-    </a>
-    <a href="https://github.com/thenorthsolution/Reciple/tree/main/packages/create-reciple">
-        <img src="https://img.shields.io/npm/dt/create-reciple?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>
-    <br>
-    <div style="padding-top: 1rem">
-        <a href="https://discord.gg/kajdev-1032785824686817291">
-            <img src="https://discord.com/api/guilds/1032785824686817291/embed.png?style=banner2">
-        </a>
-    </div>
-</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/kajdev-1032785824686817291">
+        <img src="https://img.shields.io/discord/1032785824686817291?color=5865F2&logo=discord&logoColor=white">
+    </a>
+    <a href="https://npmjs.org/package/create-reciple">
+        <img src="https://img.shields.io/npm/v/create-reciple?label=npm">
+    </a>
+    <a href="https://github.com/thenorthsolution/Reciple/tree/main/packages/create-reciple">
+        <img src="https://img.shields.io/npm/dt/create-reciple?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>
+    <br>
+    <div style="padding-top: 1rem">
+        <a href="https://discord.gg/kajdev-1032785824686817291">
+            <img src="https://discord.com/api/guilds/1032785824686817291/embed.png?style=banner2">
+        </a>
+    </div>
+</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,190 +1,190 @@
-# Reciple App
-
-Reciple is a Discord.js command handler framework that just works :3
-
-> This application is generated by [`create-reciple`](https://npm.im/create-reciple).
-
-## Configuration
-
-Configuration file is set to `./reciple.mjs` or `./reciple.cjs` by default on the CLI.
-
-> To change the config path, simply add the `-c, --config <path>` flag
-
-## Module System
-
-With Reciple a module can be a command, event, or anything. Reciple scans the dirs given from the config and loads every valid javascript files in that folder.
-
-### File Structure
-
-```js
-// Module config (reciple.mjs)
-export const config = {
-    // other things
-    modules: {
-        dirs: ['./modules'], // scans the modules folder
-        exclude: [],
-        filter: file => true,
-        disableModuleVersionCheck: false
-    },
-    // other things
-};
-```
-
-```
-> Folder structure
-
-reciple.mjs
-package.json
-node_modules/
-modules/
-├─ module1.js
-├─ module2.js
-```
-
-You can also use a glob pattern for your dir config.
-
-```js
-// Module config (reciple.mjs)
-export const config = {
-    // other things
-    modules: {
-        dirs: ['./modules/**/*'], // scans the modules folder and every folders in it recursively
-        exclude: [],
-        filter: file => true,
-        disableModuleVersionCheck: false
-    },
-    // other things
-};
-```
-
-```
-> Folder structure
-
-reciple.mjs
-package.json
-node_modules/
-modules/
-├─ module1.js
-├─ module2.js
-├─anotherFolder/
-    ├─ module1.js
-    ├─ module2.js
-```
-
-### Module Structure
-
-Reciple can load CommonJs and ESM modules at the same time.
-
-#### Valid File Types
-- `.js`
-- `.cjs`
-- `.mjs`
-
-#### Module Files
-
-```js
-// ESM
-export default {
-    versions: ['^8'],
-    onStart: async ({ client }) => true, // Always return true if the module is loaded
-    onLoad: async ({ client }) => {},
-    onUnload: async ({ client }) => {}
-};
-
-// CJS
-module.exports = {
-    versions: ['^8'],
-    onStart: async ({ client }) => true, // Always return true if the module is loaded
-    onLoad: async ({ client }) => {},
-    onUnload: async ({ client }) => {}
-};
-```
-
-**Modules Using Classes**
-```js
-
-// ESM
-export class MyModule {
-    versions = ['^8'];
-
-    async onStart({ client }) {
-        return true; // Always return true if the module is loaded
-    }
-
-    async onLoad({ client }) {}
-    async onUnload({ client }) {}
-};
-
-export default new MyModule();
-
-// CJS
-class MyModule {
-    versions = ['^8'];
-
-    async onStart({ client }) {
-        return true; // Always return true if the module is loaded
-    }
-
-    async onLoad({ client }) {}
-    async onUnload({ client }) {}
-};
-
-module.exports = new MyModule();
-```
-
-## Adding Commands
-
-To add commands to your module, simply add `commands` propery to your module.
-
-```js
-export default {
-    versions: ['^8'],
-    commands: [], // Commands goes here
-    onStart: async ({ client }) => true, // Always return true if the module is loaded
-    onLoad: async ({ client }) => {},
-    onUnload: async ({ client }) => {}
-};
-```
-
-Instead of importing command builders from Discord.js, use the command builders provided by Reciple.
-
-```diff
-// ESM
-- import { ContextMenuCommandBuilder, SlashCommandBuilder } from 'discord.js';
-+ import { ContextMenuCommandBuilder, SlashCommandBuilder } from 'reciple';
-```
-
-```diff
-// CJS
-- const { ContextMenuCommandBuilder, SlashCommandBuilder } = require('discord.js');
-+ const { ContextMenuCommandBuilder, SlashCommandBuilder } = require('reciple');
-```
-
-Just create a new instance of a command builder in the commands array to add commands to a module.
-
-```js
-import { ContextMenuCommandBuilder, MessageCommandBuilder, SlashCommandBuilder } from 'reciple';
-
-export default {
-    versions: ['^8'],
-    commands: [
-        new ContextMenuCommandBuilder()
-            .setName('To Lowercase')
-            .setType('Message')
-            .setExecute(async ({ interaction }) => interaction.reply(interaction.targetMessage.content.toLowercase())),
-        new MessageCommandBuilder()
-            .setName('hi')
-            .setDescript('Say hello')
-            .setExecute(async ({ message }) => message.reply('hello')),
-        new SlashCommandBuilder()
-            .setName('hello')
-            .setDescript('Say hi')
-            .setExecute(async ({ interaction }) => interaction.reply('hi'))
-    ],
-    onStart: async ({ client }) => true, // Always return true if the module is loaded
-    onLoad: async ({ client }) => {},
-    onUnload: async ({ client }) => {}
-};
-```
-
-[**Read The Docs**](https://reciple.js.org/docs)
+# Reciple App
+
+Reciple is a Discord.js command handler framework that just works :3
+
+> This application is generated by [`create-reciple`](https://npm.im/create-reciple).
+
+## Configuration
+
+Configuration file is set to `./reciple.mjs` or `./reciple.cjs` by default on the CLI.
+
+> To change the config path, simply add the `-c, --config <path>` flag
+
+## Module System
+
+With Reciple a module can be a command, event, or anything. Reciple scans the dirs given from the config and loads every valid javascript files in that folder.
+
+### File Structure
+
+```js
+// Module config (reciple.mjs)
+export const config = {
+    // other things
+    modules: {
+        dirs: ['./modules'], // scans the modules folder
+        exclude: [],
+        filter: file => true,
+        disableModuleVersionCheck: false
+    },
+    // other things
+};
+```
+
+```
+> Folder structure
+
+reciple.mjs
+package.json
+node_modules/
+modules/
+├─ module1.js
+├─ module2.js
+```
+
+You can also use a glob pattern for your dir config.
+
+```js
+// Module config (reciple.mjs)
+export const config = {
+    // other things
+    modules: {
+        dirs: ['./modules/**/*'], // scans the modules folder and every folders in it recursively
+        exclude: [],
+        filter: file => true,
+        disableModuleVersionCheck: false
+    },
+    // other things
+};
+```
+
+```
+> Folder structure
+
+reciple.mjs
+package.json
+node_modules/
+modules/
+├─ module1.js
+├─ module2.js
+├─anotherFolder/
+    ├─ module1.js
+    ├─ module2.js
+```
+
+### Module Structure
+
+Reciple can load CommonJs and ESM modules at the same time.
+
+#### Valid File Types
+- `.js`
+- `.cjs`
+- `.mjs`
+
+#### Module Files
+
+```js
+// ESM
+export default {
+    versions: ['^8'],
+    onStart: async ({ client }) => true, // Always return true if the module is loaded
+    onLoad: async ({ client }) => {},
+    onUnload: async ({ client }) => {}
+};
+
+// CJS
+module.exports = {
+    versions: ['^8'],
+    onStart: async ({ client }) => true, // Always return true if the module is loaded
+    onLoad: async ({ client }) => {},
+    onUnload: async ({ client }) => {}
+};
+```
+
+**Modules Using Classes**
+```js
+
+// ESM
+export class MyModule {
+    versions = ['^8'];
+
+    async onStart({ client }) {
+        return true; // Always return true if the module is loaded
+    }
+
+    async onLoad({ client }) {}
+    async onUnload({ client }) {}
+};
+
+export default new MyModule();
+
+// CJS
+class MyModule {
+    versions = ['^8'];
+
+    async onStart({ client }) {
+        return true; // Always return true if the module is loaded
+    }
+
+    async onLoad({ client }) {}
+    async onUnload({ client }) {}
+};
+
+module.exports = new MyModule();
+```
+
+## Adding Commands
+
+To add commands to your module, simply add `commands` propery to your module.
+
+```js
+export default {
+    versions: ['^8'],
+    commands: [], // Commands goes here
+    onStart: async ({ client }) => true, // Always return true if the module is loaded
+    onLoad: async ({ client }) => {},
+    onUnload: async ({ client }) => {}
+};
+```
+
+Instead of importing command builders from Discord.js, use the command builders provided by Reciple.
+
+```diff
+// ESM
+- import { ContextMenuCommandBuilder, SlashCommandBuilder } from 'discord.js';
++ import { ContextMenuCommandBuilder, SlashCommandBuilder } from 'reciple';
+```
+
+```diff
+// CJS
+- const { ContextMenuCommandBuilder, SlashCommandBuilder } = require('discord.js');
++ const { ContextMenuCommandBuilder, SlashCommandBuilder } = require('reciple');
+```
+
+Just create a new instance of a command builder in the commands array to add commands to a module.
+
+```js
+import { ContextMenuCommandBuilder, MessageCommandBuilder, SlashCommandBuilder } from 'reciple';
+
+export default {
+    versions: ['^8'],
+    commands: [
+        new ContextMenuCommandBuilder()
+            .setName('To Lowercase')
+            .setType('Message')
+            .setExecute(async ({ interaction }) => interaction.reply(interaction.targetMessage.content.toLowercase())),
+        new MessageCommandBuilder()
+            .setName('hi')
+            .setDescript('Say hello')
+            .setExecute(async ({ message }) => message.reply('hello')),
+        new SlashCommandBuilder()
+            .setName('hello')
+            .setDescript('Say hi')
+            .setExecute(async ({ interaction }) => interaction.reply('hi'))
+    ],
+    onStart: async ({ client }) => true, // Always return true if the module is loaded
+    onLoad: async ({ client }) => {},
+    onUnload: async ({ client }) => {}
+};
+```
+
+[**Read The Docs**](https://reciple.js.org/docs)

package/package.json

@@ -2,7 +2,7 @@
   "name": "create-reciple",
   "description": "A Reciple Discord bot project builder",
   "license": "GPL-3.0",
-  "version": "8.4.3",
+  "version": "8.4.4",
   "type": "module",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -36,13 +36,13 @@
     "fallout-utility": "^2.8.0"
   },
   "devDependencies": {
-    "@reciple/core": "^8.2.3",
+    "@reciple/core": "^8.2.4",
     "@types/node": "^20.9.0",
     "discord.js": "^14.14.1",
     "nodemon": "^3.0.1",
-    "reciple": "^8.2.3",
+    "reciple": "^8.2.4",
     "rimraf": "^5.0.5",
     "typescript": "^5.2.2"
   },
-  "gitHead": "a2e837166e79924c5b11f5181975f6c86b017492"
+  "gitHead": "a590b5c96c25dba68cb592c1c931cefefce9a2cb"
 }