ui-route-config-via-define-route-config - ESLint plugin rules

This rule requires a UI route config export to be initialized with defineRouteConfig.

Severity#

warn. This rule is enabled in the recommended preset.

What it Targets#

This rule targets page.tsx files in your project's src/admin/routes directory. It reports a config export that isn't initialized with defineRouteConfig from @medusajs/admin-sdk.

The following code is reported by the rule:

src/admin/routes/custom/page.tsx
1const CustomPage = () => <>Custom</>2
3export const config = {4  label: "Custom",5}6
7export default CustomPage

Instead, initialize config with defineRouteConfig:

src/admin/routes/custom/page.tsx
1import { defineRouteConfig } from "@medusajs/admin-sdk"2
3const CustomPage = () => <>Custom</>4
5export const config = defineRouteConfig({6  label: "Custom",7})8
9export default CustomPage

Why it's Important#

The defineRouteConfig helper provides the expected type and structure for a route's sidebar configuration, so Medusa can register the route correctly.

Learn more in the UI Routes documentation.

Fixable#

This rule isn't auto-fixable.

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/ui-route-config-via-define-route-config": "off",9    },10  },11])

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

Code
1// eslint-disable-next-line @medusajs/ui-route-config-via-define-route-config2export const config = {