Merge pull request #193 from xonixx/remove_trailing_semicolon

Remove trailing semicolon
xonixx · May 15, 2023 · 385e891 · 385e891
2 parents 04525d1 + 278cc0e
commit 385e891
Show file tree

Hide file tree

Showing 15 changed files with 124 additions and 2 deletions.
diff --git a/src/main/java/intellij_awk/Awk.bnf b/src/main/java/intellij_awk/Awk.bnf
@@ -250,7 +250,9 @@ private statement_for ::=
 
 statement_for_conditions ::= simple_statement_opt SEMICOLON newlines_opt expr_opt SEMICOLON newlines_opt simple_statement_opt
 
-private terminator       ::= (NEWLINE|SEMICOLON) newlines_opt
+semicolonPsi ::= SEMICOLON
+
+private terminator       ::= (NEWLINE|semicolonPsi) newlines_opt
 
 gawk_statement_switch ::= SWITCH LPAREN expr RPAREN newlines_opt switch_action
 { pin=1 }

diff --git a/src/main/java/intellij_awk/AwkInspectionUnnecessarySemicolon.java b/src/main/java/intellij_awk/AwkInspectionUnnecessarySemicolon.java
@@ -0,0 +1,52 @@
+package intellij_awk;
+
+import com.intellij.codeInspection.*;
+import com.intellij.codeInspection.util.IntentionFamilyName;
+import com.intellij.openapi.project.Project;
+import com.intellij.psi.PsiElement;
+import com.intellij.psi.PsiElementVisitor;
+import intellij_awk.psi.AwkSemicolonPsi;
+import intellij_awk.psi.AwkTypes;
+import intellij_awk.psi.AwkVisitor;
+import org.jetbrains.annotations.NotNull;
+
+public class AwkInspectionUnnecessarySemicolon extends LocalInspectionTool {
+
+  private static final DeleteUnnecessarySemicolonQuickFix deleteUnnecessarySemicolonQuickFix =
+      new DeleteUnnecessarySemicolonQuickFix();
+  public static final String QUICK_FIX_NAME = "Remove unnecessary semicolon";
+
+  @Override
+  public @NotNull PsiElementVisitor buildVisitor(
+      @NotNull ProblemsHolder holder, boolean isOnTheFly) {
+
+    return new AwkVisitor() {
+      @Override
+      public void visitSemicolonPsi(@NotNull AwkSemicolonPsi semicolonPsi) {
+        PsiElement nextSibling = AwkUtil.getNextNotWhitespace(semicolonPsi);
+        if (nextSibling instanceof AwkSemicolonPsi
+            || AwkUtil.isType(nextSibling, AwkTypes.NEWLINE)
+            || AwkUtil.isType(nextSibling, AwkTypes.RBRACE)) {
+          holder.registerProblem(
+              semicolonPsi,
+              "Unnecessary semicolon ';'",
+              ProblemHighlightType.LIKE_UNUSED_SYMBOL,
+              deleteUnnecessarySemicolonQuickFix);
+        }
+      }
+    };
+  }
+
+  private static class DeleteUnnecessarySemicolonQuickFix implements LocalQuickFix {
+
+    @Override
+    public @IntentionFamilyName @NotNull String getFamilyName() {
+      return QUICK_FIX_NAME;
+    }
+
+    @Override
+    public void applyFix(@NotNull Project project, @NotNull ProblemDescriptor descriptor) {
+      descriptor.getPsiElement().delete();
+    }
+  }
+}
diff --git a/src/main/resources/META-INF/plugin.xml b/src/main/resources/META-INF/plugin.xml
@@ -75,7 +75,7 @@
                          level="ERROR"
                          implementationClass="intellij_awk.AwkInspectionUnresolvedFunction"/>
         <localInspection language="AWK" groupName="AWK"
-                         displayName="Unresolved import"
+                         displayName="Unresolved include"
                          enabledByDefault="true"
                          level="ERROR"
                          implementationClass="intellij_awk.AwkInspectionUnresolvedInclude"/>
@@ -99,6 +99,11 @@
                          enabledByDefault="true"
                          level="WARNING"
                          implementationClass="intellij_awk.AwkInspectionEnforceGlobalVariableNaming"/>
+        <localInspection language="AWK" groupName="AWK"
+                         displayName="Unneeded semicolon"
+                         enabledByDefault="true"
+                         level="WARNING"
+                         implementationClass="intellij_awk.AwkInspectionUnnecessarySemicolon"/>
 
         <codeInsight.parameterInfo language="AWK"
                                    implementationClass="intellij_awk.AwkParameterInfoHandler"/>

