step-id-kebab-case - ESLint plugin rules

This rule requires a step's ID, the first argument of createStep, to be a kebab-case string that matches the enclosing variable name or filename.

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 a createStep ID that isn't kebab-case or doesn't match the enclosing variable name or filename, with a trailing Step segment stripped.

The following code is reported by the rule:

src/workflows/example.ts
1import { createStep } from "@medusajs/framework/workflows-sdk"2
3export const fetchCustomersStep = createStep(4  "fetchCustomers",5  () => {}6)

Instead, use a kebab-case ID that matches the variable name:

src/workflows/example.ts
1import { createStep } from "@medusajs/framework/workflows-sdk"2
3export const fetchCustomersStep = createStep(4  "fetch-customers",5  () => {}6)

Why it's Important#

Using a consistent, kebab-case ID that matches the step's variable name or filename makes steps easier to identify in logs and traces.

Learn more in the Workflows documentation.

Fixable#

This rule is auto-fixable. Run the linter with the --fix option to apply the fix automatically.

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/step-id-kebab-case": "off",9    },10  },11])

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

Code
1// eslint-disable-next-line @medusajs/step-id-kebab-case2export const fetchCustomersStep = createStep()