org.sonar.l10n.javascript.rules.javascript.S2234.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of javascript-checks Show documentation

There is a newer version: 10.20.0.29356

Why is this an issue?
Consistent naming between arguments and parameters reduces the chances of making mistakes, such as passing the wrong value to a parameter or
omitting an argument in a function call. When the names of arguments in a function call match the names of the function parameters, it contributes to
clearer, more readable code.
However, when the names match but are passed in a different order than their declaration in the function signature, it may indicate a mistake in
the parameter order, likely leading to unexpected results.
function divide(dividend, divisor) {
  return dividend / divisor;
}

function doTheThing() {
  const dividend = 15;
  const divisor = 5;

  const result = divide(divisor, dividend); // Noncompliant: not the expected result
  //...
}

Ensure that the arguments passed to the function are in the correct order, according to the function signature.
function divide(dividend, divisor) {
  return dividend / divisor;
}

function doTheThing() {
  const dividend = 15;
  const divisor = 5;

  const result = divide(dividend, divisor);
  //...
}

Exceptions
Swapped arguments that are compared beforehand in an enclosing if statement are ignored:
function divide(dividend, divisor) {
  return dividend / divisor;
}

function doTheThing() {
  const dividend = 5;
  const divisor = 15;
  if (divisor > dividend) {
    const result = divide(divisor, dividend);
    //...
  }
}

Resources
Documentation

   MDN web docs - Functions