middlewares-file-location-and-name - ESLint plugin rules

This rule requires middlewares to be defined in src/api/middlewares.ts with a default export of defineMiddlewares.

Severity#

error. This rule is enabled in the recommended preset.

What it Targets#

This rule targets the src/api/middlewares.ts file. It reports a middleware file with the wrong name, such as a singular middleware.ts, a file in the wrong directory, or a canonical file that doesn't default-export defineMiddlewares.

The following code is reported by the rule, since the file uses the singular name:

src/api/middleware.ts
1import { defineMiddlewares } from "@medusajs/framework/http"2
3export default defineMiddlewares({ routes: [] })

Instead, use the plural middlewares.ts name at the canonical location:

src/api/middlewares.ts
1import { defineMiddlewares } from "@medusajs/framework/http"2
3export default defineMiddlewares({ routes: [] })

Why it's Important#

Medusa only loads middlewares from src/api/middlewares.ts with a default export of defineMiddlewares. A file with another name or location is ignored, so its middlewares never run.

Learn more in the Middlewares documentation.

Fixable#

This rule isn't auto-fixable.