Clean code attributes and better descriptions complying with Sonar Coding rule guidelines

ecocode-rules-specifications/src/main/rules/EC1/EC1.json

@@ -1,16 +1,17 @@
 {
-  "title": "Avoid Spring repository call in loop or stream operations",
+  "title": "Spring repository should not be called in loop or stream operations",
   "type": "CODE_SMELL",
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "50min"
   },
-  "tags": [
-    "performance",
-    "spring",
-    "eco-design",
-    "ecocode"
-  ],
-  "defaultSeverity": "Minor"
+  "tags": [ "performance", "spring", "eco-design", "ecocode" ],
+  "defaultSeverity": "Minor",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "LOW"
+    },
+    "attribute": "EFFICIENT"
+  }
 }

ecocode-rules-specifications/src/main/rules/EC1/java/EC1.asciidoc

@@ -1,9 +1,16 @@
+:!sectids:
+
+== Why is this an issue?
+
 The use of Spring repository in a loop induces unnecessary calculations by the CPU and therefore superfluous energy consumption.
 Also, the use of Spring repository in a stream operation like "peek, forEach, forEachOrdered, map" induces unnecessary multiple access to the database instead of single batch call.
 
-## Noncompliant Code Example
+== How to fix it
+=== Noncompliant code example
 
-```java
+[source,java]
+----
+// Noncompliant
 private final List<Integer> ids = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
 
 List<Employee> employees = new ArrayList<>();
@@ -14,9 +21,11 @@ for (Integer id: ids) {
         employees.add(employee.get());
     }
 }
-```
+----
 
-```java
+[source,java]
+----
+// Noncompliant
 List<Employee> employees = new ArrayList<>();
 Stream stream = Stream.of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
 stream.forEach(id -> {
@@ -25,16 +34,22 @@ stream.forEach(id -> {
         employees.add(employee.get());
     }
 });
-```
+----
 
-## Compliant Solution
+=== Compliant solution
 
-```java
+[source,java]
+----
 private final List<Integer> ids = Arrays.asList(1, 2, 3, 4, 5, 6, 7, 8, 9, 10);
 List<Employee> employees = employeeRepository.findAllById(ids);
-```
+----
 
-```java
+[source,java]
+----
 private final List<Integer> ids = Stream.of(1, 2, 3, 4, 5, 6, 7, 8, 9, 10).toList();
 List<Employee> employees = employeeRepository.findAllById(ids);
-```
+----
+
+== Resources
+
+Reference/Validation is unknown.

ecocode-rules-specifications/src/main/rules/EC10/EC10.json

@@ -1,14 +1,17 @@
 {
-  "title": "Avoid using unoptimized vector images",
+  "title": "Unoptimized vector images should be avoided",
   "type": "CODE_SMELL",
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "60min"
   },
-  "tags": [
-    "eco-design",
-    "ecocode"
-  ],
-  "defaultSeverity": "Minor"
+  "tags": [ "eco-design", "ecocode", "performance" ],
+  "defaultSeverity": "Minor",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "LOW"
+    },
+    "attribute": "EFFICIENT"
+  }
 }

ecocode-rules-specifications/src/main/rules/EC10/python/EC10.asciidoc

@@ -1,8 +1,15 @@
+:!sectids:
+
+== Why is this an issue?
+
 SVG images generated by common drawing softwares contains unnecessary data: calc layer, metadata, namespaces and comments.
 
-## Noncompliant Code Example
+== How to fix it
+=== Noncompliant code example
 
-```xml
+[source,xml]
+----
+<!-- Noncompliant -->
 <!-- Created with Inkscape (http://www.inkscape.org/) -->
 <svg
     width="210mm"
@@ -28,12 +35,17 @@ SVG images generated by common drawing softwares contains unnecessary data: calc
             r="73.177132" />
     </g>
 </svg>
-```
+----
 
-## Compliant Solution
+=== Compliant solution
 
-```xml
+[source,xml]
+----
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 210 297" width="210mm" height="297mm">
     <circle cx="104.02724" cy="152.19028" r="73.177132" style="fill:#ff00ff;stroke-width:0.264583"/>
 </svg>
-```
+----
+
+== Resources
+
+- https://github.com/cnumr/best-practices/blob/main/chapters/BP_036_fr.md[CNumR best practices (3rd edition) BP_036]

