no-spread-in-workflow - ESLint plugin rules

This rule disallows spread (...) and rest (...) elements directly inside a createWorkflow constructor or a when().then() callback.

Severity#

error. This rule is enabled in the recommended preset.

What it Targets#

This rule targets files in your project's src/workflows directory. It reports spread and rest elements placed directly in a workflow's constructor or in a when().then() callback.

The following code is reported by the rule:

src/workflows/example.ts
1import {2  createWorkflow,3  WorkflowResponse,4} from "@medusajs/framework/workflows-sdk"5
6createWorkflow("my-workflow", (input) => {7  const merged = { ...input, extra: 1 }8  return new WorkflowResponse(merged)9})

Instead, wrap object or array manipulation in transform:

src/workflows/example.ts
1import {2  createWorkflow,3  transform,4  WorkflowResponse,5} from "@medusajs/framework/workflows-sdk"6
7createWorkflow("my-workflow", (input) => {8  const merged = transform({ input }, (data) => {9    return { ...data.input, extra: 1 }10  })11
12  return new WorkflowResponse(merged)13})

Why it's Important#

A workflow's constructor and when().then() callbacks run at definition time, not execution time. So, the spread or rest evaluates against placeholder values rather than the real data. Move the operation into transform or a createStep callback so it runs at execution time.

Learn more in the Workflows documentation.

Fixable#

This rule isn't auto-fixable.