org.sonar.l10n.javascript.rules.javascript.S1515.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?
Defining functions inside loops in JavaScript can lead to several issues and is generally considered bad practice. The main problems associated
with this approach are related to performance, scope, and potential unintended behavior:

   When a function is defined inside a loop, the function is re-created on each iteration of the loop. This can cause unnecessary overhead and
  lead to performance issues, especially if the loop runs repeatedly. Defining the function outside the loop is more efficient so that it is created
  only once. 
   Functions defined inside loops have access to the loop’s variables and parameters. This can sometimes lead to unintended behavior or bugs due
  to closures. Closures in JavaScript capture the environment in which they are created, including variables and parameters, and this can cause
  unexpected results when those variables change during the loop. 
   Code that defines functions inside loops can be harder to read and maintain, especially for other developers who might not expect functions to
  be redefined within the loop. Keeping functions separate and clearly defined is better, improving code organization and understandability. 

for (let i = 0; i < 5; i++) {
  function processItem(item) { // Noncompliant: Function 'processItem' inside a for loop
    // Some processing logic
    console.log(item);
  }

  processItem(i);
}

Define the function outside the loop and use the function parameters to pass any needed variables instead.
function processItem(item) {
  // Some processing logic
  console.log(item);
}

for (let i = 0; i < 5; i++) {
  processItem(i);
}

Resources
Documentation

   MDN web docs - Closures 
   MDN web docs - Scope