Some adjustments after review

- Use consistent option names in settings
- Introduce StoragePaths
- Remove comma in changelog entry
- Remove unused NOTIFICATION_GROUP_KEY
- Fix some formatting

Author: JojOatXGME

.gitignore

@@ -24,4 +24,4 @@ hs_err_pid*
 **/.gradle
 build
 
-src/gen
+src/gen

CHANGELOG.md

@@ -4,7 +4,7 @@
 
 ### Added
 
-- Support for code formatting, via external commands ([#80](https://github.com/NixOS/nix-idea/pull/80))
+- Support for code formatting via external commands ([#80](https://github.com/NixOS/nix-idea/pull/80))
 
 ### Changed
 

src/main/java/org/nixos/idea/lang/NixLanguage.java

@@ -5,7 +5,7 @@
 public class NixLanguage extends Language {
     public static final NixLanguage INSTANCE = new NixLanguage();
     public static final String NOTIFICATION_GROUP_ID = "NixIDEA";
-public static final String NOTIFICATION_GROUP_KEY = "notification.group.nixidea";
+
     private NixLanguage() {
         super("Nix");
     }

src/main/java/org/nixos/idea/lsp/NixLspSettings.java

@@ -6,17 +6,16 @@
 import com.intellij.openapi.components.State;
 import com.intellij.openapi.components.Storage;
 import org.jetbrains.annotations.NotNull;
+import org.nixos.idea.settings.NixStoragePaths;
 
 import java.util.ArrayDeque;
 import java.util.Collection;
 import java.util.Collections;
 import java.util.Deque;
 
-@State(name = "NixLspSettings", storages = @Storage(value = "nix-idea-tools.xml", roamingType = RoamingType.DISABLED))
+@State(name = "NixLspSettings", storages = @Storage(value = NixStoragePaths.TOOLS, roamingType = RoamingType.DISABLED))
 public final class NixLspSettings implements PersistentStateComponent<NixLspSettings.State> {
 
-    // TODO: Use RoamingType.LOCAL with 2024.1
-
     // Documentation:
     // https://plugins.jetbrains.com/docs/intellij/persisting-state-of-components.html
 

src/main/java/org/nixos/idea/settings/NixExternalFormatterSettings.java

@@ -12,11 +12,9 @@
 import java.util.Collections;
 import java.util.Deque;
 
-@State(name = "NixExternalFormatterSettings", storages = @Storage(value = "nix-idea-ext-fmt.xml", roamingType = RoamingType.DISABLED))
+@State(name = "NixExternalFormatterSettings", storages = @Storage(value = NixStoragePaths.TOOLS, roamingType = RoamingType.DISABLED))
 public final class NixExternalFormatterSettings implements PersistentStateComponent<NixExternalFormatterSettings.State> {
 
-    // TODO: Use RoamingType.LOCAL with 2024.1
-
     // Documentation:
     // https://plugins.jetbrains.com/docs/intellij/persisting-state-of-components.html
 
@@ -29,28 +27,28 @@ public final class NixExternalFormatterSettings implements PersistentStateCompon
     }
 
     public boolean isFormatEnabled() {
-        return myState.formatEnabled;
+        return myState.enabled;
     }
 
     public void setFormatEnabled(boolean enabled) {
-        myState.formatEnabled = enabled;
+        myState.enabled = enabled;
     }
 
     public @NotNull String getFormatCommand() {
-        return myState.formatCommand;
+        return myState.command;
     }
 
     public void setFormatCommand(@NotNull String command) {
-        myState.formatCommand = command;
+        myState.command = command;
         addFormatCommandToHistory(command);
     }
 
     public @NotNull Collection<String> getCommandHistory() {
-        return Collections.unmodifiableCollection(myState.formatCommandHistory);
+        return Collections.unmodifiableCollection(myState.history);
     }
 
     private void addFormatCommandToHistory(@NotNull String command) {
-        Deque<String> history = myState.formatCommandHistory;
+        Deque<String> history = myState.history;
         history.remove(command);
         history.addFirst(command);
         while (history.size() > MAX_HISTORY_SIZE) {
@@ -71,8 +69,8 @@ public void loadState(@NotNull State state) {
     }
 
     static final class State {
-        public boolean formatEnabled = false;
-        public @NotNull String formatCommand = "";
-        public Deque<String> formatCommandHistory = new ArrayDeque<>();
+        public boolean enabled = false;
+        public @NotNull String command = "";
+        public Deque<String> history = new ArrayDeque<>();
     }
 }

src/main/java/org/nixos/idea/settings/NixStoragePaths.java

@@ -0,0 +1,21 @@
+package org.nixos.idea.settings;
+
+import com.intellij.openapi.components.RoamingType;
+import com.intellij.openapi.components.Storage;
+
+/**
+ * Constants to be used for {@link Storage#value()}.
+ */
+public final class NixStoragePaths {
+
+    /**
+     * Location and configuration of external tools.
+     * The settings in the file are considered system dependent.
+     * This constant must be used with {@link RoamingType#DISABLED}.
+     * TODO: Use RoamingType.LOCAL with 2024.1
+     */
+    public static final String TOOLS = "nix-idea-tools.xml";
+
+    private NixStoragePaths() {} // Cannot be instantiated
+
+}