feat: command scoped middleware and devOnly function

Author: twlite

packages/commandkit/src/app/router/CommandsRouter.ts

@@ -20,6 +20,7 @@ export interface Middleware {
   relativePath: string;
   parentPath: string;
   global: boolean;
+  command: string | null;
 }
 
 export interface ParsedCommandData {
@@ -32,6 +33,8 @@ export interface CommandsRouterOptions {
 }
 
 const MIDDLEWARE_PATTERN = /^\+middleware\.(m|c)?(j|t)sx?$/;
+const COMMAND_MIDDLEWARE_PATTERN =
+  /^\+([^+().][^().]*)\.middleware\.(m|c)?(j|t)sx?$/;
 const GLOBAL_MIDDLEWARE_PATTERN = /^\+global-middleware\.(m|c)?(j|t)sx?$/;
 const COMMAND_PATTERN = /^([^+().][^().]*)\.(m|c)?(j|t)sx?$/;
 const CATEGORY_PATTERN = /^\(.+\)$/;
@@ -62,7 +65,9 @@ export class CommandsRouter {
 
   private isMiddleware(name: string): boolean {
     return (
-      MIDDLEWARE_PATTERN.test(name) || GLOBAL_MIDDLEWARE_PATTERN.test(name)
+      MIDDLEWARE_PATTERN.test(name) ||
+      GLOBAL_MIDDLEWARE_PATTERN.test(name) ||
+      COMMAND_MIDDLEWARE_PATTERN.test(name)
     );
   }
 
@@ -159,6 +164,9 @@ export class CommandsRouter {
         relativePath: this.replaceEntrypoint(path),
         parentPath: entry.parentPath,
         global: GLOBAL_MIDDLEWARE_PATTERN.test(name),
+        command: COMMAND_MIDDLEWARE_PATTERN.test(name)
+          ? name.split('.')[0] || null
+          : null,
       };
 
       this.middlewares.set(middleware.id, middleware);
@@ -170,9 +178,9 @@ export class CommandsRouter {
       const commandPath = command.parentPath;
       const samePathMiddlewares = Array.from(this.middlewares.values())
         .filter((middleware) => {
-          // if middleware's parent path is the same as command's parent path
-          // or if the middleware is global
-          return middleware.parentPath === commandPath || middleware.global;
+          if (middleware.global) return true;
+          if (middleware.command) return middleware.command === command.name;
+          return middleware.parentPath === commandPath;
         })
         .map((middleware) => middleware.id);
 

packages/commandkit/src/index.ts

@@ -16,7 +16,12 @@ export * from './app/router/index';
 export type * from './types';
 export * from './version';
 export * from './plugins/index';
-export { getCurrentDirectory, getSourceDirectories } from './utils/utilities';
+export {
+  getCurrentDirectory,
+  getSourceDirectories,
+  devOnly,
+  debounce,
+} from './utils/utilities';
 export type { CommandKitHMREvent } from './utils/dev-hooks';
 export * from './utils/constants';
 

packages/commandkit/src/utils/utilities.ts

@@ -88,3 +88,25 @@ export function debounce<R, F extends (...args: any[]) => R>(
     });
   }) as F;
 }
+
+/**
+ * Creates a function from the given function that runs only in development mode.
+ * @param fn The function to run in development mode.
+ * @returns The function that runs only in development mode.
+ * @example
+ * ```ts
+ * const devOnlyFn = devOnly(() => {
+ *   console.log('This function runs only in development mode');
+ * });
+ * devOnlyFn(); // This will log the message only in development mode
+ * ```
+ */
+export function devOnly<T extends (...args: any[]) => any>(fn: T): T {
+  const f = (...args: Parameters<T>) => {
+    if (COMMANDKIT_IS_DEV) {
+      return fn(...args);
+    }
+  };
+
+  return f as T;
+}