Nomchy/discord.js
1
0
Fork 0
mirror of https://github.com/discordjs/discord.js.git synced 2026-03-09 16:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

refactor: update deno template and loader logic (#11060)

Browse Source 
* refactor: update deno template and loader logic

* yeet

---------

Co-authored-by: kodiakhq[bot] <49736102+kodiakhq[bot]@users.noreply.github.com>
This commit is contained in:
Almeida
2025-09-04 13:36:26 +01:00
committed by GitHub
parent 5a656b849f
commit 8ca279e0c3
18 changed files with 96 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
packages/create-discord-bot/template/Deno/.prettierrc.json
View File

@@ -1,9 +0,0 @@
{
"$schema": "https://json.schemastore.org/prettierrc.json",
"printWidth": 120,
"useTabs": true,
"singleQuote": true,
"quoteProps": "as-needed",
"trailingComma": "all",
"endOfLine": "lf"
}

2
packages/create-discord-bot/template/Deno/.vscode/extensions.json vendored
View File

@@ -1,3 +1,3 @@
{
"recommendations": ["denoland.vscode-deno", "tamasfe.even-better-toml", "codezombiech.gitignore"]
"recommendations": ["denoland.vscode-deno"]
}

9
packages/create-discord-bot/template/Deno/.vscode/settings.json vendored
View File

@@ -2,14 +2,11 @@
"editor.defaultFormatter": "denoland.vscode-deno",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": true,
"source.organizeImports": false
"source.fixAll": "always",
"source.organizeImports": "always"
},
"editor.trimAutoWhitespace": false,
"files.insertFinalNewline": true,
"files.eol": "\n",
"npm.packageManager": "[REPLACE_ME]",
"deno.enable": "[REPLACE_BOOL]",
"deno.lint": "[REPLACE_BOOL]",
"deno.unstable": false
"deno.enable": "[REPLACE_BOOL]"
}

37
packages/create-discord-bot/template/Deno/deno.jsonc
View File

@@ -2,40 +2,25 @@
"$schema": "https://raw.githubusercontent.com/denoland/deno/main/cli/schemas/config-file.v1.json",
"tasks": {
"lint": "deno lint",
"deploy": "deno run --allow-read --allow-env --allow-net src/util/deploy.ts",
"deploy": "deno run --env-file --allow-read --allow-env --allow-net src/util/deploy.ts",
"format": "deno fmt",
"fmt": "deno fmt",
"start": "deno run --allow-read --allow-env --allow-net src/index.ts",
"start": "deno run --env-file --allow-read --allow-env --allow-net src/index.ts",
},
"fmt": {
"useTabs": true,
"lineWidth": 120,
"singleQuote": true,
},
"lint": {
"include": ["src/"],
"rules": {
"tags": ["recommended"],
"exclude": ["require-await", "no-await-in-sync-fn"],
},
},
"fmt": {
"useTabs": true,
"lineWidth": 120,
"semiColons": true,
"singleQuote": true,
"proseWrap": "preserve",
"include": ["src/"],
},
"compilerOptions": {
"alwaysStrict": true,
"emitDecoratorMetadata": true,
"verbatimModuleSyntax": true,
"lib": ["deno.window"],
"noFallthroughCasesInSwitch": true,
"noImplicitReturns": true,
"noUnusedLocals": true,
"noUnusedParameters": true,
"removeComments": false,
"strict": true,
"allowUnreachableCode": false,
"allowUnusedLabels": false,
"exactOptionalPropertyTypes": false,
"noImplicitOverride": true,
"imports": {
"@discordjs/core": "npm:@discordjs/core@^2.2.1",
"discord.js": "npm:discord.js@^14.22.1",
"zod": "npm:zod@^3.25.76",
},
}

4
packages/create-discord-bot/template/Deno/src/commands/index.ts
View File

