link-create-keys-modules-enum - ESLint plugin rules

This rule requires you to use Modules enum members instead of bare string keys in link calls and remote-link workflow steps.

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 bare string keys that match a Modules enum value in:

• link.create, link.dismiss, link.delete, and link.restore calls.
• Remote-link workflow steps such as createRemoteLinkStep and dismissRemoteLinkStep.

The following code is reported by the rule:

src/workflows/steps/link.ts
1await link.create({2  product: { product_id: "1" },3})

Instead, use the matching Modules enum member as a computed key:

src/workflows/steps/link.ts
1import { Modules } from "@medusajs/framework/utils"2
3await link.create({4  [Modules.PRODUCT]: { product_id: "1" },5})

Why it's Important#

The Modules enum gives you a single source of truth for module keys. Using it avoids typos in string keys and keeps your links consistent with Medusa's module names.

Learn more in the Module Links 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/link-create-keys-modules-enum": "off",9    },10  },11])

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

Code
1// eslint-disable-next-line @medusajs/link-create-keys-modules-enum2await link.create({ product: { product_id: "1" } })