Replace old handler with SlashCommandBuilder and amongst other improvements

Author: NTMNathan

.eslintignore

@@ -0,0 +1 @@
+node_modules/

.eslintrc.js

@@ -0,0 +1,50 @@
+module.exports = {
+	root: true,
+	extends: 'eslint:recommended',
+	env: {
+		node: true,
+		es6: true,
+	},
+	parserOptions: {
+		ecmaVersion: 2021,
+	},
+	rules: {
+		'arrow-spacing': ['warn', { 'before': true, 'after': true }],
+		'brace-style': ['error', 'stroustrup', { 'allowSingleLine': true }],
+		'comma-dangle': ['error', 'always-multiline'],
+		'comma-spacing': 'error',
+		'comma-style': 'error',
+		'curly': ['error', 'multi-line', 'consistent'],
+		'dot-location': ['error', 'property'],
+		'handle-callback-err': 'off',
+		'indent': ['error', 'tab'],
+		'keyword-spacing': 'error',
+		'max-nested-callbacks': ['error', { 'max': 4 }],
+		'max-statements-per-line': ['error', { 'max': 2 }],
+		'no-console': 'off',
+		'no-empty-function': 'error',
+		'no-floating-decimal': 'error',
+		'no-inline-comments': 'error',
+		'no-lonely-if': 'error',
+		'no-multi-spaces': 'error',
+		'no-multiple-empty-lines': ['error', { 'max': 2, 'maxEOF': 1, 'maxBOF': 0 }],
+		'no-shadow': ['error', { 'allow': ['err', 'resolve', 'reject'] }],
+		'no-trailing-spaces': ['error'],
+		'no-var': 'error',
+		'object-curly-spacing': ['error', 'always'],
+		'prefer-const': 'error',
+		'quotes': ['error', 'single'],
+		'semi': ['error', 'always'],
+		'space-before-blocks': 'error',
+		'space-before-function-paren': ['error', {
+			'anonymous': 'never',
+			'named': 'never',
+			'asyncArrow': 'always',
+		}],
+		'space-in-parens': 'error',
+		'space-infix-ops': 'error',
+		'space-unary-ops': 'error',
+		'spaced-comment': 'error',
+		'yoda': 'error',
+	},
+};

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "00:00"
+    timezone: America/Los_Angeles
+  versioning-strategy: increase

.github/workflows/node.js.yml

@@ -1,6 +1,3 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
 name: Node.js CI
 
 on:
@@ -17,7 +14,6 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
-        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
 
     steps:
     - uses: actions/checkout@v2

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Nate
+Copyright (c) 2022 Nate
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,11 +1,8 @@
 # Discord Command Handler
-A Discord.js Command Handler example using Slash Commands and Context Menus.
+A Discord.js Command Class Handler example using Slash Commands and Context Menus.
 
 ## Features
 - 🖱 Using Classes
-- 👀 Examples for Top Level, Sub Commands and Sub Command Groups
-- 🔐 Examples for Permissions
-- 👍 Automated Command Creation System
 - ✅ Easy to setup
 - 💻 Stable and 99.9% Bug Free
 
@@ -40,31 +37,24 @@ node index
 ```
 
 ## Usage
-### Commands
-This bot is designed to create and handle application commands automatically on start-up (using the `ready` event) which means you do not need to keep manually `set`ting and deploying commands. 
-> There is a `clear` command which can let you clear all of the commands easily.
 
-
-Also, the bot will only create commands for the server, so if you want to have application commands created globally; Replace the following line in `handler/Command.js`:
-
-```js
-this.client.guilds.cache.get(YOUR_SERVER_ID).create(cmd);
+To create commands, you need to run the following command in the console:
+```bash
+npm run deploy
 ```
-with
 
-```js
-this.client.application.commands.create(cmd);
-```
-> NOTE: You may need to wait an hour for the commands to create. 200 Global Command Creations per day is the limit.
+These will create a new set of commands in the server.
+
+> NOTE: You may need to wait an hour for the commands to create. 200 Command Creates per day is the limit.
 
 **Command Folder Structure:**
-- `context` folder contains the Context Menu commands. Change the `type` property to either `USER` or `MESSAGE` to specify the type of context menu. **`description`** must be `null` (using `contextDescription` instead) and `options` must have an empty array `[]`.
-- `general` and other folders are slash commands. The `CHAT_INPUT` type must be used to specify the slash command.
+- `context` folder contains the Context Menu commands.
+- `general` and other folders are slash commands.
 
 ### Permissions
