ui-route-file-name-page-tsx - ESLint plugin rules

This rule requires UI route files under src/admin/routes to be named page.tsx.

Severity#

error. This rule is enabled in the recommended preset.

What it Targets#

This rule targets files in your project's src/admin/routes directory. It reports a file that uses defineRouteConfig but isn't named page.tsx.

The following code is reported by the rule:

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

Instead, rename the file to page.tsx:

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

Why it's Important#

Medusa only registers UI routes from files named page.tsx. A route defined in a differently named file won't be added to the admin dashboard.

Learn more in the UI Routes documentation.

Fixable#

This rule isn't auto-fixable.