no-console-log-in-workflow - ESLint plugin rules

This rule disallows console.log and other console.* calls directly inside a createWorkflow constructor or a when().then() callback.

Severity#

warn. This rule is enabled in the recommended preset.

What it Targets#

This rule targets files in your project's src/workflows directory. It reports console.* calls 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  console.log("definition-time")8  return new WorkflowResponse(input)9})

Instead, move logging into a createStep callback:

src/workflows/example.ts
1import {2  createWorkflow,3  createStep,4  WorkflowResponse,5} from "@medusajs/framework/workflows-sdk"6
7const logStep = createStep("log", (input) => {8  console.log("execution-time")9})10
11createWorkflow("my-workflow", (input) => {12  logStep(input)13
14  return new WorkflowResponse(input)15})

Why it's Important#

A workflow's constructor and when().then() callbacks run at definition time, not execution time. So, a console.* call there only logs when the workflow is registered, not on each execution. Move logging into a createStep callback so it runs every time the workflow executes.

Learn more in the Debugging Workflows documentation.

Fixable#

This rule isn't auto-fixable.

Turn it Off#

To turn off this rule, set it to off in your ESLint configuration:

eslint.config.ts
1import { defineConfig } from "eslint/config"2import medusa from "@medusajs/eslint-plugin"3
4export default defineConfig([5  ...medusa.configs.recommended,6  {7    rules: {8      "@medusajs/no-console-log-in-workflow": "off",9    },10  },11])

Or disable it for a single line using an inline comment:

Code
1// eslint-disable-next-line @medusajs/no-console-log-in-workflow2console.log("definition-time")