export const metadata = { title: link-create-keys-modules-enum - ESLint plugin rules, }

{metadata.title}

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:

await link.create({
  product: { product_id: "1" },
})

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

import { Modules } from "@medusajs/framework/utils"

await link.create({
  [Modules.PRODUCT]: { product_id: "1" },
})

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:

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

export default defineConfig([
  ...medusa.configs.recommended,
  {
    rules: {
      "@medusajs/link-create-keys-modules-enum": "off",
    },
  },
])

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

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