@@ -1,5 +1,5 @@
import type { RESTPostAPIApplicationCommandsJSONBody, CommandInteraction } from 'npm:discord.js@^14.22.0';
import { z } from 'npm:zod@^3.25.76';
import type { CommandInteraction, RESTPostAPIApplicationCommandsJSONBody } from 'discord.js';
import { z } from 'zod';
import type { StructurePredicate } from '../util/loaders.ts';
/**

10
packages/create-discord-bot/template/Deno/src/events/index.ts
View File

@@ -1,21 +1,21 @@
import type { ClientEvents } from 'npm:discord.js@^14.22.0';
import { z } from 'npm:zod@^3.25.76';
import type { ClientEvents } from 'discord.js';
import { z } from 'zod';
import type { StructurePredicate } from '../util/loaders.ts';
/**
* Defines the structure of an event.
*/
export type Event<T extends keyof ClientEvents = keyof ClientEvents> = {
export type Event<EventName 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;
execute(...parameters: ClientEvents[EventName]): Promise<void> | void;
/**
* The name of the event to listen to
*/
name: T;
name: EventName;
/**
* Whether or not the event should only be listened to once
*

2
packages/create-discord-bot/template/Deno/src/events/interactionCreate.ts
View File

@@ -1,4 +1,4 @@
import { Events } from 'npm:discord.js@^14.22.0';
import { Events } from 'discord.js';
import type { Event } from './index.ts';
import { loadCommands } from '../util/loaders.ts';

2
packages/create-discord-bot/template/Deno/src/events/ready.ts
View File

@@ -1,4 +1,4 @@
import { Events } from 'npm:discord.js@^14.22.0';
import { Events } from 'discord.js';
import type { Event } from './index.ts';
export default {

4
packages/create-discord-bot/template/Deno/src/index.ts
View File

@@ -1,6 +1,4 @@
import 'https://deno.land/std@0.223.0/dotenv/load.ts';
import { URL } from 'node:url';
import { Client, GatewayIntentBits } from 'npm:discord.js@^14.22.0';
import { Client, GatewayIntentBits } from 'discord.js';
import { loadEvents } from './util/loaders.ts';
// Initialize the client

6
packages/create-discord-bot/template/Deno/src/util/deploy.ts
View File

@@ -1,7 +1,5 @@
import 'https://deno.land/std@0.223.0/dotenv/load.ts';
import { URL } from 'node:url';
import { API } from 'npm:@discordjs/core@^2.2.1/http-only';
import { REST } from 'npm:discord.js@^14.22.0';
import { API } from '@discordjs/core/http-only';
import { REST } from 'discord.js';
import { loadCommands } from './loaders.ts';
const commands = await loadCommands(new URL('../commands/', import.meta.url));

43
packages/create-discord-bot/template/Deno/src/util/loaders.ts
View File

@@ -1,6 +1,7 @@
import type { PathLike } from 'node:fs';
import { readdir, stat } from 'node:fs/promises';
import { URL } from 'node:url';
import { glob, stat } from 'node:fs/promises';
import { resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
import type { Command } from '../commands/index.ts';
import { predicate as commandPredicate } from '../commands/index.ts';
import type { Event } from '../events/index.ts';
@@ -9,7 +10,7 @@ import { predicate as eventPredicate } from '../events/index.ts';
/**
* A predicate to check if the structure is valid
*/
export type StructurePredicate<T> = (structure: unknown) => structure is T;
export type StructurePredicate<Structure> = (structure: unknown) => structure is Structure;
/**
* Loads all the structures in the provided directory
@@ -19,11 +20,11 @@ export type StructurePredicate<T> = (structure: unknown) => structure is T;
* @param recursive - Whether to recursively load the structures in the directory
* @returns
*/
export async function loadStructures<T>(
export async function loadStructures<Structure>(
dir: PathLike,
predicate: StructurePredicate<T>,
predicate: StructurePredicate<Structure>,
recursive = true,
): Promise<T[]> {
): Promise<Structure[]> {
// Get the stats of the directory
const statDir = await stat(dir);
@@ -32,34 +33,24 @@ export async function loadStructures<T>(
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[] = [];
const structures: Structure[] = [];
// Loop through all the files in the directory
for (const file of files) {
const fileUrl = new URL(`${dir}/${file}`, import.meta.url);
// Create a glob pattern to match the .ts files
const basePath = dir instanceof URL ? fileURLToPath(dir) : dir.toString();
const pattern = resolve(basePath, recursive ? '**/*.ts' : '*.ts');
// Get the stats of the file
const statFile = await stat(fileUrl);
// 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(fileUrl, predicate, recursive)));
continue;
}
// If the file is index.ts or the file does not end with .ts, skip the file
if (file === 'index.ts' || !file.endsWith('.ts')) {
// Loop through all the matching files in the directory
for await (const file of glob(pattern)) {
// If the file is index.ts, skip the file
if (file.endsWith('/index.ts')) {
continue;
}
// Import the structure dynamically from the file
const structure = (await import(fileUrl.toString())).default;
const { default: structure } = await import(file);
// If the structure is a valid structure, add it
// If the default export is a valid structure, add it
if (predicate(structure)) {
structures.push(structure);
}

6
packages/create-discord-bot/template/JavaScript/src/events/index.js
View File

@@ -3,10 +3,10 @@ import { z } from 'zod';
/**
* Defines the structure of an event.
*
* @template {keyof import('discord.js').ClientEvents} [T=keyof import('discord.js').ClientEvents]
* @template {keyof import('discord.js').ClientEvents} [EventName=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 {(...parameters: import('discord.js').ClientEvents[EventName]) => Promise<void> | void} execute The function to execute the command
* @property {EventName} name The name of the event to listen to
* @property {boolean} [once] Whether or not the event should only be listened to once
*/

46
packages/create-discord-bot/template/JavaScript/src/util/loaders.js
View File

@@ -1,23 +1,23 @@
import { readdir, stat } from 'node:fs/promises';
import { URL } from 'node:url';
import { glob, stat } from 'node:fs/promises';
import { fileURLToPath, resolve, 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
* @template Structure
* @typedef {(structure: unknown) => structure is Structure} StructurePredicate
*/
/**
* Loads all the structures in the provided directory.
*
* @template T
* @template Structure
* @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 {StructurePredicate<Structure>} 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[]>}
* @returns {Promise<Structure[]>}
*/
export async function loadStructures(dir, predicate, recursive = true) {
// Get the stats of the directory
@@ -28,35 +28,25 @@ export async function loadStructures(dir, predicate, recursive = true) {
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[]} */
/** @type {Structure[]} */
const structures = [];
// Loop through all the files in the directory
for (const file of files) {
const fileUrl = new URL(`${dir}/${file}`, import.meta.url);
// Create a glob pattern to match the .js files
const basePath = dir instanceof URL ? fileURLToPath(dir) : dir.toString();
const pattern = resolve(basePath, recursive ? '**/*.js' : '*.js');
// Get the stats of the file
const statFile = await stat(fileUrl);
// 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(fileUrl, predicate, recursive)));
continue;
}
// If the file is index.js or the file does not end with .js, skip the file
if (file === 'index.js' || !file.endsWith('.js')) {
// Loop through all the matching files in the directory
for await (const file of glob(pattern)) {
// If the file is index.js, skip the file
if (file.endsWith('/index.js')) {
continue;
}
// Import the structure dynamically from the file
const structure = (await import(fileUrl.toString())).default;
const { default: structure } = await import(file);
// If the structure is a valid structure, add it
// If the default export is a valid structure, add it
if (predicate(structure)) {
structures.push(structure);
}
@@ -68,7 +58,7 @@ export async function loadStructures(dir, predicate, recursive = true) {
/**
* @param {import('node:fs').PathLike} dir
* @param {boolean} [recursive]
* @returns {Promise<Map<string,import('../commands/index.js').Command>>}
* @returns {Promise<Map<string, import('../commands/index.js').Command>>}
*/
export async function loadCommands(dir, recursive = true) {
return (await loadStructures(dir, commandPredicate, recursive)).reduce(

4
packages/create-discord-bot/template/TypeScript/.vscode/settings.json vendored
View File

@@ -3,8 +3,8 @@
"editor.defaultFormatter": "esbenp.prettier-vscode",
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll": true,
"source.organizeImports": false
"source.fixAll": "explicit",
"source.organizeImports": "never"
},
"editor.trimAutoWhitespace": false,
"files.insertFinalNewline": true,

6
packages/create-discord-bot/template/TypeScript/src/events/index.ts
View File

@@ -5,17 +5,17 @@ import type { StructurePredicate } from '../util/loaders.[REPLACE_IMPORT_EXT]';
/**
* Defines the structure of an event.
*/
export type Event<T extends keyof ClientEvents = keyof ClientEvents> = {
export type Event<EventName 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;
execute(...parameters: ClientEvents[EventName]): Promise<void> | void;
/**
* The name of the event to listen to
*/
name: T;
name: EventName;
/**
* Whether or not the event should only be listened to once
*

47
packages/create-discord-bot/template/TypeScript/src/util/loaders.ts
View File

@@ -1,6 +1,7 @@
import type { PathLike } from 'node:fs';
import { readdir, stat } from 'node:fs/promises';
import { URL } from 'node:url';
import { glob, stat } from 'node:fs/promises';
import { resolve } from 'node:path';
import { fileURLToPath } from 'node:url';
import type { Command } from '../commands/index.[REPLACE_IMPORT_EXT]';
import { predicate as commandPredicate } from '../commands/index.[REPLACE_IMPORT_EXT]';
import type { Event } from '../events/index.[REPLACE_IMPORT_EXT]';
@@ -9,7 +10,7 @@ import { predicate as eventPredicate } from '../events/index.[REPLACE_IMPORT_EXT
/**
* A predicate to check if the structure is valid
*/
export type StructurePredicate<T> = (structure: unknown) => structure is T;
export type StructurePredicate<Structure> = (structure: unknown) => structure is Structure;
/**
* Loads all the structures in the provided directory
@@ -19,11 +20,11 @@ export type StructurePredicate<T> = (structure: unknown) => structure is T;
* @param recursive - Whether to recursively load the structures in the directory
* @returns
*/
export async function loadStructures<T>(
export async function loadStructures<Structure>(
dir: PathLike,
predicate: StructurePredicate<T>,
predicate: StructurePredicate<Structure>,
recursive = true,
): Promise<T[]> {
): Promise<Structure[]> {
// Get the stats of the directory
const statDir = await stat(dir);
@@ -32,35 +33,27 @@ export async function loadStructures<T>(
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[] = [];
const structures: Structure[] = [];
// Loop through all the files in the directory
for (const file of files) {
const fileUrl = new URL(`${dir}/${file}`, import.meta.url);
// Create a glob pattern to match the .[REPLACE_IMPORT_EXT] files
const basePath = dir instanceof URL ? fileURLToPath(dir) : dir.toString();
const pattern = resolve(basePath, recursive ? '**/*.[REPLACE_IMPORT_EXT]' : '*.[REPLACE_IMPORT_EXT]');
// Get the stats of the file
const statFile = await stat(fileUrl);
// 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(fileUrl, predicate, recursive)));
continue;
}
// If the file is index.[REPLACE_IMPORT_EXT] or the file does not end with .[REPLACE_IMPORT_EXT], skip the file
if (file === 'index.[REPLACE_IMPORT_EXT]' || !file.endsWith('.[REPLACE_IMPORT_EXT]')) {
// Loop through all the matching files in the directory
for await (const file of glob(pattern)) {
// If the file is index.[REPLACE_IMPORT_EXT], skip the file
if (file.endsWith('/index.[REPLACE_IMPORT_EXT]')) {
continue;
}
// Import the structure dynamically from the file
const structure = (await import(fileUrl.toString())).default;
const { default: structure } = await import(file);
// If the structure is a valid structure, add it
if (predicate(structure)) structures.push(structure);
// If the default export is a valid structure, add it
if (predicate(structure)) {
structures.push(structure);
}
}
return structures;