refactoring: applies lint fixes

Author: FedericoPonzi

build.gradle.kts

@@ -42,7 +42,7 @@ dependencies {
 
     // Logging
     implementation("org.slf4j:slf4j-api:2.0.7")
-    implementation("ch.qos.logback:logback-classic:1.5.13")
+    implementation("ch.qos.logback:logback-classic:1.5.28")
 
     implementation("com.opencastsoftware:prettier4j:0.3.2")
 }

src/main/java/me/fponzi/tlaplusformatter/DocUtils.java

@@ -2,65 +2,31 @@
 
 import com.opencastsoftware.prettier4j.Doc;
 
-import java.util.Arrays;
 import java.util.List;
 
 /**
  * Utility methods for creating common Doc patterns.
  * These are truly generic utilities not specific to TLA+ constructs.
  */
 public class DocUtils {
-    
+
     private DocUtils() {
         // Utility class
     }
-    
-    /**
-     * Creates an infix expression: left op right
-     */
-    public static Doc infixExpression(Doc left, String operator, Doc right) {
-        return Doc.group(
-            left
-                .append(Doc.text(" " + operator + " "))
-                .append(right)
-        );
-    }
-    
-    /**
-     * Creates a parenthesized expression: (expr)
-     */
-    public static Doc parentheses(Doc inner) {
-        return Doc.text("(")
-                .append(inner)
-                .append(Doc.text(")"));
-    }
-    
-    /**
-     * Creates a sequence of documents separated by lines
-     */
-    public static Doc lines(Doc... docs) {
-        return lines(Arrays.asList(docs));
-    }
-    
+
     /**
      * Creates a sequence of documents separated by lines
      */
     public static Doc lines(List<Doc> docs) {
         if (docs.isEmpty()) {
             return Doc.empty();
         }
-        
+
         Doc result = docs.get(0);
         for (int i = 1; i < docs.size(); i++) {
             result = result.appendLine(docs.get(i));
         }
         return result;
     }
-    
-    /**
-     * Creates a comment line starting with \*
-     */
-    public static Doc comment(String text) {
-        return Doc.text("\\* " + text);
-    }
+
 }

src/main/java/me/fponzi/tlaplusformatter/FormatConfig.java

@@ -92,15 +92,6 @@ private void setConstructSetting(String constructName, String settingName, Objec
         constructSettings.put(key, value);
     }
 
