Apply PR feedbacks

utarwyn · utarwyn · commit 8c307ebd5385 · 2025-01-10T22:33:44.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,20 +9,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
--   [#39](https://github.com/green-code-initiative/ecoCode-javascript/issues/39) Add rule `@creedengo/avoid-brightness-override` (GCI522)
--   [#41](https://github.com/green-code-initiative/ecoCode-javascript/pull/41) Add rule `@creedengo/no-torch` (GCI530)
+-   [#39](https://github.com/green-code-initiative/creedengo-javascript/issues/39) Add rule `@creedengo/avoid-brightness-override` (GCI522)
+-   [#41](https://github.com/green-code-initiative/creedengo-javascript/pull/41) Add rule `@creedengo/no-torch` (GCI530)
 -   Rename plugin to creedengo-javascript
 -   Add support for SonarQube up to 10.7
 
 ### Changed
 
--   [#44](https://github.com/green-code-initiative/ecoCode-javascript/pull/44) Implement the rule GCI523 for React Native
--   [#52](https://github.com/green-code-initiative/ecoCode-javascript/pull/52) Remove trailing dots in Sonar rules descriptions
+-   [#44](https://github.com/green-code-initiative/creedengo-javascript/pull/44) Implement the rule GCI523 for React Native
+-   [#52](https://github.com/green-code-initiative/creedengo-javascript/pull/52) Remove trailing dots in Sonar rules descriptions
 -   Update Docker Compose configuration file to V2
 
 ### Deleted
 
--   [#44](https://github.com/green-code-initiative/ecoCode-javascript/pull/44) Merge the rule EC8 with GCI523
+-   [#44](https://github.com/green-code-initiative/creedengo-javascript/pull/44) Merge the rule EC8 with GCI523
 
 ## [1.5.0] - 2024-03-13
 
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/DeprecatedEcoCodeRule.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/DeprecatedEcoCodeRule.java
@@ -29,7 +29,7 @@
 /**
  * Used to handle old ecoCode rule keys.
  */
-public class EcoCodeRule {
+public class DeprecatedEcoCodeRule {
 
     @Retention(RetentionPolicy.RUNTIME)
     @Target({ ElementType.TYPE })
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/JavaScriptRulesDefinition.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/JavaScriptRulesDefinition.java
@@ -47,7 +47,7 @@ public void define(Context context) {
         List<Class<?>> checks = Collections.unmodifiableList(CheckList.getJavaScriptChecks());
 
         ruleMetadataLoader.addRulesByAnnotatedClass(repository, checks);
-        EcoCodeRule.addOnRepository(repository, JavaScriptRuleRepository.OLD_KEY, checks);
+        DeprecatedEcoCodeRule.addOnRepository(repository, JavaScriptRuleRepository.OLD_KEY, checks);
 
         repository.done();
     }
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/TypeScriptRulesDefinition.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/TypeScriptRulesDefinition.java
@@ -47,7 +47,7 @@ public void define(Context context) {
         List<Class<?>> checks = Collections.unmodifiableList(CheckList.getTypeScriptChecks());
 
         ruleMetadataLoader.addRulesByAnnotatedClass(repository, checks);
-        EcoCodeRule.addOnRepository(repository, TypeScriptRuleRepository.OLD_KEY, checks);
+        DeprecatedEcoCodeRule.addOnRepository(repository, TypeScriptRuleRepository.OLD_KEY, checks);
 
         repository.done();
     }
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidBrightnessOverride.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidBrightnessOverride.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = AvoidBrightnessOverride.RULE_KEY)
-@EcoCodeRule.Key("EC522")
+@DeprecatedEcoCodeRule.Key("EC522")
 public class AvoidBrightnessOverride implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI522";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidCSSAnimations.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidCSSAnimations.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = AvoidCSSAnimations.RULE_KEY)
-@EcoCodeRule.Key("EC29")
+@DeprecatedEcoCodeRule.Key("EC29")
 public class AvoidCSSAnimations implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI29";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidHighAccuracyGeolocation.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/AvoidHighAccuracyGeolocation.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = AvoidHighAccuracyGeolocation.RULE_KEY)
-@EcoCodeRule.Key("EC8")
+@DeprecatedEcoCodeRule.Key("EC8")
 public class AvoidHighAccuracyGeolocation implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI523";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/LimitDbQueryResult.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/LimitDbQueryResult.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = LimitDbQueryResult.RULE_KEY)
-@EcoCodeRule.Key("EC24")
+@DeprecatedEcoCodeRule.Key("EC24")
 public class LimitDbQueryResult implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI24";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoEmptyImageSrcAttribute.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoEmptyImageSrcAttribute.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = NoEmptyImageSrcAttribute.RULE_KEY)
-@EcoCodeRule.Key("EC25")
+@DeprecatedEcoCodeRule.Key("EC25")
 public class NoEmptyImageSrcAttribute implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI25";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoImportAllFromLibrary.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoImportAllFromLibrary.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = NoImportAllFromLibrary.RULE_KEY)
-@EcoCodeRule.Key("EC9")
+@DeprecatedEcoCodeRule.Key("EC9")
 public class NoImportAllFromLibrary implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI9";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoMultipleAccessDomElement.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoMultipleAccessDomElement.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = NoMultipleAccessDomElement.RULE_KEY)
-@EcoCodeRule.Key("EC11")
+@DeprecatedEcoCodeRule.Key("EC11")
 public class NoMultipleAccessDomElement implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI11";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoMultipleStyleChanges.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoMultipleStyleChanges.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = NoMultipleStyleChanges.RULE_KEY)
-@EcoCodeRule.Key("EC12")
+@DeprecatedEcoCodeRule.Key("EC12")
 public class NoMultipleStyleChanges implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI12";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoTorch.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/NoTorch.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = NoTorch.RULE_KEY)
-@EcoCodeRule.Key("EC530")
+@DeprecatedEcoCodeRule.Key("EC530")
 public class NoTorch implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI530";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/PreferCollectionsWithPagination.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/PreferCollectionsWithPagination.java
@@ -17,14 +17,14 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+import org.greencodeinitiative.creedengo.javascript.DeprecatedEcoCodeRule;
 import org.sonar.check.Rule;
 import org.sonar.plugins.javascript.api.EslintBasedCheck;
 import org.sonar.plugins.javascript.api.TypeScriptRule;
 
 @TypeScriptRule
 @Rule(key = PreferCollectionsWithPagination.RULE_KEY)
-@EcoCodeRule.Key("EC13")
+@DeprecatedEcoCodeRule.Key("EC13")
 public class PreferCollectionsWithPagination implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI13";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/PreferShorthandCSSNotations.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/PreferShorthandCSSNotations.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = PreferShorthandCSSNotations.RULE_KEY)
-@EcoCodeRule.Key("EC26")
+@DeprecatedEcoCodeRule.Key("EC26")
 public class PreferShorthandCSSNotations implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI26";
diff --git a/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/ProvidePrintCSS.java b/sonar-plugin/src/main/java/org/greencodeinitiative/creedengo/javascript/checks/ProvidePrintCSS.java
@@ -17,7 +17,7 @@
  */
 package org.greencodeinitiative.creedengo.javascript.checks;
 
-import org.greencodeinitiative.creedengo.javascript.EcoCodeRule;
+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;
@@ -26,7 +26,7 @@
 @JavaScriptRule
 @TypeScriptRule
 @Rule(key = ProvidePrintCSS.RULE_KEY)
-@EcoCodeRule.Key("EC30")
+@DeprecatedEcoCodeRule.Key("EC30")
 public class ProvidePrintCSS implements EslintBasedCheck {
 
     public static final String RULE_KEY = "GCI30";

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ public void define(Context context) {`
`47`	`47`	`List<Class<?>> checks = Collections.unmodifiableList(CheckList.getJavaScriptChecks());`
`48`	`48`
`49`	`49`	`ruleMetadataLoader.addRulesByAnnotatedClass(repository, checks);`
`50`		`- EcoCodeRule.addOnRepository(repository, JavaScriptRuleRepository.OLD_KEY, checks);`
	`50`	`+ DeprecatedEcoCodeRule.addOnRepository(repository, JavaScriptRuleRepository.OLD_KEY, checks);`
`51`	`51`
`52`	`52`	`repository.done();`
`53`	`53`	`}`