Merge pull request #61 from xzescha/fixes_and_improvements

Fixed build.gradle, gradle.properties and pom.xml

Author: yegor256

.github/workflows/codecov.yml

@@ -14,5 +14,6 @@ jobs:
           gradle jacocoTestReport
       - uses: codecov/codecov-action@v2
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           file: build/reports/jacoco/report.xml
-          fail_ci_if_error: true
+          fail_ci_if_error: true

README.md

@@ -80,4 +80,4 @@ Its `pom` file should contain `eo-maven-plugin` configuration as follows:
     </plugins>
   </build>
 ```
-Having this set up compilation can be triggered by `Build -> EO compile` menu action.
+Having this set up compilation can be triggered by `Build -> EO compile` menu action.

build.gradle

@@ -2,7 +2,8 @@ buildscript {
     repositories {
         mavenCentral()
         repositories {
-            maven { url "https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven" }
+            maven { url "https://maven.pkg.jetbrains.space/public/p/kotlinx-html/maven/" }
+
         }
     }
     dependencies {
@@ -11,7 +12,7 @@ buildscript {
 
 
 plugins {
-    id "org.jetbrains.intellij" version "1.14.2"
+    id "org.jetbrains.intellij" version "1.17.4"
 }
 
 java {
@@ -23,34 +24,48 @@ java {
 group 'antlr'
 version pluginVersion
 
+
 apply plugin: 'java'
 apply plugin: 'org.jetbrains.intellij'
 apply plugin: 'antlr'
 apply plugin: 'jacoco'
 
+task cleanParser(type: Delete) {
+    delete fileTree("src/main/java/org/eolang/jetbrains/parser") //Deletes antlr auto-generated classes
+}
+
+task qulice(type: Exec) {
+    workingDir "${projectDir}"
+    def mvnExecutable = System.properties['os.name'].toLowerCase().contains('windows') ? 'mvn.cmd' : 'mvn'
+    commandLine mvnExecutable, 'com.qulice:qulice-maven-plugin:check', '-e', '-X'
+
+    standardOutput = new FileOutputStream("qulice.log")
+    errorOutput = new FileOutputStream("qulice-error.log")
+}
+
 task getGrammar {
     doFirst {
-        def f = new File('src/main/antlr/org/jetbrains/eolang/parser/EO.g4')
+        def f = new File('src/main/antlr/org/jetbrains/eolang/parser/Eo.g4')
         if (!f.exists())
-            println("Created destination file: src/main/antlr/org/jetbrains/eolang/parser/EO.g4")
+            println("Created destination file: src/main/antlr/org/jetbrains/eolang/parser/Eo.g4")
         else {
             println("File already exists. Delete it and rerun task")
             return
         }
         println("Creating and downloading grammar file from " +
                 "https://raw.githubusercontent.com/objectionary/" +
-                "eo/master/eo-parser/src/main/antlr4/org/eolang/parser/Program.g4")
+                "eo/refs/heads/master/eo-parser/src/main/antlr4/org/eolang/parser/Eo.g4")
 
-        new URL('https://raw.githubusercontent.com/objectionary/eo/master/eo-parser/src/main/antlr4/org/eolang/parser/Program.g4').
+        new URL('https://raw.githubusercontent.com/objectionary/eo/refs/heads/master/eo-parser/src/main/antlr4/org/eolang/parser/Eo.g4').
                 withInputStream { i -> f.withOutputStream { it << i } }
         f.append('\n\nBAD_CHARACTER\n' +
                 '\t:\t.\t-> channel(HIDDEN)\n' +
                 '\t;')
         if (f.exists())
             println("Grammar downloading is completed")
 
-        ant.replaceregexp(match: 'Program', replace: 'EO', flags: 'g', byline: true) {
-            fileset(dir: 'src/main/antlr/org/jetbrains/eolang/parser', includes: 'EO.g4')
+        ant.replaceregexp(match: 'Program', replace: 'Eo', flags: 'g', byline: true) {
+            fileset(dir: 'src/main/antlr/org/jetbrains/eolang/parser', includes: 'Eo.g4')
         }
     }
 }
@@ -69,10 +84,8 @@ jacocoTestReport {
     }
 }
 
-task qulice (type: Exec) {
-    workingDir "${projectDir}"
-    commandLine 'mvn', 'com.qulice:qulice-maven-plugin:check'
-}
+
+
 
 compileJava {
     sourceCompatibility = '1.8'
@@ -92,6 +105,9 @@ intellij {
     plugins = ["com.intellij.java", "org.jetbrains.idea.maven"]
 }
 
+test {
+    useJUnitPlatform()  // Sign to use JUnit 5
+}
 
 publishPlugin {
     dependsOn(test)
@@ -100,6 +116,8 @@ publishPlugin {
 
 generateGrammarSource {
     dependsOn(getGrammar)
+    dependsOn(qulice)
+    dependsOn(cleanParser)
     outputDirectory = new File("src/main/java/org/eolang/jetbrains/parser".toString())
     arguments += ["-package", "org.eolang.jetbrains.parser", "-Xexact-output-dir"]
 }
@@ -116,11 +134,18 @@ dependencies {
     }
     implementation 'org.antlr:antlr4-intellij-adaptor:0.1'
     testImplementation group: 'junit', name: 'junit', version: '4.13.2'
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.2'
+    testImplementation 'org.junit.jupiter:junit-jupiter-engine:5.8.2'
+    implementation 'org.jetbrains:annotations:13.0'
 }
 
+
+
 build {
-    dependsOn(qulice)
+    dependsOn(jacocoTestReport)
 }
 
+
+
 sourceCompatibility = JavaVersion.VERSION_1_9
 targetCompatibility = JavaVersion.VERSION_1_9

gradle.properties

@@ -1,4 +1,4 @@
-ideaVersion = 2021.1
+ideaVersion = 2023.3
 
 antlr4Version = 4.13.1
 

pom.xml

@@ -7,7 +7,7 @@
   <name>eo-intellij-plugin</name>
   <description>Plugin for EO lang</description>
   <url>https://github.com/objectionary/eo-intellij-plugin</url>
-  <inceptionYear>2022</inceptionYear>
+  <inceptionYear>2025</inceptionYear>
   <organization>
     <name>EO</name>
     <url>https://github.com/objectionary/eo-intellij-plugin</url>
@@ -35,13 +35,17 @@
       <plugin>
         <groupId>com.qulice</groupId>
         <artifactId>qulice-maven-plugin</artifactId>
+        <version>0.24.0</version>
         <configuration>
-          <license>file:LICENSE.txt</license>
-          <excludes combine.children="append">
-            <exclude>pmd:/src/main/java/org/eolang/jetbrains/parser/.*</exclude>
-            <exclude>checkstyle:/src/main/java/org/eolang/jetbrains/parser/.*</exclude>
-          </excludes>
+          <license>file:${basedir}/LICENSE.txt</license>
         </configuration>
+        <executions>
+          <execution>
+            <goals>
+              <goal>check</goal>
+            </goals>
+          </execution>
+        </executions>
       </plugin>
     </plugins>
   </build>

src/main/antlr/org/jetbrains/eolang/parser/docs.txt

@@ -1,2 +1,2 @@
-In this folder should be located EO.h4 grammar file.
+In this folder should be located EO.g4 grammar file.
 You may run getGrammar task for doing that or you may run build task

src/main/java/org/eolang/jetbrains/EoColorSettingsPage.java

@@ -43,16 +43,15 @@ public class EoColorSettingsPage implements ColorSettingsPage {
     /**
      * Here we describe tokens for display them in settings page.
      */
-    private static final AttributesDescriptor[] DESCRIPTORS =
-        new AttributesDescriptor[] {
-            new AttributesDescriptor("Keywords", EoSyntaxHighlighter.KEYWORD),
-            new AttributesDescriptor("Comments", EoSyntaxHighlighter.COMMENT),
-            new AttributesDescriptor("Identifiers", EoSyntaxHighlighter.NAME),
-            new AttributesDescriptor("Strings", EoSyntaxHighlighter.STRING),
-            new AttributesDescriptor("Metas", EoSyntaxHighlighter.META),
-            new AttributesDescriptor("Constants", EoSyntaxHighlighter.NUMBERS),
-            new AttributesDescriptor("Braces", EoSyntaxHighlighter.BRACES),
-        };
+    private static final AttributesDescriptor[] DESCRIPTORS = {
+        new AttributesDescriptor("Keywords", EoSyntaxHighlighter.KEYWORD),
+        new AttributesDescriptor("Comments", EoSyntaxHighlighter.COMMENT),
+        new AttributesDescriptor("Identifiers", EoSyntaxHighlighter.NAME),
+        new AttributesDescriptor("Strings", EoSyntaxHighlighter.STRING),
+        new AttributesDescriptor("Metas", EoSyntaxHighlighter.META),
+        new AttributesDescriptor("Constants", EoSyntaxHighlighter.NUMBERS),
+        new AttributesDescriptor("Braces", EoSyntaxHighlighter.BRACES),
+    };
 
     @Nullable
     @Override

src/main/java/org/eolang/jetbrains/EoCompileAction.java

@@ -23,9 +23,8 @@
  */
 package org.eolang.jetbrains;
 
-import com.intellij.notification.Notification;
+import com.intellij.notification.NotificationGroupManager;
 import com.intellij.notification.NotificationType;
-import com.intellij.notification.Notifications;
 import com.intellij.openapi.actionSystem.AnAction;
 import com.intellij.openapi.actionSystem.AnActionEvent;
 import com.intellij.openapi.actionSystem.DataContext;
@@ -105,13 +104,9 @@ private static void performUnsafe(final AnActionEvent action) {
      * @param reason Reason
      */
     private static void notifyCannotCompile(final String reason) {
-        Notifications.Bus.notify(
-            new Notification(
-                Notifications.SYSTEM_MESSAGES_GROUP_ID,
-                "Cannot compile EO",
-                reason,
-                NotificationType.WARNING
-            )
-        );
+        NotificationGroupManager.getInstance()
+            .getNotificationGroup("System Messages")
+            .createNotification("Cannot compile EO", reason, NotificationType.WARNING)
+            .notifyAll();
     }
 }

src/main/java/org/eolang/jetbrains/EoExternalAnnotator.java

@@ -31,25 +31,24 @@
 import com.intellij.psi.PsiFile;
 import java.util.ArrayList;
 import java.util.List;
+import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
+
+//@checkstyle JavadocTagsCheck (9 lines)
 
 /**
  * An external annotator is an object that analyzes code in a document and annotates the PSI
  * elements with errors or warnings. Because such analysis can be expensive, we don't want it in the
  * GUI event loop. Jetbrains provides this external annotator mechanism to run these analyzers out
  * of band.
- * @since 0.0.0
- * @checkstyle MultilineJavadocTagsCheck (200 lines)
- * @checkstyle MemberNameCheck (200 lines)
  */
+@SuppressWarnings("PMD.SystemPrintln")
 public class EoExternalAnnotator
     extends ExternalAnnotator<PsiFile, List<EoExternalAnnotator.Issue>> {
 
     // Called first; in our case, just return file and do nothing.
     @Override
-    @Nullable
-    public final PsiFile collectInformation(@NotNull final PsiFile file) {
+    public final @NotNull PsiFile collectInformation(@NotNull final PsiFile file) {
         return file;
     }
 
@@ -61,17 +60,23 @@ public final PsiFile collectInformation(@NotNull final PsiFile file) {
      * compiler or interpreter to get error messages or other bits of information you'd
      * like to annotate the document with.
      */
+    @Contract(value = "_ -> new", pure = true)
     @Override
-    public final List<Issue> doAnnotate(final PsiFile file) {
+    public final @NotNull List<Issue> doAnnotate(final PsiFile file) {
         return new ArrayList<>(0);
     }
 
     // Called 3rd to actually annotate the editor window.
+
     @Override
-    public final void apply(@NotNull final PsiFile file, final List<Issue> issues,
+    public final void apply(@NotNull final PsiFile file, final @NotNull List<Issue> issues,
         @NotNull final AnnotationHolder holder) {
         for (final Issue issue : issues) {
-            final TextRange range = issue.getOffendingNode().getTextRange();
+            final TextRange range = issue.getOffendnode().getTextRange();
+            if (range.getStartOffset() > range.getEndOffset()) {
+                System.err.println("Invalid TextRange");
+                continue;
+            }
             holder.createErrorAnnotation(range, issue.getMsg());
         }
     }
@@ -90,7 +95,7 @@ public static class Issue {
         /**
          * Node.
          */
-        private final PsiElement offendingNode;
+        private final PsiElement offendnode;
 
         /**
          * Issue init.
@@ -99,7 +104,7 @@ public static class Issue {
          */
         public Issue(final String msg, final PsiElement node) {
             this.msg = msg;
-            this.offendingNode = node;
+            this.offendnode = node;
         }
 
         /**
@@ -114,8 +119,8 @@ final String getMsg() {
          * Accessor.
          * @return Offending node
          */
-        final PsiElement getOffendingNode() {
-            return this.offendingNode;
+        final PsiElement getOffendnode() {
+            return this.offendnode;
         }
     }
 }

src/main/java/org/eolang/jetbrains/EoFileTypeFactory.java

@@ -21,7 +21,6 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-
 package org.eolang.jetbrains;
 
 import com.intellij.openapi.fileTypes.FileTypeConsumer;