feat: allow command casing to be ignored

.vscode/settings.json

@@ -2,5 +2,8 @@
   "deno.enable": true,
   "deno.unstable": true,
   "deno.config": "./deno.jsonc",
-  "editor.defaultFormatter": "denoland.vscode-deno"
+  "editor.defaultFormatter": "denoland.vscode-deno",
+  "[typescript]": {
+    "editor.defaultFormatter": "denoland.vscode-deno"
+  }
 }

deno.jsonc

@@ -23,5 +23,13 @@
         "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"
-    }
+    },
+    "exclude": [
+        "node_modules",
+        "test/cov_profile",
+        ".vscode",
+        "coverage.lcov",
+        "out",
+        "src/deps.node.ts"
+    ]
 }

package.json

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

src/command.ts

@@ -24,8 +24,17 @@ const isAdmin = (ctx: Context) =>
         .getAuthor()
         .then((author) => ["administrator", "creator"].includes(author.status));
 
-export const matchesPattern = (value: string, pattern: string | RegExp) =>
-    typeof pattern === "string" ? value === pattern : pattern.test(value);
+export const matchesPattern = (
+    value: string,
+    pattern: string | RegExp,
+    ignoreCase = false,
+) => {
+    const transformedValue = ignoreCase ? value.toLowerCase() : value;
+
+    return typeof pattern === "string"
+        ? transformedValue === pattern
+        : pattern.test(transformedValue);
+};
 
 /**
  * Class that represents a single command and allows you to configure it.
@@ -41,6 +50,7 @@ export class Command<C extends Context = Context> implements MiddlewareObj<C> {
         prefix: "/",
         matchOnlyAtStart: true,
         targetedCommands: "optional",
+        ignoreCase: false,
     };
 
     /**
@@ -241,7 +251,11 @@ export class Command<C extends Context = Context> implements MiddlewareObj<C> {
                 if (username && username !== ctx.me.username) continue;
                 if (
                     commandNames.some((name) =>
-                        matchesPattern(command.replace(prefix, ""), name)
+                        matchesPattern(
+                            command.replace(prefix, ""),
+                            name,
+                            options.ignoreCase,
+                        )
                     )
                 ) {
                     return true;

src/types.ts

@@ -23,6 +23,11 @@ export interface CommandOptions {
      * - `"required"`: only targeted commands are matched
      */
     targetedCommands: "ignored" | "optional" | "required";
+    /**
+     * Whether match against commands in a case-insensitive manner.
+     * Defaults to `false`.
+     */
+    ignoreCase: boolean;
 }
 
 export interface CommandElementals {

test/command.test.ts

@@ -51,6 +51,7 @@ describe("Command", () => {
         matchOnlyAtStart: true,
         prefix: "/",
         targetedCommands: "optional",
+        ignoreCase: false,
     };
 
     describe("hasCommand", () => {
@@ -381,6 +382,70 @@ describe("Command", () => {
                 });
             });
         });
+
+        describe("ignoreCase", () => {
+            describe("true", () => {
+                it("should match a command in a case-insensitive manner", () => {
+                    m.text = "/START";
+                    m.entities = [{
+                        type: "bot_command",
+                        offset: 0,
+                        length: 6,
+                    }];
+                    const ctx = new Context(update, api, me);
+                    assert(
+                        Command.hasCommand("start", {
+                            ...options,
+                            ignoreCase: true,
+                        })(ctx),
+                    );
+
+                    m.text = "/start";
+                    m.entities = [{
+                        type: "bot_command",
+                        offset: 0,
+                        length: 6,
+                    }];
+                    assert(
+                        Command.hasCommand("start", {
+                            ...options,
+                            ignoreCase: true,
+                        })(ctx),
+                    );
+                });
+            });
+
+            describe("false", () => {
+                it("should match a command in a case-sensitive manner", () => {
+                    m.text = "/START";
+                    m.entities = [{
+                        type: "bot_command",
+                        offset: 0,
+                        length: 6,
+                    }];
+                    const ctx = new Context(update, api, me);
+                    assertFalse(
+                        Command.hasCommand("start", {
+                            ...options,
+                            ignoreCase: false,
+                        })(ctx),
+                    );
+
+                    m.text = "/start";
+                    m.entities = [{
+                        type: "bot_command",
+                        offset: 0,
+                        length: 6,
+                    }];
+                    assert(
+                        Command.hasCommand("start", {
+                            ...options,
+                            ignoreCase: false,
+                        })(ctx),
+                    );
+                });
+            });
+        });
     });
 
     describe("matchesPattern", () => {