Add Jacoco, Error Prone, CheckStyle (#75)

* Prep for 3.0.0 release * Add ErrorProne, CheckStyle, Jacoco, fix violations
cqframework · Feb 29, 2024 · fd34939 · fd34939
1 parent 1a52137
commit fd34939
Show file tree

Hide file tree

Showing 16 changed files with 180 additions and 36 deletions.
diff --git a/.mvn/jvm.config b/.mvn/jvm.config
@@ -0,0 +1,10 @@
+--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
+--add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
+--add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED
diff --git a/config/checkstyle.xml b/config/checkstyle.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0"?>
+<!DOCTYPE module PUBLIC "-//Checkstyle//DTD Checkstyle Configuration 1.3//EN" "https://checkstyle.org/dtds/configuration_1_3.dtd">
+
+<!--
+    Derived Checkstyle configuration that checks the Google naming conventions from Google Java Style
+    that can be found at https://google.github.io/styleguide/javaguide.html Formatting conventions are
+    enforced by the spotless plugin.
+
+    This configuration is based on the Google Checks that can be found at:
+    https://github.com/checkstyle/checkstyle/blob/master/src/main/resources/google_checks.xml
+     
+ -->
+
+<module name="Checker">
+    <property name="charset" value="UTF-8" />
+    <property name="fileExtensions" value="java, properties, xml" />
+
+    <module name="SuppressWarningsFilter" />
+
+    <!-- Excludes all 'module-info.java' files              -->
+    <!-- See https://checkstyle.org/filefilters/index.html -->
+    <module name="BeforeExecutionExclusionFileFilter">
+        <property name="fileNamePattern" value="module\-info\.java$" />
+    </module>
+
+    <module name="TreeWalker">
+        <!-- Make the @SuppressWarnings annotations available to Checkstyle -->
+		<module name="SuppressWarningsHolder" />
+        <module name="AbstractClassName">
+            <property name="format" value="^(Base|Abstract).+$" />
+        </module>
+        <module name="MemberName">
+            <property name="format"
+                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
+            <message key="name.invalidPattern"
+                value="Member ''{0}'' should be named with camelCase and without prefixes." />
+        </module>
+        <module name="ParameterName">
+            <property name="format"
+                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
+            <message key="name.invalidPattern"
+                value="Member ''{0}'' should be named with camelCase and without prefixes." />
+        </module>
+        <module name="MethodName">
+            <property name="format"
+                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
+            <message key="name.invalidPattern"
+                value="Member ''{0}'' should be named with camelCase and without prefixes." />
+        </module>
+        <module name="StaticVariableName">
+            <property name="format"
+                value="^(?!((m|s|my|our|the)[A-Z])[a-zA-Z0-9]*)([a-z][a-zA-Z0-9]*)$" />
+            <message key="name.invalidPattern"
+                value="Member ''{0}'' should be named with camelCase and without prefixes." />
+        </module>
+        <module name="NoFinalizer" />
+    </module>
+</module>
diff --git a/core/pom.xml b/core/pom.xml
@@ -11,7 +11,7 @@
     <parent>
         <groupId>org.opencds.cqf.cql.ls</groupId>
         <artifactId>cql-ls</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.0.0</version>
     </parent>
 
     <dependencies>

diff --git a/debug/server/pom.xml b/debug/server/pom.xml
@@ -11,15 +11,15 @@
     <parent>
         <groupId>org.opencds.cqf.cql.ls</groupId>
         <artifactId>cql-ls</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.0.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 
     <dependencies>
         <dependency>
             <groupId>org.opencds.cqf.cql.ls</groupId>
             <artifactId>cql-ls-core</artifactId>
-            <version>3.0.0-SNAPSHOT</version>
+            <version>3.0.0</version>
         </dependency>
         <dependency>
             <groupId>org.eclipse.lsp4j</groupId>

diff --git a/debug/service/pom.xml b/debug/service/pom.xml
@@ -10,15 +10,15 @@
     <parent>
         <groupId>org.opencds.cqf.cql.ls</groupId>
         <artifactId>cql-ls</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.0.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 
     <dependencies>
         <dependency>
             <groupId>org.opencds.cqf.cql.debug</groupId>
             <artifactId>cql-debug-server</artifactId>
-            <version>3.0.0-SNAPSHOT</version>
+            <version>3.0.0</version>
         </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>

diff --git a/ls/server/pom.xml b/ls/server/pom.xml
@@ -11,7 +11,7 @@
     <parent>
         <groupId>org.opencds.cqf.cql.ls</groupId>
         <artifactId>cql-ls</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.0.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 
@@ -29,7 +29,7 @@
         <dependency>
             <groupId>org.opencds.cqf.cql.ls</groupId>
             <artifactId>cql-ls-core</artifactId>
-            <version>3.0.0-SNAPSHOT</version>
+            <version>3.0.0</version>
         </dependency>
 
         <dependency>

diff --git a/...pencds/cqf/cql/ls/server/event/Event.java → ...ds/cqf/cql/ls/server/event/BaseEvent.java b/...pencds/cqf/cql/ls/server/event/Event.java → ...ds/cqf/cql/ls/server/event/BaseEvent.java
@@ -1,10 +1,10 @@
 package org.opencds.cqf.cql.ls.server.event;
 
-abstract class Event<T> {
+abstract class BaseEvent<T> {
 
     private T params;
 
-    protected Event(T params) {
+    protected BaseEvent(T params) {
         this.params = params;
     }
 

diff --git a/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidChangeTextDocumentEvent.java b/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidChangeTextDocumentEvent.java
@@ -2,7 +2,7 @@
 
 import org.eclipse.lsp4j.DidChangeTextDocumentParams;
 
-public class DidChangeTextDocumentEvent extends Event<DidChangeTextDocumentParams> {
+public class DidChangeTextDocumentEvent extends BaseEvent<DidChangeTextDocumentParams> {
     public DidChangeTextDocumentEvent(DidChangeTextDocumentParams params) {
         super(params);
     }

diff --git a/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidChangeWatchedFilesEvent.java b/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidChangeWatchedFilesEvent.java
@@ -2,7 +2,7 @@
 
 import org.eclipse.lsp4j.DidChangeWatchedFilesParams;
 
-public class DidChangeWatchedFilesEvent extends Event<DidChangeWatchedFilesParams> {
+public class DidChangeWatchedFilesEvent extends BaseEvent<DidChangeWatchedFilesParams> {
     public DidChangeWatchedFilesEvent(DidChangeWatchedFilesParams params) {
         super(params);
     }

diff --git a/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidCloseTextDocumentEvent.java b/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidCloseTextDocumentEvent.java
@@ -2,7 +2,7 @@
 
 import org.eclipse.lsp4j.DidCloseTextDocumentParams;
 
-public class DidCloseTextDocumentEvent extends Event<DidCloseTextDocumentParams> {
+public class DidCloseTextDocumentEvent extends BaseEvent<DidCloseTextDocumentParams> {
     public DidCloseTextDocumentEvent(DidCloseTextDocumentParams params) {
         super(params);
     }

diff --git a/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidOpenTextDocumentEvent.java b/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidOpenTextDocumentEvent.java
@@ -2,7 +2,7 @@
 
 import org.eclipse.lsp4j.DidOpenTextDocumentParams;
 
-public class DidOpenTextDocumentEvent extends Event<DidOpenTextDocumentParams> {
+public class DidOpenTextDocumentEvent extends BaseEvent<DidOpenTextDocumentParams> {
     public DidOpenTextDocumentEvent(DidOpenTextDocumentParams params) {
         super(params);
     }

diff --git a/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidSaveTextDocumentEvent.java b/ls/server/src/main/java/org/opencds/cqf/cql/ls/server/event/DidSaveTextDocumentEvent.java
@@ -2,7 +2,7 @@
 
 import org.eclipse.lsp4j.DidSaveTextDocumentParams;
 
-public class DidSaveTextDocumentEvent extends Event<DidSaveTextDocumentParams> {
+public class DidSaveTextDocumentEvent extends BaseEvent<DidSaveTextDocumentParams> {
     public DidSaveTextDocumentEvent(DidSaveTextDocumentParams params) {
         super(params);
     }

diff --git a/ls/service/pom.xml b/ls/service/pom.xml
@@ -9,15 +9,15 @@
     <parent>
         <groupId>org.opencds.cqf.cql.ls</groupId>
         <artifactId>cql-ls</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.0.0</version>
         <relativePath>../../pom.xml</relativePath>
     </parent>
 
     <dependencies>
         <dependency>
             <groupId>org.opencds.cqf.cql.ls</groupId>
             <artifactId>cql-ls-server</artifactId>
-            <version>3.0.0-SNAPSHOT</version>
+            <version>3.0.0</version>
         </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>

diff --git a/plugin/debug/pom.xml b/plugin/debug/pom.xml
@@ -11,21 +11,21 @@
     <parent>
         <groupId>org.opencds.cqf.cql.ls</groupId>
         <artifactId>cql-ls</artifactId>
-        <version>3.0.0-SNAPSHOT</version>
+        <version>3.0.0</version>
         <relativePath>../..</relativePath>
     </parent>
 
     <dependencies>
         <dependency>
             <groupId>org.opencds.cqf.cql.ls</groupId>
             <artifactId>cql-ls-server</artifactId>
-            <version>3.0.0-SNAPSHOT</version>
+            <version>3.0.0</version>
             <scope>provided</scope>
         </dependency>
         <dependency>
             <groupId>org.opencds.cqf.cql.debug</groupId>
             <artifactId>cql-debug-server</artifactId>
-            <version>3.0.0-SNAPSHOT</version>
+            <version>3.0.0</version>
         </dependency>
         <dependency>
             <groupId>org.eclipse.lsp4j</groupId>

diff --git a/plugin/debug/src/main/java/org/opencds/cqf/cql/ls/plugin/debug/DebugCommandContribution.java b/plugin/debug/src/main/java/org/opencds/cqf/cql/ls/plugin/debug/DebugCommandContribution.java
@@ -19,9 +19,6 @@ public class DebugCommandContribution implements CommandContribution {
 
     public DebugCommandContribution(CqlCompilationManager cqlCompilationManager) {
         this.cqlCompilationManager = cqlCompilationManager;
-
-        // Temporary hack for unused variable
-        this.cqlCompilationManager.hashCode();
     }
 
     @Override