api-contracts/no-misleading-function-names

Named implementation functions should fulfill concrete promises made by their names when their behavior is visible in the same file.

namingfunctionsbehavior

01 Examples

TypeScript

function deleteUser(id: string) { return db.users.find(id); }

Finding

Disallow names that contradict visible behavior.

02 Enable it

Setup

Install the package, register its plugin factory, then enable the rule.

pnpm add -D @scruple/api-contracts

In scruple.config.ts, register the factory under the api-contracts namespace used by the rule ID.

import { apiContracts } from "@scruple/api-contracts";

plugins: {
  "api-contracts": apiContracts(),
},

"api-contracts/no-misleading-function-names": "warn"