export const metadata = { title: no-console-log-in-workflow - ESLint plugin rules, }

{metadata.title}

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:

import {
  createWorkflow,
  WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"

createWorkflow("my-workflow", (input) => {
  console.log("definition-time")
  return new WorkflowResponse(input)
})

Instead, move logging into a createStep callback:

import {
  createWorkflow,
  createStep,
  WorkflowResponse,
} from "@medusajs/framework/workflows-sdk"

const logStep = createStep("log", (input) => {
  console.log("execution-time")
})

createWorkflow("my-workflow", (input) => {
  logStep(input)

  return new WorkflowResponse(input)
})

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:

import { defineConfig } from "eslint/config"
import medusa from "@medusajs/eslint-plugin"

export default defineConfig([
  ...medusa.configs.recommended,
  {
    rules: {
      "@medusajs/no-console-log-in-workflow": "off",
    },
  },
])

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

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