no-trailing-slash-in-route-matcher - ESLint plugin rules

This rule disallows route matchers passed to defineMiddlewares from ending with a trailing slash.

Severity#

warn. This rule is enabled in the recommended preset.

What it Targets#

This rule targets the src/api/middlewares.ts file. It reports a matcher string that ends with a trailing slash.

The following code is reported by the rule:

src/api/middlewares.ts
1export default defineMiddlewares({2  routes: [3    { matcher: "/store/custom/", middlewares: [] },4  ],5})

Instead, remove the trailing slash:

src/api/middlewares.ts
1export default defineMiddlewares({2  routes: [3    { matcher: "/store/custom", middlewares: [] },4  ],5})

Why it's Important#

A matcher with a trailing slash doesn't match the same URLs as one without it, so the middleware may not run on the routes you expect. Removing the trailing slash keeps the matcher consistent with route paths.

Learn more in the Middlewares 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/no-trailing-slash-in-route-matcher": "off",9    },10  },11])

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

Code
1// eslint-disable-next-line @medusajs/no-trailing-slash-in-route-matcher2{ matcher: "/store/custom/", middlewares: [] },