prefer-link-over-remote-link - ESLint plugin rules

This rule requires you to use Link instead of RemoteLink, which is deprecated since Medusa v2.2.0.

Severity#

warn. This rule is enabled in the recommended preset.

What it Targets#

This rule targets files anywhere in your project. It reports usages of the deprecated remote link, including:

• Resolving the "remoteLink" registration key.
• Using ContainerRegistrationKeys.REMOTE_LINK.
• Importing the RemoteLink or IRemoteLink types.

The following code is reported by the rule:

src/workflows/steps/create-link.ts
1import { RemoteLink } from "@medusajs/framework/types"2
3const link = container.resolve("remoteLink")

Instead, use the "link" registration key and the Link type:

src/workflows/steps/create-link.ts
1import { Link } from "@medusajs/framework/types"2
3const link = container.resolve("link")

You can also resolve the link using ContainerRegistrationKeys.LINK:

src/workflows/steps/create-link.ts
1import {2  ContainerRegistrationKeys,3} from "@medusajs/framework/utils"4
5const link = container.resolve(6  ContainerRegistrationKeys.LINK7)

Why it's Important#

RemoteLink is deprecated since Medusa v2.2.0 and may be removed in a future version. Using Link keeps your code aligned with the supported API.

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/prefer-link-over-remote-link": "off",9    },10  },11])

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

Code
1// eslint-disable-next-line @medusajs/prefer-link-over-remote-link2const link = container.resolve("remoteLink")