-Using the `defaultPermission` boolean in your command file, this will determine the permissions for both the Slash and Context Menu commands when the bot starts up (through the `ready` event). The bot may require another restart for it to work properly (even after commands are created).
+Using the `setdefaultPermission` boolean in your command file, this will determine the permissions for both the Slash and Context Menu commands when the bot starts up (through the `ready` event). The bot may require another restart for it to work properly (even after commands are created).
 
-> Read more about Application Command Permissions [here](https://discordjs.guide/interactions/slash-command-permissions.html)!
+> Read more about Slash Command Permissions [here](https://discordjs.guide/creating-your-bot/command-handling.html#command-handling)!
 
 **Examples:**
 ```js
@@ -95,10 +85,10 @@ await r.permissions.set({ permissions });
 - `false`: Means that the command will only be available to be select users and roles.
 
 ## 📚 Guides
-- [Registering Slash Commands](https://discordjs.guide/interactions/registering-slash-commands.html)
-- [Replying to Slash Commands](https://discordjs.guide/interactions/replying-to-slash-commands.html)
-- [Slash Command Permissions](https://discordjs.guide/interactions/slash-command-permissions.html.html)
-- [Handling Commands](https://discordjs.guide/command-handling/#individual-command-files)
+- [Creating commands](https://discordjs.guide/creating-your-bot/creating-commands.html)
+- [Replying to Slash Commands](https://discordjs.guide/interactions/slash-commands.html#replying-to-slash-commands)
+- [Slash Command Permissions](https://discordjs.guide/interactions/slash-commands.html#slash-command-permissions)
+- [Handling Commands](https://discordjs.guide/creating-your-bot/command-handling.html#command-handling)
 
 ## 👋 Support
 If you have found an issue with using this command handler example or have any suggestions? Feel free to join the [NTM Discord Server](https://discord.gg/G2rb53z), send an [issue](https://github.com/NTMNathan/djs-command-handler/issues) or [pull request](https://github.com/NTMNathan/djs-command-handler/pulls). We'll be happy to help and take a look!

index.js bot.jsindex.js renamed to bot.js

@@ -1,5 +1,5 @@
-const Client = require("./structures/Client");
-require("dotenv").config();
+const Client = require('./structures/Client');
+require('dotenv').config();
 
 const client = new Client();
 client.login();

commands/context/avatar.js

@@ -0,0 +1,30 @@
+const Command = require('../../structures/CommandClass');
+
+const { MessageEmbed } = require('discord.js');
+const { ContextMenuCommandBuilder } = require('@discordjs/builders');
+const { ApplicationCommandType } = require('discord-api-types/v9');
+
+module.exports = class Avatar extends Command {
+	constructor(client) {
+		super(client, {
+			data: new ContextMenuCommandBuilder()
+				.setName('Avatar')
+				.setType(ApplicationCommandType.User)
+				.setDefaultPermission(true),
+			contextDescription: 'Fetches the avatar of a user.',
+			usage: 'Avatar',
+			category: 'Context',
+			permissions: ['Use Application Commands', 'Send Messages', 'Embed Links'],
+		});
+	}
+	async run(client, interaction) {
+		const user = client.users.cache.get(interaction.targetId);
+
+		const embed = new MessageEmbed()
+			.setTitle(`**${user.username}'s Avatar**`)
+			.setColor(client.config.embedColor)
+			.setImage(user.displayAvatarURL({ dynamic: true, size: 2048 }));
+
+		await interaction.reply({ embeds: [embed] });
+	}
+};

commands/context/hello.js

@@ -1,17 +1,22 @@
-const Command = require("../../structures/CommandClass");
+const Command = require('../../structures/CommandClass');
+
+const { ContextMenuCommandBuilder } = require('@discordjs/builders');
+const { ApplicationCommandType } = require('discord-api-types/v9');
 
 module.exports = class Hello extends Command {
-    constructor(client) {
-        super(client, {
-            name: "Hello",
-            type: "MESSAGE",
-            defaultPermission: true,
-            contextDescription: "Sends a message that greets you, with a present!",
-            category: "Context",
-            permissions: ["Use Application Commands", "Send Messages", "Embed Links"]
-        });
-    }
-    async run(client, interaction) {
-        await interaction.reply({ content: `Hello ${interaction.user}! Here, you should have a slice of vanilla cake 😊🍰` });
-    }
+	constructor(client) {
+		super(client, {
+			data: new ContextMenuCommandBuilder()
+				.setName('Hello')
+				.setType(ApplicationCommandType.Message)
+				.setDefaultPermission(true),
+			contextDescription: 'Sends a message that greets you, with a present!',
+			usage: 'Hello',
+			category: 'Context',
+			permissions: ['Use Application Commands', 'Send Messages', 'Embed Links'],
+		});
+	}
+	async run(client, interaction) {
+		await interaction.reply({ content: `Hello ${interaction.user}! Here, you should have a slice of vanilla cake 😊🍰` });
+	}
 };

