feat: allow specifying default scope

deno.jsonc

@@ -19,8 +19,8 @@
     "lock": false,
     "tasks": {
         "backport": "rm -rf out && deno run --no-prompt --allow-read=. --allow-write=. https://deno.land/x/deno2node@v1.9.0/src/cli.ts",
-        "quality:check": "deno lint && deno fmt --check && deno check src/mod.ts",
-        "quality:fix": "deno lint --fix && deno fmt",
+        "check": "deno lint && deno fmt --check && deno check src/mod.ts",
+        "fix": "deno lint --fix && deno fmt",
         "test": "deno test --seed=123456 --parallel ./test/",
         "coverage": "rm -rf ./test/cov_profile && deno task test --coverage=./test/cov_profile && deno coverage --lcov --output=./coverage.lcov ./test/cov_profile"
     }

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@grammyjs/commands",
-    "version": "0.5.1",
+    "version": "0.6.0",
     "description": "grammY Commands Plugin",
     "main": "out/mod.js",
     "scripts": {

src/commands.ts

@@ -1,10 +1,11 @@
-import { Command } from "./command.ts";
+import { Command, MaybeArray } from "./command.ts";
 import {
     Api,
     BotCommand,
     BotCommandScope,
     Composer,
     Context,
+    Middleware,
 } from "./deps.deno.ts";
 import { CommandOptions } from "./types.ts";
 
@@ -17,6 +18,23 @@ type SetMyCommandsParams = {
     commands: BotCommand[];
 };
 
+const isMiddleware = <C extends Context>(
+    obj: unknown,
+): obj is MaybeArray<Middleware<C>> => {
+    if (!obj) return false;
+    if (Array.isArray(obj)) return obj.every(isMiddleware);
+    const objType = typeof obj;
+
+    switch (objType) {
+        case "function":
+            return true;
+        case "object":
+            return Object.keys(obj).includes("middleware");
+    }
+
+    return false;
+};
+
 /**
  * Central class that manages all registered commands.
  * This is the starting point for the plugin, and this is what you should pass to `bot.use` so your commands get properly registered.
@@ -68,18 +86,48 @@ export class Commands<C extends Context> {
     }
 
     /**
-     * Registers a new command and returns it.
-     * @param name Command name
+     * Registers a new command with a default handler.
+     * @param name Default command name
      * @param description Default command description
+     * @param handler Default command handler
      * @param options Extra options that should apply only to this command
      * @returns An instance of the `Command` class
      */
     public command(
         name: string | RegExp,
         description: string,
-        options: Partial<CommandOptions> = this._commandOptions,
+        handler: MaybeArray<Middleware<C>>,
+        options?: Partial<CommandOptions>,
+    ): Command<C>;
+    /**
+     * Registers a new command with no handlers.
+     * @param name Default command name
+     * @param description Default command description
+     * @param options Extra options that should apply only to this command
+     * @returns An instance of the `Command` class
+     */
+    public command(
+        name: string | RegExp,
+        description: string,
+        options?: Partial<CommandOptions>,
+    ): Command<C>;
+    public command(
+        name: string | RegExp,
+        description: string,
+        handlerOrOptions?: MaybeArray<Middleware<C>> | Partial<CommandOptions>,
+        _options?: Partial<CommandOptions>,
     ) {
+        const handler = isMiddleware(handlerOrOptions)
+            ? handlerOrOptions
+            : undefined;
+        const options = handler
+            ? _options ?? this._commandOptions
+            : handlerOrOptions as Partial<CommandOptions> ??
+                this._commandOptions;
+
         const command = new Command<C>(name, description, options);
+        if (handler) command.addToScope({ type: "default" }, handler);
+
         this._commands.push(command);
         return command;
     }

src/mod.ts

@@ -1,3 +1,4 @@
+export { Command } from "./command.ts";
 export * from "./commands.ts";
 export * from "./context.ts";
 export type { CommandOptions } from "./types.ts";

test/commands.test.ts

@@ -0,0 +1,46 @@
+import { Commands } from "../src/commands.ts";
+import { assertEquals, describe, it } from "./deps.test.ts";
+
+describe("Commands", () => {
+    describe("command", () => {
+        it("should create a command with no handlers", () => {
+            const commands = new Commands();
+            commands.command("test", "no handler");
+
+            assertEquals(commands.toArgs(), []);
+        });
+
+        it("should create a command with a default handler", () => {
+            const commands = new Commands();
+            commands.command("test", "default handler", () => {}, {
+                prefix: undefined,
+            });
+
+            assertEquals(commands.toArgs(), [{
+                commands: [{ command: "test", description: "default handler" }],
+                language_code: undefined,
+                scope: { type: "default" },
+            }]);
+        });
+
+        it("should support options with no handler", () => {
+            const commands = new Commands();
+            commands.command("test", "no handler", { prefix: "test" });
+            assertEquals(
+                (commands as any)._commands[0]._options.prefix,
+                "test",
+            );
+        });
+
+        it("should support options with default handler", () => {
+            const commands = new Commands();
+            commands.command("test", "default handler", () => {}, {
+                prefix: "test",
+            });
+            assertEquals(
+                (commands as any)._commands[0]._options.prefix,
+                "test",
+            );
+        });
+    });
+});

test/context.test.ts

@@ -12,7 +12,7 @@ import {
     UserFromGetMe,
 } from "./deps.test.ts";
 
-describe("the commands function", () => {
+describe("commands", () => {
     const u = { id: 42, first_name: "bot", is_bot: true } as User;
     const c = { id: 100, type: "private" } as Chat;
     const m = { text: "a", from: u, chat: c, sender_chat: c } as Message;

test/jaroWrinkler.test.ts

@@ -1,9 +1,12 @@
-import { distance } from "../src/jaro-winkler.ts";
-import { fuzzyMatch, JaroWinklerDistance } from "../src/jaro-winkler.ts";
-import { assertEquals, Context, describe, it } from "./deps.test.ts";
+import {
+    distance,
+    fuzzyMatch,
+    JaroWinklerDistance,
+} from "../src/jaro-winkler.ts";
 import { Commands } from "../src/mod.ts";
+import { assertEquals, Context, describe, it } from "./deps.test.ts";
 
-describe("The Jaro-Wrinkler Algorithm", () => {
+describe("Jaro-Wrinkler Algorithm", () => {
     it("should return value 0, because the empty string was given", () => {
         assertEquals(distance("", ""), 0);
     });