import-from-framework-not-internal - ESLint plugin rules

This rule requires using the public @medusajs/framework/* entry points, and disallows importing from a package's internal dist/ build output or from deprecated standalone packages.

Severity#

warn. This rule is enabled in the recommended preset.

What it Targets#

This rule targets all files in your project. It reports imports and re-exports from deprecated standalone packages, such as @medusajs/utils, and from internal dist/ build output, such as @medusajs/medusa/dist/....

The following code is reported by the rule:

src/api/example.ts
1// non-compliant2import { MedusaError } from "@medusajs/utils"

Instead, import from the Medusa Framework entry point:

src/api/example.ts
1// compliant2import { MedusaError } from "@medusajs/framework/utils"

Why it's Important#

The @medusajs/framework/* entry points are the supported public surface. Deprecated packages and internal build paths can change or disappear between versions, breaking your project.

Fixable#

This rule is auto-fixable for some paths. For example, the rule can fix an import of @medusajs/utils to @medusajs/framework/utils. 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/import-from-framework-not-internal": "off",9    },10  },11])

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

Code
1// eslint-disable-next-line @medusajs/import-from-framework-not-internal2import { MedusaError } from "@medusajs/utils"