additionnal changes for sonar integration

Author: Mathis Girault

eslint-plugin/docs/rules/avoid-getting-size-collection-in-loop.md

@@ -0,0 +1,22 @@
+# Should avoid getting the collection size in loop
+ 
+## Why is this an issue ?
+ 
+Accessing the size or length of a collection (such as arrays, maps, or sets) inside a loop can lead to unnecessary performance overhead, especially if the collection size is recalculated on each iteration. This rule warns when the size of a collection is accessed within a loop condition or body, encouraging developers to cache the size before the loop.
+ 
+### Examples of **incorrect** code
+ 
+```javascript
+for (let i = 0; i < array.length; i++) {
+  doSomething(array[i]);
+}
+```
+ 
+### Examples of **correct** code
+ 
+```javascript
+const len = array.length;
+for (let i = 0; i < len; i++) {
+  doSomething(array[i]);
+}
+```

eslint-plugin/lib/rules/getting-collection-size-in-collection.js renamed to eslint-plugin/lib/rules/avoid-getting-size-collection-in-loop.js

@@ -22,7 +22,7 @@
 // Requirements
 //------------------------------------------------------------------------------
 
-const rule = require("../../../lib/rules/getting-collection-size-in-collection");
+const rule = require("../../../lib/rules/avoid-getting-size-collection-in-loop");
 const RuleTester = require("eslint").RuleTester;
 
 //------------------------------------------------------------------------------
@@ -34,7 +34,7 @@ const expectedError = {
   messageId: "avoidSizeInLoop",
 };
 
-ruleTester.run("getting-collection-size-in-collection", rule, {
+ruleTester.run("avoid-getting-size-collection-in-loop", rule, {
   valid: [
     // size/length assigned before loop, not used in loop
     `

eslint-plugin/tests/lib/rules/getting-collection-size-in-collection.js renamed to eslint-plugin/tests/lib/rules/avoid-getting-size-collection-in-loop.js

@@ -37,6 +37,7 @@ public static List<Class<? extends JavaScriptCheck>> getAllChecks() {
                 AvoidAutoPlay.class,
                 AvoidBrightnessOverride.class,
                 AvoidCSSAnimations.class,
+                AvoidGettingSizeCollectionInLoop.class,
                 AvoidHighAccuracyGeolocation.class,
                 AvoidKeepAwake.class,
                 LimitDbQueryResult.class,

sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/CheckList.java

@@ -0,0 +1,38 @@
+/*
+ * Creedengo JavaScript plugin - Provides rules to reduce the environmental footprint of your JavaScript programs
+ * Copyright © 2023 Green Code Initiative (https://green-code-initiative.org)
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
+ */
+package org.greencodeinitiative.creedengo.javascript.checks;
+
+import org.greencodeinitiative.creedengo.javascript.DeprecatedEcoCodeRule;
+import org.sonar.check.Rule;
+import org.sonar.plugins.javascript.api.EslintBasedCheck;
+import org.sonar.plugins.javascript.api.JavaScriptRule;
+import org.sonar.plugins.javascript.api.TypeScriptRule;
+
+@JavaScriptRule
+@TypeScriptRule
+@Rule(key = AvoidGettingSizeCollectionInLoop.RULE_KEY)
+public class AvoidGettingSizeCollectionInLoop implements EslintBasedCheck {
+
+    public static final String RULE_KEY = "GCI3";
+
+    @Override
+    public String eslintKey() {
+        return "@creedengo/avoid-getting-size-collection-in-loop";
+    }
+
+}

sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidGettingSizeCollectionInLoop.java

@@ -1,6 +1,7 @@
 {
   "name": "Creedengo",
   "ruleKeys": [
+    "GCI3",
     "GCI9",
     "GCI11",
     "GCI12",

sonar-plugin/src/main/resources/org/greencodeinitiative/creedengo/profiles/javascript_profile.json

@@ -0,0 +1,10 @@
+// Non-compliant: the collection size is accessed (twice) in the loop
+for (let i = 0; i < array.length; i++) {
+	process("test"); // Noncompliant
+}
+
+// Compliant: no collection size access in loop
+const arrayLength = array.length; // Fetch the length once
+for (let i = 0; i < arrayLength; i++) {
+	console.log("yay"); // Compliant
+}