ecocode-rules-specifications/src/main/rules/EC11/EC11.json

@@ -1,25 +1,18 @@
 {
-  "title": "Disallow multiple access of same DOM element.",
+  "title": "DOM manipulation should be limited",
   "type": "CODE_SMELL",
-  "code": {
-    "impacts": {
-      "MAINTAINABILITY": "MEDIUM"
-    },
-    "attribute": "EFFICIENT"
-  },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
-  "tags": [
-    "ecocode",
-    "eco-design",
-    "performance"
-  ],
+  "tags": [ "ecocode", "eco-design", "performance" ],
   "defaultSeverity": "Major",
-  "compatibleLanguages": [
-    "JAVASCRIPT",
-    "TYPESCRIPT"
-  ]
+  "code": {
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    },
+    "attribute": "EFFICIENT"
+  },
+  "compatibleLanguages": [ "JAVASCRIPT", "TYPESCRIPT" ]
 }

ecocode-rules-specifications/src/main/rules/EC11/javascript/EC11.asciidoc

@@ -10,14 +10,19 @@ Assigning the DOM object to a variable not only improves performance but also en
 It makes the code more concise and self-explanatory.
 Developers reading the code can understand that the variable holds a reference to a specific DOM element, and its subsequent use is likely for multiple operations.
 
+== How to fix it
+=== Noncompliant code example
+
 Here's an example in JavaScript to illustrate this rule:
 
 [source,js,data-diff-id="2",data-diff-type="noncompliant"]
 ----
 const width = document.getElementById('block').clientWidth;
-const height = document.getElementById('block').clientHeight; // Non-compliant
+const height = document.getElementById('block').clientHeight; // Noncompliant
 ----
 
+=== Compliant solution
+
 [source,js,data-diff-id="1",data-diff-type="noncompliant"]
 ----
 const blockElement = document.getElementById('block'); // Compliant
@@ -32,5 +37,5 @@ In the second example, the DOM element reference is cached in the `blockElement`
 
 === Documentation
 
-- https://github.com/cnumr/best-practices/blob/main/chapters/BP_054_en.md[CNUMR best practices] - Reduce DOM access via JavaScript
+- https://github.com/cnumr/best-practices/blob/main/chapters/BP_054_en.md[CNumR best practices] - Reduce DOM access via JavaScript
 - https://developer.mozilla.org/en-US/docs/Learn/Performance/JavaScript#tips_for_writing_more_efficient_code[Mozilla Web Technology for Developers] - Tips for writing more efficient code

ecocode-rules-specifications/src/main/rules/EC12/EC12.json

@@ -1,25 +1,18 @@
 {
-  "title": "Disallow multiple style changes at once.",
+  "title": "Multiple style changes should be batched",
   "type": "CODE_SMELL",
-  "code": {
-    "impacts": {
-      "MAINTAINABILITY": "MEDIUM"
-    },
-    "attribute": "EFFICIENT"
-  },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "10min"
   },
-  "tags": [
-    "ecocode",
-    "eco-design",
-    "performance"
-  ],
+  "tags": [ "ecocode", "eco-design", "performance" ],
   "defaultSeverity": "Major",
-  "compatibleLanguages": [
-    "JAVASCRIPT",
-    "TYPESCRIPT"
-  ]
+  "code": {
+    "impacts": {
+      "RELIABILITY": "MEDIUM"
+    },
+    "attribute": "EFFICIENT"
+  },
+  "compatibleLanguages": [ "JAVASCRIPT", "TYPESCRIPT" ]
 }

ecocode-rules-specifications/src/main/rules/EC12/javascript/EC12.asciidoc

@@ -10,17 +10,22 @@ Making multiple CSS changes in a single batch can trigger multiple reflows and r
 Reflows and repaints are resource-intensive operations that can lead to performance issues.
 Applying changes individually minimizes the number of reflows and repaints, improving overall page performance.
 
