feat: add commands.defaultContext to define a default context for all commands (#211)

* feat: add commands.defaultContext to define a default context for all commands

* biome: check

* chore: knip config fix

Author: Cleboost

.changeset/deep-wolves-thank.md

@@ -0,0 +1,6 @@
+---
+"@djs-core/runtime": minor
+"@djs-core/dev": minor
+---
+
+Add `commands.defaultContext` array to define a default context for all commands (command.setContext overrides config)

app/djs.config.ts

@@ -1,4 +1,5 @@
 import type { Config } from "@djs-core/dev";
+import { InteractionContextType } from "discord.js";
 
 if (!process.env.TOKEN) {
 	throw new Error("TOKEN environment variable is required");
@@ -7,4 +8,7 @@ if (!process.env.TOKEN) {
 export default {
 	token: process.env.TOKEN,
 	servers: ["1333211545920077896"],
+	commands: {
+		defaultContext: [InteractionContextType.Guild],
+	},
 } satisfies Config;

knip.json

@@ -7,7 +7,7 @@
 	"tags": ["-lintignore"],
 	"workspaces": {
 		".": {
-			"ignore": ["app/**", ".github/workflows/**"]
+			"ignore": ["app/**", ".github/workflows/**", "packages/utils/**"]
 		},
 		"app": {
 			"ignoreDependencies": ["@djs-core/runtime", "discord.js"]

packages/dev/index.ts

@@ -5,7 +5,7 @@ import { registerBuildCommand } from "./commands/build";
 import { registerDevCommand } from "./commands/dev";
 import { registerStartCommand } from "./commands/start";
 
-const cli = cac("djs-core").version("1.0.0").help();
+const cli = cac("djs-core").version("2.0.0").help();
 
 registerStartCommand(cli);
 registerDevCommand(cli);

packages/dev/utils/common.ts

@@ -30,10 +30,6 @@ export const banner = `
    ${pc.bold(pc.blue("djs-core"))} ${pc.dim(`v1.0.0`)}
 `;
 
-// Path constants matching TypeScript aliases in tsconfig.json
-// @components/* -> src/components/*
-// @interactions/* -> src/interactions/*
-// @events/* -> src/events/*
 export const PATH_ALIASES = {
 	components: "src/components",
 	interactions: "src/interactions",
@@ -127,7 +123,7 @@ export async function runBot(projectPath: string) {
 	);
 	console.log(`${pc.green("✓")}  Loaded ${pc.bold(modals.length)} modals`);
 
-	const client = new DjsClient({ servers: config.servers });
+	const client = new DjsClient({ djsConfig: config });
 
 	client.eventsHandler.set(events);
 
@@ -228,7 +224,6 @@ async function scanCommands(
 ): Promise<Route[]> {
 	const routes: Route[] = [];
 
-	// Create dir if not exists to avoid error
 	try {
 		await fs.access(dir);
 	} catch {

packages/runtime/DjsClient.ts

@@ -14,6 +14,7 @@ import {
 	type StringSelectMenuInteraction,
 	type UserSelectMenuInteraction,
 } from "discord.js";
+import type { Config } from "../utils/types/config";
 import ApplicationCommandHandler from "./handler/ApplicationCommandHandler";
 import ButtonHandler from "./handler/ButtonHandler";
 import CommandHandler from "./handler/CommandHandler";
@@ -32,8 +33,9 @@ export default class DjsClient extends Client {
 	public modalsHandler: ModalHandler = new ModalHandler(this);
 	public applicationCommandHandler: ApplicationCommandHandler =
 		new ApplicationCommandHandler(this);
+	private readonly djsConfig: Config;
 
-	constructor({ servers }: { servers: string[] }) {
+	constructor({ djsConfig }: { djsConfig: Config }) {
 		super({
 			intents: [
 				IntentsBitField.Flags.Guilds,
@@ -42,10 +44,13 @@ export default class DjsClient extends Client {
 				IntentsBitField.Flags.GuildVoiceStates,
 			],
 		});
+		this.djsConfig = djsConfig;
 
-		this.commandsHandler.setGuilds(servers);
-		this.contextMenusHandler.setGuilds(servers);
-		this.applicationCommandHandler.setGuilds(servers);
+		if (djsConfig.servers && djsConfig.servers.length > 0) {
+			this.commandsHandler.setGuilds(djsConfig.servers);
+			this.contextMenusHandler.setGuilds(djsConfig.servers);
+			this.applicationCommandHandler.setGuilds(djsConfig.servers);
+		}
 
 		this.once(Events.ClientReady, () => {
 			const deleted = cleanupExpiredTokens();
@@ -103,4 +108,8 @@ export default class DjsClient extends Client {
 			}
 		});
 	}
+
+	public getDjsConfig(): Config {
+		return this.djsConfig;
+	}
 }

packages/runtime/handler/ApplicationCommandHandler.ts

@@ -1,25 +1,26 @@
 import type {
 	ApplicationCommand,
 	ApplicationCommandDataResolvable,
-	Client,
 	Collection,
 } from "discord.js";
 import {
 	SlashCommandBuilder,
 	type SlashCommandSubcommandBuilder,
 } from "discord.js";
+import type DjsClient from "../DjsClient";
 import type Command from "../interaction/Command";
 import type ContextMenu from "../interaction/ContextMenu";
 import type { Route } from "./CommandHandler";
 
 export default class ApplicationCommandHandler {
-	private readonly client: Client;
+	private readonly client: DjsClient;
 	private commands: Route[] = [];
 	private contextMenus: ContextMenu[] = [];
 	private guilds: string[] = [];
 	private rootIdCache = new Map<string, Map<string, string>>();
+	private hasWarnedEmptyContext = false;
 
-	constructor(client: Client) {
+	constructor(client: DjsClient) {
 		this.client = client;
 	}
 
@@ -156,7 +157,12 @@ export default class ApplicationCommandHandler {
 			if (!cmd.name) {
 				cmd.setName(root);
 			}
-			return cmd.toJSON();
+			this.applyDefaultContext(cmd, routes);
+			const json = cmd.toJSON();
+			if (json.contexts && json.contexts.length === 0) {
+				delete json.contexts;
+			}
+			return json;
 		}
 
 		for (const [name, cmd] of subcommands) {
@@ -191,7 +197,50 @@ export default class ApplicationCommandHandler {
 			});
 		}
 
-		return builder.toJSON();
+		this.applyDefaultContext(builder, routes);
+		const json = builder.toJSON();
+		if (json.contexts && json.contexts.length === 0) {
+			delete json.contexts;
+		}
+		return json;
+	}
+
+	private applyDefaultContext(
+		target: Command | SlashCommandBuilder,
+		routes: Array<{ parts: string[]; cmd: Command }>,
+	): void {
+		const defaultContext = this.client.getDjsConfig()?.commands?.defaultContext;
+		if (!defaultContext) {
+			return;
+		}
+		if (!Array.isArray(defaultContext) || defaultContext.length === 0) {
+			if (!this.hasWarnedEmptyContext) {
+				console.warn(
+					"⚠️  config.commands.defaultContext is defined but empty. Default context will not be applied.",
+				);
+				this.hasWarnedEmptyContext = true;
+			}
+			return;
+		}
+
+		try {
+			const targetJson = target.toJSON();
+			if (targetJson.contexts && targetJson.contexts.length > 0) {
+				return;
+			}
+		} catch {}
+
+		for (const r of routes) {
+			try {
+				const cmdJson = r.cmd.toJSON();
+				if (cmdJson.contexts && cmdJson.contexts.length > 0) {
+					target.setContexts(cmdJson.contexts);
+					return;
+				}
+			} catch {}
+		}
+
+		target.setContexts(defaultContext);
 	}
 
 	private getRootDescription(root: string): string | undefined {

packages/utils/types/config.d.ts

@@ -1,4 +1,9 @@
+import type { InteractionContextType } from "discord.js";
+
 export interface Config {
 	token: string;
 	servers: string[];
+	commands?: {
+		defaultContext?: InteractionContextType[];
+	};
 }