Merge pull request #9 from green-code-initiative/ISSUE_4

[EC66] deprecation of EC66 rule for Python
green-code-initiative · Dec 15, 2023 · d813f4e · d813f4e
2 parents 2e86afb + 16cae3e
commit d813f4e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Deleted
 
+- [#4](https://github.com/green-code-initiative/ecoCode-python/issues/4) Deprecate rule EC66 for Python because not applicable (see details inside issue)
+
 ## [1.4.0] - 2023-08-08
 
 ### Added

diff --git a/src/main/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteCheck.java b/src/main/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteCheck.java
@@ -23,6 +23,11 @@
 import org.sonar.plugins.python.api.tree.StringLiteral;
 import org.sonar.plugins.python.api.tree.Tree;
 
+/**
+ * @deprecated not applicable for Python
+ * (check discussion inside issue https://github.com/green-code-initiative/ecoCode-python/issues/4)
+ */
+@Deprecated(forRemoval = true)
 @Rule(key = "EC66")
 public class AvoidDoubleQuoteCheck extends PythonSubscriptionCheck {
     public static final String MESSAGE_RULE = "Avoid using quotation mark (\"), prefer using simple quote (')";

diff --git a/src/test/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteTest.java b/src/test/java/fr/greencodeinitiative/python/checks/AvoidDoubleQuoteTest.java
@@ -20,6 +20,7 @@
 import org.junit.Test;
 import org.sonar.python.checks.utils.PythonCheckVerifier;
 
+@Deprecated
 public class AvoidDoubleQuoteTest {
     @Test
     public void test() {