+== How to fix it
+=== Noncompliant code example
+
 Here's an example in JavaScript and CSS to illustrate this rule:
 
 [source,html,data-diff-id="3",data-diff-type="noncompliant"]
 ----
 <script>
   element.style.height = "800px";
-  element.style.width = "600px"; // Non-compliant
-  element.style.color = "red"; // Non-compliant
+  element.style.width = "600px"; // Noncompliant
+  element.style.color = "red"; // Noncompliant
 </script>
 ----
 
+=== Compliant solution
+
 [source,html,data-diff-id="10",data-diff-type="compliant"]
 ----
 <style>
@@ -42,4 +47,4 @@ In the first example, multiple CSS properties are set in a single batch, while i
 
 === Documentation
 
-- https://github.com/cnumr/best-practices/blob/main/chapters/BP_045_en.md[CNUMR best practices] - Modify several CSS properties at once
+- https://github.com/cnumr/best-practices/blob/main/chapters/BP_045_en.md[CNumR best practices] - Modify several CSS properties at once

ecocode-rules-specifications/src/main/rules/EC13/EC13.json

@@ -1,25 +1,18 @@
 {
-  "title": "Prefer API collections with pagination.",
+  "title": "API collections should be preferred with pagination",
   "type": "CODE_SMELL",
   "code": {
     "impacts": {
-      "MAINTAINABILITY": "MEDIUM"
+      "RELIABILITY": "MEDIUM"
     },
     "attribute": "EFFICIENT"
   },
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "30min"
   },
-  "tags": [
-    "ecocode",
-    "eco-design",
-    "nestjs",
-    "performance"
-  ],
+  "tags": [ "ecocode", "eco-design", "nestjs", "performance" ],
   "defaultSeverity": "Major",
-  "compatibleLanguages": [
-    "TYPESCRIPT"
-  ]
+  "compatibleLanguages": [ "TYPESCRIPT" ]
 }

ecocode-rules-specifications/src/main/rules/EC13/javascript/EC13.asciidoc

@@ -11,15 +11,20 @@ Pagination ensures that only the relevant data is transferred, conserving bandwi
 
 This rule is built for the https://nestjs.com[NestJS framework] but can work with a controller `@Controller()` and a decorated method `@Get()`.
 
+== How to fix it
+=== Noncompliant code example
+
 [source,typescript,data-diff-id="4",data-diff-type="noncompliant"]
 ----
 @Controller()
 class Test {
   @Get()
-  public find(): Promise<string[]> {} // Non-compliant
+  public find(): Promise<string[]> {} // Noncompliant
 }
 ----
 
+=== Compliant solution
+
 [source,typescript,data-diff-id="10",data-diff-type="compliant"]
 ----
 interface Pagination {
@@ -39,7 +44,7 @@ class Test {
 
 === Documentation
 
-- https://github.com/cnumr/best-practices/blob/main/chapters/BP_076_en.md[CNUMR best practices] - Avoid transferring large amounts of data for processing tasks
+- https://github.com/cnumr/best-practices/blob/main/chapters/BP_076_en.md[CNumR best practices] - Avoid transferring large amounts of data for processing tasks
 - https://github.com/ppetzold/nestjs-paginate[nestjs-paginate] - Pagination and filtering helper method using Nest.js framework
 
 === Articles & blog posts

ecocode-rules-specifications/src/main/rules/EC2/EC2.json

@@ -1,15 +1,17 @@
 {
-  "title": "Avoid multiple if-else statement",
+  "title": "Variables should not be used in multiple if...else statements",
   "type": "CODE_SMELL",
   "status": "ready",
   "remediation": {
-    "func": "Constant\/Issue",
+    "func": "Constant/Issue",
     "constantCost": "5min"
   },
-  "tags": [
-    "eco-design",
-    "performance",
-    "ecocode"
-  ],
-  "defaultSeverity": "Minor"
+  "tags": [ "eco-design", "performance", "ecocode" ],
+  "defaultSeverity": "Minor",
+  "code": {
+    "impacts": {
+      "RELIABILITY": "LOW"
+    },
+    "attribute": "EFFICIENT"
+  }
 }