-    /**
-     * Get all construct settings.
-     *
-     * @return Unmodifiable map of all construct settings
-     */
-    public Map<String, Object> getAllConstructSettings() {
-        return Map.copyOf(constructSettings);
-    }
-
     /**
      * Create a copy of this config with the same settings.
      *

src/main/java/me/fponzi/tlaplusformatter/SANYWrapper.java

@@ -4,12 +4,14 @@
 import me.fponzi.tlaplusformatter.exceptions.SanyFrontendException;
 import me.fponzi.tlaplusformatter.exceptions.SanySemanticException;
 import me.fponzi.tlaplusformatter.exceptions.SanySyntaxException;
-import tla2sany.st.TreeNode;
 import org.apache.commons.io.output.WriterOutputStream;
 import tla2sany.drivers.FrontEndException;
 import tla2sany.drivers.SANY;
 import tla2sany.modanalyzer.ParseUnit;
 import tla2sany.modanalyzer.SpecObj;
+import tla2sany.output.LogLevel;
+import tla2sany.output.SimpleSanyOutput;
+import tla2sany.st.TreeNode;
 import util.SimpleFilenameToStream;
 
 import java.io.File;
@@ -52,7 +54,7 @@ public static void loadSpecObject(SpecObj specObj, File file, StringWriter errBu
             SANY.frontEndMain(
                     specObj,
                     file.getAbsolutePath(),
-                    new PrintStream(outStream, false, StandardCharsets.UTF_8)
+                    new SimpleSanyOutput(new PrintStream(outStream, false, StandardCharsets.UTF_8), LogLevel.INFO)
             );
         } catch (FrontEndException e) {
             throw new SanyFrontendException(e);
@@ -95,20 +97,20 @@ private static List<String> getAdditionalModulePaths() {
             List<String> paths = new ArrayList<>();
             // Check for community modules, TLAPS, and Apalache in common locations
             String[] possiblePaths = {
-                // Community modules
-                System.getenv("TLA_COMMUNITY_MODULES"),
-                "/tmp/CommunityModules/modules",
-                "/tmp/CommunityModules",
-                System.getProperty("user.home") + "/.tlaplus/CommunityModules/modules",
-                // TLAPS library
-                System.getenv("TLAPS_LIBRARY"),
-                "/tmp/tlapm/library",
-                System.getProperty("user.home") + "/.tlaplus/tlaps/library",
-                "/usr/local/lib/tlaps/library",
-                // Apalache modules
-                System.getenv("APALACHE_HOME") != null ? System.getenv("APALACHE_HOME") + "/src/tla" : null,
-                "/tmp/apalache/src/tla",
-                System.getProperty("user.home") + "/.tlaplus/apalache/src/tla"
+                    // Community modules
+                    System.getenv("TLA_COMMUNITY_MODULES"),
+                    "/tmp/CommunityModules/modules",
+                    "/tmp/CommunityModules",
+                    System.getProperty("user.home") + "/.tlaplus/CommunityModules/modules",
+                    // TLAPS library
+                    System.getenv("TLAPS_LIBRARY"),
+                    "/tmp/tlapm/library",
+                    System.getProperty("user.home") + "/.tlaplus/tlaps/library",
+                    "/usr/local/lib/tlaps/library",
+                    // Apalache modules
+                    System.getenv("APALACHE_HOME") != null ? System.getenv("APALACHE_HOME") + "/src/tla" : null,
+                    "/tmp/apalache/src/tla",
+                    System.getProperty("user.home") + "/.tlaplus/apalache/src/tla"
             };
             for (String path : possiblePaths) {
                 if (path != null) {

src/main/java/me/fponzi/tlaplusformatter/TLAPlusFormatter.java

@@ -55,8 +55,6 @@ public String getOutput() {
      * <p>
      * Safety: The input spec should be called "Spec" otherwise SANY will complain.
      *
-     * @param spec
-     * @throws IOException
      */
     public TLAPlusFormatter(String spec) throws IOException, SanyFrontendException {
         this(storeToTmp(spec), new FormatConfig(), true);

src/main/java/me/fponzi/tlaplusformatter/VersionInfo.java

@@ -21,14 +21,7 @@ public final class VersionInfo {
         COMMIT_ID = props.getProperty("git.commit", "unknown");
     }
 
-    private VersionInfo() {}
-
-    public static String getVersion() {
-        return VERSION;
-    }
-
-    public static String getCommitId() {
-        return COMMIT_ID;
+    private VersionInfo() {
     }
 
     public static String getFullVersion() {

src/main/java/me/fponzi/tlaplusformatter/constructs/BaseConstructFormatter.java

@@ -121,25 +121,4 @@ protected static Function<String, Doc> stringFormatter() {
         return Doc::text;
     }
 
-    /**
-     * Determine appropriate formatting strategy based on list size and configuration.
-     */
-    protected ListFormatStrategy determineStrategy(String constructName, int itemCount) {
-        // Check construct-specific settings
-        ListFormatStrategy configuredStrategy = config.getConstructSetting(
-                constructName, "breakStrategy", null);
-
-        if (configuredStrategy != null) {
-            return configuredStrategy;
-        }
-
-        // Default strategy based on item count
-        if (itemCount <= 1) {
-            return ListFormatStrategy.SINGLE_LINE;
-        } else if (itemCount <= 3) {
-            return ListFormatStrategy.SINGLE_LINE;
-        } else {
-            return ListFormatStrategy.SMART_BREAK;
-        }
-    }
 }

src/main/java/me/fponzi/tlaplusformatter/constructs/ConstructContext.java

@@ -3,15 +3,10 @@
 import com.opencastsoftware.prettier4j.Doc;
 import me.fponzi.tlaplusformatter.FormatConfig;
 import me.fponzi.tlaplusformatter.TlaDocBuilder;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
 import tla2sany.st.TreeNode;
 
-import java.lang.invoke.MethodHandles;
 import java.util.ArrayList;
-import java.util.Arrays;
 import java.util.List;
-import java.util.stream.Collectors;
 
 /**
  * Context object that provides access to shared services and utilities
@@ -99,10 +94,7 @@ private static boolean isCommentStart(String s) {
             return true;
         }
         // Check for line comment start \*
-        if (i + 1 < s.length() && s.charAt(i) == '\\' && s.charAt(i + 1) == '*') {
-            return true;
-        }
-        return false;
+        return i + 1 < s.length() && s.charAt(i) == '\\' && s.charAt(i + 1) == '*';
     }
 
     /**
@@ -166,19 +158,6 @@ public boolean isValidNode(TreeNode node) {
         return nodeAnalyzer.isValid(node);
     }
 
-    /**
-     * Get a construct-specific configuration setting.
-     *
-     * @param constructName Name of the construct
-     * @param settingName   Name of the setting
-     * @param defaultValue  Default value if setting is not found
-     * @param <T>           Type of the setting value
-     * @return The setting value or default value
-     */
-    public <T> T getConstructSetting(String constructName, String settingName, T defaultValue) {
-        return config.getConstructSetting(constructName, settingName, defaultValue);
-    }
-
     /**
      * Get preserved spacing after a node based on original source.
      *
@@ -193,8 +172,6 @@ public Doc getSpacingAfter(TreeNode node, TreeNode next) {
      * Helper class for common node analysis operations.
      */
     private static class NodeAnalyzer {
-        private static final Logger LOG = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
-
         /**
          * Check if a node is valid (has a real location, not a placeholder).
          */

src/main/java/me/fponzi/tlaplusformatter/constructs/NodeKind.java

@@ -3,6 +3,7 @@
 /**
  * Enum representing SANY node kinds with metadata.
  */
+@SuppressWarnings("unused")
 public enum NodeKind {
 
     NULL_ID(327, "Null ID"),
@@ -139,11 +140,6 @@ public enum NodeKind {
         this.description = description;
     }
 
-    /**
-     * Get all node kind IDs handled by this NodeKind.
-     *
-     * @return Set of all node kind IDs
-     */
     public int getId() {
         return id;
     }

src/main/java/me/fponzi/tlaplusformatter/constructs/TlaConstruct.java

@@ -19,34 +19,13 @@ public interface TlaConstruct {
      */
     int getSupportedNodeKind();
 
-    /**
-     * Check if this construct can handle the given node.
-     * Default implementation checks if the node kind is in getSupportedNodeKinds().
-     *
-     * @param node The tree node to check
-     * @return true if this construct can handle the node
-     */
-    default boolean canHandle(TreeNode node) {
-        return node != null && getSupportedNodeKind() == node.getKind();
-    }
-
     /**
      * Build a Doc object for formatting this construct.
      *
-     * @param node       The SANY tree node representing this construct
-     * @param context    Context object providing access to configuration and utilities
-     * @param indentSize
+     * @param node    The SANY tree node representing this construct
+     * @param context Context object providing access to configuration and utilities
      * @return A Doc object for pretty printing
      */
     Doc buildDoc(TreeNode node, ConstructContext context, int indentSize);
 
-    /**
-     * Default indent size, pulled from the formatter configuration.
-     *
-     * @param context Construct context providing access to config
-     * @return indent size from config
-     */
-    default int indentSize(ConstructContext context) {
-        return context.getConfig().getIndentSize();
-    }
 }