create-discord-bot 0.0.6 → 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+# [create-discord-bot/0.2.0](https://github.com/discordjs/discord.js/compare/create-discord-bot@0.1.0...create-discord-bot@0.2.0) - (2023-07-31)
+
+## Bug Fixes
+
+- Resolve imports for Windows (#9546) ([b6162bc](https://github.com/discordjs/discord.js/commit/b6162bc5b582089a9405d29f6825d9748180f66a))
+- Non-existing data property (#9544) ([5b8d535](https://github.com/discordjs/discord.js/commit/5b8d535fd633ff25dd801f35e13b4cb169cc42ac))
+- **create-discord-bot:** Fix start script (#9542) ([8482e3c](https://github.com/discordjs/discord.js/commit/8482e3c95dd5ca086805e756afdcf787e3fea1f9))
+
+## Documentation
+
+- Add Cloudflare sponsorship in `create-discord-bot` readme (#9540) ([12482b7](https://github.com/discordjs/discord.js/commit/12482b70ed4bfadf26720f9b2ed9d7bf7ccc39b8))
+
+## Features
+
+- **create-discord-bot:** Throw error if the directory is a file (#9719) ([351a18b](https://github.com/discordjs/discord.js/commit/351a18bc35da7765d281e419b646ef734a315bdf))
+- **create-discord-bot:** Add prompts, command handler and deployment script (#9570) ([84f1b18](https://github.com/discordjs/discord.js/commit/84f1b1890de5add805bef1a030b0ade3c6aca213))
+- Check for empty directory (#9539) ([64324a8](https://github.com/discordjs/discord.js/commit/64324a8be13dc2b766636a1042ae13d3d52a5c79))
+- **create-discord-bot:** Inherit stdio when installing deps (#9543) ([c4a3120](https://github.com/discordjs/discord.js/commit/c4a3120354ea3930e010ba011216e42311e29cdb))
+
+# [0.1.0](https://github.com/discordjs/discord.js/tree/0.1.0) - (2023-05-07)
+
+## Features
+
+- Create-discord-bot (#9420) ([f83a8a5](https://github.com/discordjs/discord.js/commit/f83a8a58c99532131848f9d89cec58ae5cd5d138))

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2023 Noel Buechler
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,44 @@
-# create-discord-bot
+<div align="center">
+	<br />
+	<p>
+		<a href="https://discord.js.org"><img src="https://discord.js.org/static/logo.svg" width="546" alt="discord.js" /></a>
+	</p>
+	<br />
+	<p>
+		<a href="https://discord.gg/djs"><img src="https://img.shields.io/discord/222078108977594368?color=5865F2&logo=discord&logoColor=white" alt="Discord server" /></a>
+		<a href="https://github.com/discordjs/discord.js/actions"><img src="https://github.com/discordjs/discord.js/actions/workflows/test.yml/badge.svg" alt="Build status" /></a>
+	</p>
+	<p>
+		<a href="https://vercel.com/?utm_source=discordjs&utm_campaign=oss"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-vercel.svg" alt="Vercel" /></a>
+		<a href="https://www.cloudflare.com"><img src="https://raw.githubusercontent.com/discordjs/discord.js/main/.github/powered-by-workers.png" alt="Cloudflare Workers" height="44" /></a>
+	</p>
+</div>
 
-A work-in-progress startup utility to initialise a Discord bot.
+## About
+
+`npx create-discord-bot ./your/chosen/directory/`. It's as easy as that to create a simple Discord bot to begin your journey with the Discord API.
+
+## Links
+
+- [Guide] ([source][guide-source])
+  - Also see the v13 to v14 [Update Guide][guide-update], which includes updated and removed items from the library.
+- [discord.js Discord server][discord]
+- [Discord API Discord server][discord-api]
+- [GitHub][source]
+
+## Contributing
+
+Before creating an issue, please ensure that it hasn't already been reported/suggested.  
+See [the contribution guide][contributing] if you'd like to submit a pull request.
+
+## Help
+
+If you don't understand something in the documentation, you are experiencing problems, or you just need a gentle nudge in the right direction, please don't hesitate to join our official [discord.js server][discord].
+
+[guide]: https://discordjs.guide/
+[guide-source]: https://github.com/discordjs/guide
+[guide-update]: https://discordjs.guide/additional-info/changes-in-v14.html
+[discord]: https://discord.gg/djs
+[discord-api]: https://discord.gg/discord-api
+[source]: https://github.com/discordjs/discord.js/tree/main/packages/create-discord-bot
+[contributing]: https://github.com/discordjs/discord.js/blob/main/.github/CONTRIBUTING.md

package/dist/index.mjs

@@ -0,0 +1,4 @@
+var b=Object.defineProperty;var n=(e,o)=>b(e,"name",{value:o,configurable:!0});import{program as A}from"commander";import E from"prompts";import{cp as T,stat as v,mkdir as D,readdir as _,readFile as C,writeFile as U}from"node:fs/promises";import j from"node:path";import c from"node:process";import{URL as L}from"node:url";import r from"chalk";import R from"validate-npm-package-name";import{execSync as x}from"node:child_process";import N from"node:process";import S from"chalk";var s="npm",u="https://guide.discordjs.dev";function h(){let e=N.env.npm_config_user_agent;return e?e.startsWith("npm")?"npm":e.startsWith("yarn")?"yarn":e.startsWith("pnpm")?"pnpm":(console.error(S.yellow(`Detected an unsupported package manager (${e}). Falling back to ${s}.`)),s):s}n(h,"resolvePackageManager");function w(e){let o;switch(e){case"npm":case"pnpm":o=`${e} install`;break;case"yarn":o=e;break}console.log(`Installing dependencies with ${e}...`),x(o,{stdio:"inherit"})}n(w,"install");async function k({typescript:e,javascript:o,directory:g}){g||(console.error(r.red("Please specify the project directory.")),c.exit(1));let t=j.resolve(g),a=j.basename(t);(!(await v(t).catch(async i=>{if(i.code==="ENOENT")return await D(t,{recursive:!0}),v(t);throw i})).isDirectory()||(await _(t)).length>0)&&(console.error(r.red(`The directory ${r.yellow(`"${a}"`)} is either not a directory or is not empty.`)),console.error(r.red("Please specify an empty directory.")),c.exit(1));let p=R(a);if(!p.validForNewPackages){console.error(r.red(`Cannot create a project named ${r.yellow(`"${a}"`)} due to npm naming restrictions.
+
+Errors:`));for(let i of[...p.errors??[],...p.warnings??[]])console.error(r.red(`- ${i}`));console.error(r.red(`
+See https://docs.npmjs.com/cli/configuring-npm/package-json for more details.`)),c.exit(1)}console.log(`Creating ${a} in ${r.green(t)}.`),await T(new L(`../template/${e?"TypeScript":"JavaScript"}`,import.meta.url),t,{recursive:!0}),c.chdir(t);let P=await C("./package.json",{encoding:"utf8"}).then(i=>i.replace("[REPLACE-NAME]",a));await U("./package.json",P);let $=h();w($),console.log(r.green("All done! Be sure to read through the discord.js guide for help on your journey.")),console.log(`Link: ${r.cyan(u)}`)}n(k,"createDiscordBot");A.description("Create a basic discord.js bot.").option("--directory","The directory where this will be created.").option("--typescript","Whether to use the TypeScript template.").option("--javascript","Whether to use the JavaScript template.").parse();var{typescript:d,javascript:y,directory:f}=A.opts();f||(f=(await E({type:"text",name:"directory",initial:"my-bot",message:"What is the name of the directory you want to create this project in?"})).directory);if(d===void 0&&y===void 0){let{useTypescript:e}=await E({type:"toggle",name:"useTypescript",message:"Do you want to use TypeScript?",initial:!0,active:"Yes",inactive:"No"});d=e,y=!e}await k({typescript:d,javascript:y,directory:f});

package/package.json

@@ -1,13 +1,75 @@
 {
   "name": "create-discord-bot",
-  "version": "0.0.6",
+  "version": "0.2.0",
+  "description": "A simple way to create a startup Discord bot.",
+  "scripts": {
+    "build": "tsup",
+    "lint": "prettier --check . && cross-env TIMING=1 eslint src --ext .mjs,.js,.ts --format=pretty",
+    "format": "prettier --write . && cross-env TIMING=1 eslint src --ext .mjs,.js,.ts --fix --format=pretty",
+    "prepack": "yarn build && yarn lint",
+    "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/create-discord-bot/*'",
+    "release": "cliff-jumper"
+  },
+  "bin": "./dist/index.mjs",
+  "directories": {
+    "lib": "src"
+  },
+  "files": [
+    "dist",
+    "template"
+  ],
+  "contributors": [
+    "Crawl <icrawltogo@gmail.com>",
+    "SpaceEEC <spaceeec@yahoo.com>",
+    "Vlad Frangu <kingdgrizzle@gmail.com>",
+    "Aura Román <kyradiscord@gmail.com>",
+    "Jiralite <jiralite@live.co.uk>"
+  ],
+  "license": "Apache-2.0",
+  "keywords": [
+    "discord",
+    "discord-api",
+    "discord.js",
+    "create-bot",
+    "init-bot",
+    "init-discord",
+    "boilerplate"
+  ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/discordjs/discord.js"
+    "url": "git+https://github.com/discordjs/discord.js.git",
+    "directory": "packages/create-discord-bot"
   },
   "bugs": {
     "url": "https://github.com/discordjs/discord.js/issues"
   },
-  "description": "A startup utility for creating a Discord bot.",
-  "author": "Jiralite"
-}
+  "homepage": "https://discord.js.org",
+  "dependencies": {
+    "chalk": "^5.3.0",
+    "commander": "^11.0.0",
+    "prompts": "^2.4.2",
+    "validate-npm-package-name": "^5.0.0"
+  },
+  "devDependencies": {
+    "@favware/cliff-jumper": "^2.1.1",
+    "@microsoft/api-extractor": "^7.36.3",
+    "@types/node": "16.18.39",
+    "@types/prompts": "^2.4.4",
+    "@types/validate-npm-package-name": "^4.0.0",
+    "@vitest/coverage-c8": "^0.33.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.46.0",
+    "eslint-config-neon": "^0.1.47",
+    "eslint-formatter-pretty": "^5.0.0",
+    "prettier": "^2.8.8",
+    "tsup": "^7.1.0",
+    "typescript": "^5.1.6",
+    "vitest": "^0.33.0"
+  },
+  "engines": {
+    "node": ">=18.16.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/template/JavaScript/.env

@@ -0,0 +1,2 @@
+DISCORD_TOKEN=
+APPLICATION_ID=

package/template/JavaScript/.eslintrc.json

@@ -0,0 +1,9 @@
+{
+	"root": true,
+	"extends": ["neon/common", "neon/node", "neon/prettier"],
+	"rules": {
+		"jsdoc/valid-types": 0,
+		"jsdoc/check-tag-names": 0,
+		"jsdoc/no-undefined-types": 0
+	}
+}

package/template/JavaScript/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+	"printWidth": 120,
+	"useTabs": true,
+	"singleQuote": true,
+	"quoteProps": "as-needed",
+	"trailingComma": "all",
+	"endOfLine": "lf"
+}

package/template/JavaScript/package.json

@@ -0,0 +1,23 @@
+{
+	"name": "[REPLACE-NAME]",
+	"version": "0.1.0",
+	"private": true,
+	"type": "module",
+	"scripts": {
+		"lint": "prettier --check . && eslint src --ext .js,.cjs --format=pretty",
+		"format": "prettier --write . && eslint src --ext .js,.cjs --fix --format=pretty",
+		"start": "node --require dotenv/config src/index.js",
+		"deploy": "node --require dotenv/config src/util/deploy.js"
+	},
+	"dependencies": {
+		"@discordjs/core": "^0.6.0",
+		"discord.js": "^14.11.0",
+		"dotenv": "^16.0.3"
+	},
+	"devDependencies": {
+		"eslint": "^8.40.0",
+		"eslint-config-neon": "^0.1.47",
+		"eslint-formatter-pretty": "^5.0.0",
+		"prettier": "^2.8.8"
+	}
+}

package/template/JavaScript/src/commands/index.js

@@ -0,0 +1,21 @@
+/**
+ * Defines the structure of a command.
+ *
+ * @typedef {object} Command
+ * @property {import('discord.js').RESTPostAPIApplicationCommandsJSONBody} data The data for the command
+ * @property {(interaction: import('discord.js').CommandInteraction) => Promise<void> | void} execute The function to execute when the command is called
+ */
+
+/**
+ * Defines the predicate to check if an object is a valid Command type.
+ *
+ * @type {import('../util/loaders.js').StructurePredicate<Command>}
+ * @returns {structure is Command}
+ */
+export const predicate = (structure) =>
+	Boolean(structure) &&
+	typeof structure === 'object' &&
+	'data' in structure &&
+	'execute' in structure &&
+	typeof structure.data === 'object' &&
+	typeof structure.execute === 'function';

package/template/JavaScript/src/commands/ping.js

@@ -0,0 +1,10 @@
+/** @type {import('./index.js').Command} */
+export default {
+	data: {
+		name: 'ping',
+		description: 'Ping!',
+	},
+	async execute(interaction) {
+		await interaction.reply('Pong!');
+	},
+};

package/template/JavaScript/src/events/index.js

@@ -0,0 +1,23 @@
+/**
+ * Defines the structure of an event.
+ *
+ * @template {keyof import('discord.js').ClientEvents} [T=keyof import('discord.js').ClientEvents]
+ * @typedef {object} Event
+ * @property {(...parameters: import('discord.js').ClientEvents[T]) => Promise<void> | void} execute The function to execute the command
+ * @property {T} name The name of the event to listen to
+ * @property {boolean} [once] Whether or not the event should only be listened to once
+ */
+
+/**
+ * Defines the predicate to check if an object is a valid Event type.
+ *
+ * @type {import('../util/loaders').StructurePredicate<Event>}
+ * @returns {structure is Event}
+ */
+export const predicate = (structure) =>
+	Boolean(structure) &&
+	typeof structure === 'object' &&
+	'name' in structure &&
+	'execute' in structure &&
+	typeof structure.name === 'string' &&
+	typeof structure.execute === 'function';

package/template/JavaScript/src/events/ready.js

@@ -0,0 +1,10 @@
+import { Events } from 'discord.js';
+
+/** @type {import('./index.js').Event<Events.ClientReady>} */
+export default {
+	name: Events.ClientReady,
+	once: true,
+	async execute(client) {
+		console.log(`Ready! Logged in as ${client.user.tag}`);
+	},
+};

package/template/JavaScript/src/index.js

@@ -0,0 +1,17 @@
+import { URL } from 'node:url';
+import { Client, GatewayIntentBits } from 'discord.js';
+import { loadCommands, loadEvents } from './util/loaders.js';
+import { registerEvents } from './util/registerEvents.js';
+
+// Initialize the client
+const client = new Client({ intents: [GatewayIntentBits.Guilds] });
+
+// Load the events and commands
+const events = await loadEvents(new URL('events/', import.meta.url));
+const commands = await loadCommands(new URL('commands/', import.meta.url));
+
+// Register the event handlers
+registerEvents(commands, events, client);
+
+// Login to the client
+void client.login();

package/template/JavaScript/src/util/deploy.js

@@ -0,0 +1,15 @@
+import process from 'node:process';
+import { URL } from 'node:url';
+import { API } from '@discordjs/core/http-only';
+import { REST } from 'discord.js';
+import { loadCommands } from './loaders.js';
+
+const commands = await loadCommands(new URL('commands/', import.meta.url));
+const commandData = [...commands.values()].map((command) => command.data);
+
+const rest = new REST({ version: '10' }).setToken(process.env.TOKEN);
+const api = new API(rest);
+
+const result = await api.applicationCommands.bulkOverwriteGlobalCommands(process.env.APPLICATION_ID, commandData);
+
+console.log(`Successfully registered ${result.length} commands.`);

package/template/JavaScript/src/util/loaders.js

@@ -0,0 +1,83 @@
+import { readdir, stat } from 'node:fs/promises';
+import { URL } from 'node:url';
+import { predicate as commandPredicate } from '../commands/index.js';
+import { predicate as eventPredicate } from '../events/index.js';
+
+/**
+ * A predicate to check if the structure is valid.
+ *
+ * @template T
+ * @typedef {(structure: unknown) => structure is T} StructurePredicate
+ */
+
+/**
+ * Loads all the structures in the provided directory.
+ *
+ * @template T
+ * @param {import('node:fs').PathLike} dir - The directory to load the structures from
+ * @param {StructurePredicate<T>} predicate - The predicate to check if the structure is valid
+ * @param {boolean} recursive - Whether to recursively load the structures in the directory
+ * @returns {Promise<T[]>}
+ */
+export async function loadStructures(dir, predicate, recursive = true) {
+	// Get the stats of the directory
+	const statDir = await stat(dir);
+
+	// If the provided directory path is not a directory, throw an error
+	if (!statDir.isDirectory()) {
+		throw new Error(`The directory '${dir}' is not a directory.`);
+	}
+
+	// Get all the files in the directory
+	const files = await readdir(dir);
+
+	// Create an empty array to store the structures
+	/** @type {T[]} */
+	const structures = [];
+
+	// Loop through all the files in the directory
+	for (const file of files) {
+		// If the file is index.js or the file does not end with .js, skip the file
+		if (file === 'index.js' || !file.endsWith('.js')) {
+			continue;
+		}
+
+		// Get the stats of the file
+		const statFile = await stat(new URL(`${dir}/${file}`));
+
+		// If the file is a directory and recursive is true, recursively load the structures in the directory
+		if (statFile.isDirectory() && recursive) {
+			structures.push(...(await loadStructures(`${dir}/${file}`, predicate, recursive)));
+			continue;
+		}
+
+		// Import the structure dynamically from the file
+		const structure = (await import(`${dir}/${file}`)).default;
+
+		// If the structure is a valid structure, add it
+		if (predicate(structure)) structures.push(structure);
+	}
+
+	return structures;
+}
+
+/**
+ * @param {import('node:fs').PathLike} dir
+ * @param {boolean} [recursive]
+ * @returns {Promise<Map<string,import('../commands/index.js').Command>>}
+ */
+export async function loadCommands(dir, recursive = true) {
+	return (await loadStructures(dir, commandPredicate, recursive)).reduce(
+		(acc, cur) => acc.set(cur.data.name, cur),
+		new Map(),
+	);
+}
+
+/**
+ * @param {import('node:fs').PathLike} dir
+ * @param {boolean} [recursive]
+ * @returns {Promise<import('../events/index.js').Event[]>}
+ */
+export async function loadEvents(dir, recursive = true) {
+	return loadStructures(dir, eventPredicate, recursive);
+}

package/template/JavaScript/src/util/registerEvents.js

@@ -0,0 +1,29 @@
+import { Events } from 'discord.js';
+
+/**
+ * @param {Map<string, import('../commands/index.js').Command>} commands
+ * @param {import('../events/index.js').Event[]} events
+ * @param {import('discord.js').Client} client
+ */
+export function registerEvents(commands, events, client) {
+	// Create an event to handle command interactions
+	/** @type {import('../events/index.js').Event<Events.InteractionCreate>} */
+	const interactionCreateEvent = {
+		name: Events.InteractionCreate,
+		async execute(interaction) {
+			if (interaction.isCommand()) {
+				const command = commands.get(interaction.commandName);
+
+				if (!command) {
+					throw new Error(`Command '${interaction.commandName}' not found.`);
+				}
+
+				await command.execute(interaction);
+			}
+		},
+	};
+
+	for (const event of [...events, interactionCreateEvent]) {
+		client[event.once ? 'once' : 'on'](event.name, async (...args) => event.execute(...args));
+	}
+}

package/template/TypeScript/.env

@@ -0,0 +1,2 @@
+DISCORD_TOKEN=
+APPLICATION_ID=

package/template/TypeScript/.eslintrc.json

@@ -0,0 +1,8 @@
+{
+	"root": true,
+	"extends": ["neon/common", "neon/node", "neon/typescript", "neon/prettier"],
+	"parserOptions": {
+		"project": ["./tsconfig.eslint.json"]
+	},
+	"ignorePatterns": ["dist/*"]
+}

package/template/TypeScript/.prettierrc.json

@@ -0,0 +1,8 @@
+{
+	"printWidth": 120,
+	"useTabs": true,
+	"singleQuote": true,
+	"quoteProps": "as-needed",
+	"trailingComma": "all",
+	"endOfLine": "lf"
+}

package/template/TypeScript/package.json

@@ -0,0 +1,27 @@
+{
+	"name": "[REPLACE-NAME]",
+	"version": "0.1.0",
+	"private": true,
+	"type": "module",
+	"scripts": {
+		"test": "tsc",
+		"lint": "prettier --check . && eslint ./src --ext .ts --format=pretty",
+		"deploy": "node --require dotenv/config dist/util/deploy.js",
+		"format": "prettier --write . && eslint ./src --ext .ts --fix --format=pretty",
+		"start": "node --require dotenv/config dist/index.js"
+	},
+	"dependencies": {
+		"@discordjs/core": "^0.6.0",
+		"discord.js": "^14.11.0",
+		"dotenv": "^16.0.3"
+	},
+	"devDependencies": {
+		"@sapphire/ts-config": "^4.0.0",
+		"@types/node": "^18.15.3",
+		"eslint": "^8.40.0",
+		"eslint-config-neon": "^0.1.47",
+		"eslint-formatter-pretty": "^5.0.0",
+		"prettier": "^2.8.8",
+		"typescript": "^5.0.4"
+	}
+}

package/template/TypeScript/src/commands/index.ts

@@ -0,0 +1,27 @@
+import type { RESTPostAPIApplicationCommandsJSONBody, CommandInteraction } from 'discord.js';
+import type { StructurePredicate } from '../util/loaders.js';
+
+/**
+ * Defines the structure of a command
+ */
+export type Command = {
+	/**
+	 * The data for the command
+	 */
+	data: RESTPostAPIApplicationCommandsJSONBody;
+	/**
+	 * The function to execute when the command is called
+	 *
+	 * @param interaction - The interaction of the command
+	 */
+	execute(interaction: CommandInteraction): Promise<void> | void;
+};
+
+// Defines the predicate to check if an object is a valid Command type
+export const predicate: StructurePredicate<Command> = (structure): structure is Command =>
+	Boolean(structure) &&
+	typeof structure === 'object' &&
+	'data' in structure! &&
+	'execute' in structure &&
+	typeof structure.data === 'object' &&
+	typeof structure.execute === 'function';

package/template/TypeScript/src/commands/ping.ts

@@ -0,0 +1,11 @@
+import type { Command } from './index.js';
+
+export default {
+	data: {
+		name: 'ping',
+		description: 'Ping!',
+	},
+	async execute(interaction) {
+		await interaction.reply('Pong!');
+	},
+} satisfies Command;

package/template/TypeScript/src/events/index.ts

@@ -0,0 +1,33 @@
+import type { ClientEvents } from 'discord.js';
+import type { StructurePredicate } from '../util/loaders.js';
+
+/**
+ * Defines the structure of an event.
+ */
+export type Event<T extends keyof ClientEvents = keyof ClientEvents> = {
+	/**
+	 * The function to execute when the event is emitted.
+	 *
+	 * @param parameters - The parameters of the event
+	 */
+	execute(...parameters: ClientEvents[T]): Promise<void> | void;
+	/**
+	 * The name of the event to listen to
+	 */
+	name: T;
+	/**
+	 * Whether or not the event should only be listened to once
+	 *
+	 * @defaultValue false
+	 */
+	once?: boolean;
+};
+
+// Defines the predicate to check if an object is a valid Event type.
+export const predicate: StructurePredicate<Event> = (structure): structure is Event =>
+	Boolean(structure) &&
+	typeof structure === 'object' &&
+	'name' in structure! &&
+	'execute' in structure &&
+	typeof structure.name === 'string' &&
+	typeof structure.execute === 'function';

package/template/TypeScript/src/events/ready.ts

@@ -0,0 +1,10 @@
+import { Events } from 'discord.js';
+import type { Event } from './index.js';
+
+export default {
+	name: Events.ClientReady,
+	once: true,
+	async execute(client) {
+		console.log(`Ready! Logged in as ${client.user.tag}`);
+	},
+} satisfies Event<'ready'>;

package/template/TypeScript/src/index.ts

@@ -0,0 +1,17 @@
+import { URL } from 'node:url';
+import { Client, GatewayIntentBits } from 'discord.js';
+import { loadCommands, loadEvents } from './util/loaders.js';
+import { registerEvents } from './util/registerEvents.js';
+
+// Initialize the client
+const client = new Client({ intents: [GatewayIntentBits.Guilds] });
+
+// Load the events and commands
+const events = await loadEvents(new URL('events/', import.meta.url));
+const commands = await loadCommands(new URL('commands/', import.meta.url));
+
+// Register the event handlers
+registerEvents(commands, events, client);
+
+// Login to the client
+void client.login();

package/template/TypeScript/src/util/deploy.ts

@@ -0,0 +1,15 @@
+import process from 'node:process';
+import { URL } from 'node:url';
+import { API } from '@discordjs/core/http-only';
+import { REST } from 'discord.js';
+import { loadCommands } from './loaders.js';
+
+const commands = await loadCommands(new URL('commands/', import.meta.url));
+const commandData = [...commands.values()].map((command) => command.data);
+
+const rest = new REST({ version: '10' }).setToken(process.env.TOKEN!);
+const api = new API(rest);
+
+const result = await api.applicationCommands.bulkOverwriteGlobalCommands(process.env.APPLICATION_ID!, commandData);
+
+console.log(`Successfully registered ${result.length} commands.`);

package/template/TypeScript/src/util/loaders.ts

@@ -0,0 +1,76 @@
+import type { PathLike } from 'node:fs';
+import { readdir, stat } from 'node:fs/promises';
+import { URL } from 'node:url';
+import type { Command } from '../commands/index.js';
+import { predicate as commandPredicate } from '../commands/index.js';
+import type { Event } from '../events/index.js';
+import { predicate as eventPredicate } from '../events/index.js';
+
+/**
+ * A predicate to check if the structure is valid
+ */
+export type StructurePredicate<T> = (structure: unknown) => structure is T;
+
+/**
+ * Loads all the structures in the provided directory
+ *
+ * @param dir - The directory to load the structures from
+ * @param predicate - The predicate to check if the structure is valid
+ * @param recursive - Whether to recursively load the structures in the directory
+ * @returns
+ */
+export async function loadStructures<T>(
+	dir: PathLike,
+	predicate: StructurePredicate<T>,
+	recursive = true,
+): Promise<T[]> {
+	// Get the stats of the directory
+	const statDir = await stat(dir);
+
+	// If the provided directory path is not a directory, throw an error
+	if (!statDir.isDirectory()) {
+		throw new Error(`The directory '${dir}' is not a directory.`);
+	}
+
+	// Get all the files in the directory
+	const files = await readdir(dir);
+
+	// Create an empty array to store the structures
+	const structures: T[] = [];
+
+	// Loop through all the files in the directory
+	for (const file of files) {
+		// If the file is index.js or the file does not end with .js, skip the file
+		if (file === 'index.js' || !file.endsWith('.js')) {
+			continue;
+		}
+
+		// Get the stats of the file
+		const statFile = await stat(new URL(`${dir}/${file}`));
+
+		// If the file is a directory and recursive is true, recursively load the structures in the directory
+		if (statFile.isDirectory() && recursive) {
+			structures.push(...(await loadStructures(`${dir}/${file}`, predicate, recursive)));
+			continue;
+		}
+
+		// Import the structure dynamically from the file
+		const structure = (await import(`${dir}/${file}`)).default;
+
+		// If the structure is a valid structure, add it
+		if (predicate(structure)) structures.push(structure);
+	}
+
+	return structures;
+}
+
+export async function loadCommands(dir: PathLike, recursive = true): Promise<Map<string, Command>> {
+	return (await loadStructures(dir, commandPredicate, recursive)).reduce(
+		(acc, cur) => acc.set(cur.data.name, cur),
+		new Map<string, Command>(),
+	);
+}
+
+export async function loadEvents(dir: PathLike, recursive = true): Promise<Event[]> {
+	return loadStructures(dir, eventPredicate, recursive);
+}

package/template/TypeScript/src/util/registerEvents.ts

@@ -0,0 +1,25 @@
+import { Events, type Client } from 'discord.js';
+import type { Command } from '../commands/index.js';
+import type { Event } from '../events/index.js';
+
+export function registerEvents(commands: Map<string, Command>, events: Event[], client: Client): void {
+	// Create an event to handle command interactions
+	const interactionCreateEvent: Event<Events.InteractionCreate> = {
+		name: Events.InteractionCreate,
+		async execute(interaction) {
+			if (interaction.isCommand()) {
+				const command = commands.get(interaction.commandName);
+
+				if (!command) {
+					throw new Error(`Command '${interaction.commandName}' not found.`);
+				}
+
+				await command.execute(interaction);
+			}
+		},
+	};
+
+	for (const event of [...events, interactionCreateEvent]) {
+		client[event.once ? 'once' : 'on'](event.name, async (...args) => event.execute(...args));
+	}
+}

package/template/TypeScript/tsconfig.eslint.json

@@ -0,0 +1,8 @@
+{
+	"extends": "./tsconfig.json",
+	"compilerOptions": {
+		"allowJs": true
+	},
+	"include": ["**/*.ts", "**/*.js", "**/*.test.ts", "**/*.test.js"],
+	"exclude": []
+}

package/template/TypeScript/tsconfig.json

@@ -0,0 +1,11 @@
+{
+	"extends": "@sapphire/ts-config/extra-strict",
+	"compilerOptions": {
+		"declaration": false,
+		"declarationMap": false,
+		"module": "ESNext",
+		"moduleResolution": "NodeNext",
+		"target": "ESNext",
+		"outDir": "dist"
+	}
+}