enforce-rest-conventions

Report a route registration whose static path names a singular resource (/user rather than /users).

This rule is part of eslint-plugin-modularity.

Quick SummaryCopy Anchor Link

Rule DetailsCopy Anchor Link

The rule reads route registrations: a call of get, post, put, patch, delete, head or options on any object (app.get(...), router['post'](...)). When the first argument is a static string that starts with /, the rule reports it if its first segment:

• does not end in s, and
• is longer than three characters, and
• the path has no route parameter (:) anywhere.

It does not report a path with a parameter (/user/:id), the root (/), a plural path (/orders), or a path built at run time.

Heuristic. Whether a segment is a singular noun is read from its spelling, so non-resource endpoints such as /health, /login or /search are reported too, and a get call on a non-router object that takes a path-like string is read as a route. Turn checkResourceNaming off where that does not fit.

ConfigurationCopy Anchor Link

ExamplesCopy Anchor Link

❌ IncorrectCopy Anchor Link

app.get('/order', listOrders);
router.post('/invoice', createInvoice);

✅ CorrectCopy Anchor Link

app.get('/orders', listOrders);
app.get('/orders/:id', getOrder);
router.post('/invoices', createInvoice);

Configuration ExamplesCopy Anchor Link

// eslint.config.mjs
export default [
  {
    rules: {
      'modularity/enforce-rest-conventions': ['error', { checkResourceNaming: true }],
    },
  },
];

Related RulesCopy Anchor Link

• no-external-api-calls-in-utils - Keep network calls out of utilities

Use this rule

npm install -D oxlint-plugin-modularity

{  "jsPlugins": ["oxlint-plugin-modularity"],  "rules": {    "modularity/enforce-rest-conventions": "error"  }}

import { defineConfig } from 'vite-plus';export default defineConfig({  lint: {    jsPlugins: ['oxlint-plugin-modularity'],    rules: {      'modularity/enforce-rest-conventions': 'error',    },  },});