diff --git a/src/main/resources/inspectionDescriptions/AwkInspectionUnnecessarySemicolon.html b/src/main/resources/inspectionDescriptions/AwkInspectionUnnecessarySemicolon.html
@@ -0,0 +1,6 @@
+<html>
+<body>
+Reports on unnecessary semicolon.
+<!-- tooltip end -->
+</body>
+</html>
diff --git a/src/test/java/intellij_awk/AwkInspectionTests.java b/src/test/java/intellij_awk/AwkInspectionTests.java
@@ -44,6 +44,11 @@ public class AwkInspectionTests extends BasePlatformTestCase {
           new AwkInspectionEnforceGlobalVariableNaming(),
           AwkInspectionEnforceGlobalVariableNaming.QUICK_FIX_NAME);
 
+  private final Inspection unnecessarySemicolon =
+      new Inspection(
+          new AwkInspectionUnnecessarySemicolon(),
+          AwkInspectionUnnecessarySemicolon.QUICK_FIX_NAME);
+
   public void testDuplicateFunctionParam1() {
     checkByFile(duplicateFunctionParam);
   }
@@ -247,6 +252,34 @@ public void testEnforceGlobalVarNaming3() {
     checkByFile(enforceGlobalVarNaming);
   }
 
+  public void testUnnecessarySemicolon1() {
+    checkByFile(unnecessarySemicolon);
+  }
+
+  public void testUnnecessarySemicolon2() {
+    checkByFile(unnecessarySemicolon);
+  }
+
+  public void testUnnecessarySemicolon3() {
+    checkByFile(unnecessarySemicolon);
+  }
+
+  public void testUnnecessarySemicolonNecessary1() {
+    checkByFileNoProblemAtCaret(unnecessarySemicolon);
+  }
+
+  public void testUnnecessarySemicolonNecessary2() {
+    checkByFileNoProblemAtCaret(unnecessarySemicolon);
+  }
+
+  public void testUnnecessarySemicolonNecessary3() {
+    checkByFileNoProblemAtCaret(unnecessarySemicolon);
+  }
+
+  public void testUnnecessarySemicolonNecessary4() {
+    checkByFileNoProblemAtCaret(unnecessarySemicolon);
+  }
+
   @Override
   protected String getTestDataPath() {
     return "src/test/testData/inspection";

diff --git a/src/test/testData/inspection/unnecessarySemicolon1.awk b/src/test/testData/inspection/unnecessarySemicolon1.awk
@@ -0,0 +1,3 @@
+BEGIN {
+    print 123;<caret>
+}
diff --git a/src/test/testData/inspection/unnecessarySemicolon1After.awk b/src/test/testData/inspection/unnecessarySemicolon1After.awk
@@ -0,0 +1,3 @@
+BEGIN {
+    print 123<caret>
+}
diff --git a/src/test/testData/inspection/unnecessarySemicolon2.awk b/src/test/testData/inspection/unnecessarySemicolon2.awk
@@ -0,0 +1 @@
+{ print 123;<caret> }
diff --git a/src/test/testData/inspection/unnecessarySemicolon2After.awk b/src/test/testData/inspection/unnecessarySemicolon2After.awk
@@ -0,0 +1 @@
+{ print 123<caret> }
diff --git a/src/test/testData/inspection/unnecessarySemicolon3.awk b/src/test/testData/inspection/unnecessarySemicolon3.awk
@@ -0,0 +1,3 @@
+BEGIN {
+    print 123<caret>;;
+}
diff --git a/src/test/testData/inspection/unnecessarySemicolon3After.awk b/src/test/testData/inspection/unnecessarySemicolon3After.awk
@@ -0,0 +1,3 @@
+BEGIN {
+    print 123<caret>;
+}
diff --git a/src/test/testData/inspection/unnecessarySemicolonNecessary1.awk b/src/test/testData/inspection/unnecessarySemicolonNecessary1.awk
@@ -0,0 +1 @@
+function f() { while(1);<caret> }
diff --git a/src/test/testData/inspection/unnecessarySemicolonNecessary2.awk b/src/test/testData/inspection/unnecessarySemicolonNecessary2.awk
@@ -0,0 +1,3 @@
+function f() {
+    for(;;);<caret>
+}
diff --git a/src/test/testData/inspection/unnecessarySemicolonNecessary3.awk b/src/test/testData/inspection/unnecessarySemicolonNecessary3.awk
@@ -0,0 +1,3 @@
+{
+    if(1)  ;<caret>
+}
diff --git a/src/test/testData/inspection/unnecessarySemicolonNecessary4.awk b/src/test/testData/inspection/unnecessarySemicolonNecessary4.awk
@@ -0,0 +1,3 @@
+BEGIN {
+    ;<caret>
+}