func-name-matching

A function expression can have a name that's different from the variable or property that holds it. Stack traces then show one name while the rest of the code calls the other, so if you search for the name from the trace, you won't find any callers.

Only named function expressions are checked. Arrow functions and function () {} are never reported.

Configure

Off by default. To turn it on:

[lint.rules]
"func-name-matching" = "error" # or "warn"

Every option, set to its default:

[lint.rules]
"func-name-matching" = [
  "error",
  "always", # "always" or "never"
  {
    considerPropertyDescriptor = false,
    includeCommonJSModuleExports = false,
  },
]

Examples

Reported:

const loadUser = function fetchUser(id) {
  return db.users.get(id);
};

api.remove = function destroy(id) {};

const handlers = {
  onSave: function save() {},
};

Not reported:

const loadUser = function loadUser(id) {
  return db.users.get(id);
};

api.remove = function remove(id) {};

const handlers = {
  onSave: function onSave() {},
  onClose: function () {},
};

Options

[lint.rules]
func-name-matching = ["error", "always", { considerPropertyDescriptor = true }]

The first option is a string. You can leave it out and pass only the object.

Option	What it does
"always" (default)	The two names must be the same.
"never"	The two names must be different.

Option	Default	What it does
considerPropertyDescriptor	false	In a property descriptor, compare the value function's name with the property being defined.
includeCommonJSModuleExports	false	Also check module.exports = function name() {}. The property is exports, so that's the name it's compared with.

const loadUser = function loadUser(id) {};

considerPropertyDescriptor

This applies to Object.defineProperty, Reflect.defineProperty, Object.defineProperties and Object.create. Without the option, the function below is compared with its key, value, and reported:

Object.defineProperty(user, "save", {
  value: function save() {},
});

Object.defineProperty(user, "save", {
  value: function save() {},
});

includeCommonJSModuleExports

module.exports = function createServer() {};

module.exports = function createServer() {};