feat: allow overriding which command to run in the workspace via a ta…

…sk option

lib/schemas/src/tasks.ts

@@ -14,6 +14,7 @@ import { SmokeTestSchema } from './tasks/n-test'
 import { CypressSchema } from './tasks/cypress'
 import { HerokuProductionSchema } from './tasks/heroku-production'
 import { ServerlessRunSchema } from './tasks/serverless-run'
+import { WorkspaceCommandSchema } from './tasks/workspace-command'
 
 export const TaskSchemas = {
   Babel: BabelSchema,
@@ -30,7 +31,8 @@ export const TaskSchemas = {
   ServerlessRun: ServerlessRunSchema,
   TypeScript: TypeScriptSchema,
   UploadAssetsToS3: UploadAssetsToS3Schema,
-  Webpack: WebpackSchema
+  Webpack: WebpackSchema,
+  WorkspaceCommand: WorkspaceCommandSchema
 }
 
 export type TaskOptions = InferSchemaOptions<typeof TaskSchemas>

lib/schemas/src/tasks/workspace-command.ts

@@ -0,0 +1,9 @@
+import { z } from 'zod'
+
+export const WorkspaceCommandSchema = z.object({
+  command: z.string().optional()
+})
+
+export type WorkspaceCommandOptions = z.infer<typeof WorkspaceCommandSchema>
+
+export const Schema = WorkspaceCommandSchema

plugins/monorepo/package.json

@@ -28,6 +28,7 @@
     "dotcom-tool-kit": "3.x"
   },
   "dependencies": {
+    "@dotcom-tool-kit/schemas": "^1.0.0",
     "@npmcli/map-workspaces": "^3.0.6"
   },
   "devDependencies": {

plugins/monorepo/src/tasks/workspace-command.ts

@@ -5,8 +5,9 @@ import path from 'path'
 import { loadConfig } from 'dotcom-tool-kit/lib/config'
 import { runTasksFromConfig } from 'dotcom-tool-kit/lib/tasks'
 import { ToolKitError } from '@dotcom-tool-kit/error'
+import { WorkspaceCommandSchema } from '@dotcom-tool-kit/schemas/lib/tasks/workspace-command'
 
-export default class WorkspaceCommand extends Task {
+export default class WorkspaceCommand extends Task<{ task: typeof WorkspaceCommandSchema }> {
   async runPackageCommand(packageId: string, packagePath: string, command: string, files?: string[]) {
     const config = await loadConfig(this.logger, { root: packagePath })
 
@@ -20,7 +21,9 @@ export default class WorkspaceCommand extends Task {
     const workspaces = await mapWorkspaces({ cwd, pkg })
 
     const results = await Promise.allSettled(
-      Array.from(workspaces, ([id, packagePath]) => this.runPackageCommand(id, packagePath, command, files))
+      Array.from(workspaces, ([id, packagePath]) =>
+        this.runPackageCommand(id, packagePath, this.options.command ?? command, files)
+      )
     )
 
     const erroredCommands = results.filter(
@@ -29,7 +32,7 @@ export default class WorkspaceCommand extends Task {
 
     if (erroredCommands.length) {
       // TODO improve error messages
-      const error = new ToolKitError(`error running workspace command ${command}`)
+      const error = new ToolKitError(`error running workspace command ${this.options.command ?? command}`)
       error.details = erroredCommands.map((result) => result.reason.toString()).join('\n\n')
       throw error
     }

plugins/monorepo/tsconfig.json

@@ -7,6 +7,9 @@
   "references": [
     {
       "path": "../../lib/base"
+    },
+    {
+      "path": "../../lib/schemas"
     }
   ],
   "include": ["src/**/*"]