commands/context/userinfo.js

@@ -1,55 +1,56 @@
-const Command = require("../../structures/CommandClass");
+const Command = require('../../structures/CommandClass');
 
-const { MessageEmbed } = require("discord.js");
-const { stripIndents } = require("common-tags");
+const { MessageEmbed } = require('discord.js');
+const { ContextMenuCommandBuilder } = require('@discordjs/builders');
+const { ApplicationCommandType } = require('discord-api-types/v9');
+const { stripIndents } = require('common-tags');
 
 module.exports = class UserInfo extends Command {
-    constructor(client) {
-        super(client, {
-            name: "User Info",
-            type: "USER",
-            defaultPermission: true,
-            contextDescription: "Returns information about a user.",
-            category: "Context",
-            cooldown: 5,
-            enabled: true,
-            staffOnly: false,
-            permissions: ["Use Application Commands", "Send Messages", "Embed Links"]
-        });
-    }
-    async run(client, interaction) {
-        const member = interaction.guild.members.cache.get(interaction.targetId);
+	constructor(client) {
+		super(client, {
+			data: new ContextMenuCommandBuilder()
+				.setName('User Info')
+				.setType(ApplicationCommandType.User)
+				.setDefaultPermission(true),
+			contextDescription: 'Returns information about a user.',
+			usage: 'User Info',
+			category: 'Context',
+			permissions: ['Use Application Commands', 'Send Messages', 'Embed Links'],
+		});
+	}
+	async run(client, interaction) {
+		const member = interaction.guild.members.cache.get(interaction.targetId);
 
-        const embed = new MessageEmbed()
-            .setTitle(`**${member.user.username}#${member.user.discriminator}**`)
-            .setColor(client.config.embedColor)
-            .setThumbnail(member.user.displayAvatarURL({ dynamic: true, size: 2048 }))
-            .addFields(
-                {
-                    name: "👤 Account Info",
-                    value: stripIndents`
+		const embed = new MessageEmbed()
+			.setTitle(`**${member.user.username}#${member.user.discriminator}**`)
+			.setColor(client.config.embedColor)
+			.setThumbnail(member.user.displayAvatarURL({ dynamic: true, size: 2048 }))
+			.addFields(
+				{
+					name: '👤 Account Info',
+					value: stripIndents`
                         **ID:** ${member.user.id}
-                        **Bot:** ${member.user.bot ? "Yes" : "No"}
+                        **Bot:** ${member.user.bot ? 'Yes' : 'No'}
                         **Created:** <t:${Math.floor(member.user.createdTimestamp / 1000)}:d>
                         `,
-                    inline: true
-                },
-                {
-                    name: "📋 Member Info",
-                    value: stripIndents`
+					inline: true,
+				},
+				{
+					name: '📋 Member Info',
+					value: stripIndents`
                         **Joined Server:** <t:${Math.floor(member.joinedTimestamp / 1000)}:R>
-                        **Nickname:** ${member.nickname || `None`}
-                        **Hoist Role:** ${member.roles.hoist ? member.roles.hoist.name : "None"}
+                        **Nickname:** ${member.nickname || 'None'}
+                        **Hoist Role:** ${member.roles.hoist ? member.roles.hoist.name : 'None'}
                         `,
-                    inline: true
-                },
-                {
-                    name: `📝 Roles [${member.roles.cache.size - 1}]`,
-                    value: member.roles.cache.size ? member.roles.cache.map(roles => `**${roles}**`).slice(0, -1).join(" ") : "None",
-                    inline: false
-                }
-            );
+					inline: true,
+				},
+				{
+					name: `📝 Roles [${member.roles.cache.size - 1}]`,
+					value: member.roles.cache.size ? member.roles.cache.map(roles => `**${roles}**`).slice(0, -1).join(' ') : 'None',
+					inline: false,
+				},
+			);
 
-        interaction.reply({ embeds: [embed] });
-    }
+		await interaction.reply({ embeds: [embed] });
+	}
 };