Implement global setting for run on save

belav · belav · commit c734d39953b8 · 2026-01-01T15:19:37.000-06:00
closes #1739
diff --git a/Src/CSharpier.Rider/CHANGELOG.md b/Src/CSharpier.Rider/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 # csharpier-rider Changelog
 
+## [2.3.0]
+- Add a global format on save option
+
 ## [2.2.4]
 - Fix Stream closed exception in Rider plugin
 
diff --git a/Src/CSharpier.Rider/gradle.properties b/Src/CSharpier.Rider/gradle.properties
@@ -1,4 +1,4 @@
-pluginVersion = 2.2.4
+pluginVersion = 2.3.0
 
 # See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 pluginSinceBuild = 222
diff --git a/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierGlobalSettings.java b/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierGlobalSettings.java
@@ -0,0 +1,40 @@
+package com.intellij.csharpier;
+
+import com.intellij.openapi.application.ApplicationManager;
+import com.intellij.openapi.components.PersistentStateComponent;
+import com.intellij.openapi.components.State;
+import com.intellij.openapi.components.Storage;
+import com.intellij.util.xmlb.XmlSerializerUtil;
+import org.jetbrains.annotations.NotNull;
+
+@State(
+    name = "com.intellij.csharpier.global",
+    storages = @Storage("$APP_CONFIG$/CSharpierPlugin.xml")
+)
+public class CSharpierGlobalSettings implements PersistentStateComponent<CSharpierGlobalSettings> {
+
+    @NotNull
+    public static CSharpierGlobalSettings getInstance() {
+        return ApplicationManager.getApplication().getService(CSharpierGlobalSettings.class);
+    }
+
+    private boolean runOnSave;
+
+    public boolean getRunOnSave() {
+        return this.runOnSave;
+    }
+
+    public void setRunOnSave(boolean value) {
+        this.runOnSave = value;
+    }
+
+    @Override
+    public CSharpierGlobalSettings getState() {
+        return this;
+    }
+
+    @Override
+    public void loadState(@NotNull CSharpierGlobalSettings state) {
+        XmlSerializerUtil.copyBean(state, this);
+    }
+}
diff --git a/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierProcessProvider.java b/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierProcessProvider.java
@@ -207,11 +207,15 @@ private String findVersionInCsProjOfParentsDirectories(String directoryThatConta
 
     private String findVersionInCsProj(Path currentDirectory) {
         this.logger.debug("Looking for " + currentDirectory + "/*.csproj");
-        File[] csProjFiles = currentDirectory.toFile()
+        File[] csProjFiles = currentDirectory
+            .toFile()
             .listFiles((dir, name) -> name.toLowerCase().endsWith(".csproj"));
         if (csProjFiles == null) {
-            this.logger.debug("Unable to list files in directory: " + currentDirectory +
-                " (directory may not exist, not be a directory, or be temporarily inaccessible)");
+            this.logger.debug(
+                    "Unable to list files in directory: " +
+                    currentDirectory +
+                    " (directory may not exist, not be a directory, or be temporarily inaccessible)"
+                );
             return null;
         }
         for (var pathToCsProj : csProjFiles) {
diff --git a/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierProcessServer.java b/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierProcessServer.java
@@ -51,20 +51,23 @@ private void startProcess() {
             var csharpierProcess = processBuilder.start();
 
             var errorOutput = new StringBuilder();
-            var stderrThread = new Thread(() -> {
-                try (
-                    var errorReader = new BufferedReader(
-                        new InputStreamReader(csharpierProcess.getErrorStream())
-                    )
-                ) {
-                    String line;
-                    while ((line = errorReader.readLine()) != null) {
-                        errorOutput.append(line).append("\n");
+            var stderrThread = new Thread(
+                () -> {
+                    try (
+                        var errorReader = new BufferedReader(
+                            new InputStreamReader(csharpierProcess.getErrorStream())
+                        )
+                    ) {
+                        String line;
+                        while ((line = errorReader.readLine()) != null) {
+                            errorOutput.append(line).append("\n");
+                        }
+                    } catch (IOException e) {
+                        // Stream closed or process terminated - expected behavior
                     }
-                } catch (IOException e) {
-                    // Stream closed or process terminated - expected behavior
-                }
-            }, "CSharpier stderr reader");
+                },
+                "CSharpier stderr reader"
+            );
             stderrThread.start();
 
             var stdoutThread = new Thread(() -> {
diff --git a/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierSettings.java b/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierSettings.java
@@ -15,13 +15,13 @@ static CSharpierSettings getInstance(@NotNull Project project) {
         return project.getService(CSharpierSettings.class);
     }
 
-    private boolean runOnSave;
+    private Boolean runOnSave;
 
-    public boolean getRunOnSave() {
+    public Boolean getRunOnSave() {
         return this.runOnSave;
     }
 
-    public void setRunOnSave(boolean value) {
+    public void setRunOnSave(Boolean value) {
         this.runOnSave = value;
     }
 
diff --git a/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierSettingsComponent.java b/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierSettingsComponent.java
@@ -2,20 +2,28 @@
 
 import com.intellij.openapi.options.SearchableConfigurable;
 import com.intellij.openapi.project.Project;
+import com.intellij.openapi.ui.ComboBox;
 import com.intellij.ui.components.JBCheckBox;
 import com.intellij.ui.components.JBLabel;
 import com.intellij.ui.components.JBTextField;
 import com.intellij.util.ui.FormBuilder;
 import java.awt.*;
+import java.util.Arrays;
 import javax.swing.*;
 import org.jetbrains.annotations.Nls;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
 public class CSharpierSettingsComponent implements SearchableConfigurable {
 
+    private final ComboItem[] runOnSaveItems = {
+        new ComboItem(null, "Use Global Setting"),
+        new ComboItem(true, "True"),
+        new ComboItem(false, "False"),
+    };
     private final Project project;
-    private JBCheckBox runOnSaveCheckBox = new JBCheckBox("Run on Save");
+    private ComboBox<ComboItem> solutionRunOnSaveComboBox = new ComboBox<>(runOnSaveItems);
+    private JBCheckBox globalRunOnSaveCheckBox = new JBCheckBox("Run on Save (Global)");
     private JBCheckBox disableCSharpierServerCheckBox = new JBCheckBox("Disable CSharpier Server");
     private JBCheckBox useCustomPath = new JBCheckBox("Override CSharpier Executable");
     private JBTextField customPathTextField = new JBTextField();
@@ -66,7 +74,13 @@ private JComponent createSectionHeader(String label) {
         return FormBuilder.createFormBuilder()
             .addComponent(createSectionHeader("General Settings"))
             .setFormLeftIndent(leftIndent)
-            .addComponent(this.runOnSaveCheckBox, topInset)
+            .addLabeledComponent(
+                new JBLabel("Run on save (Solution):"),
+                this.solutionRunOnSaveComboBox,
+                topInset,
+                false
+            )
+            .addComponent(this.globalRunOnSaveCheckBox, topInset)
             .setFormLeftIndent(0)
             .addComponent(createSectionHeader("Developer Settings"), 20)
             .setFormLeftIndent(leftIndent)
@@ -82,11 +96,14 @@ private JComponent createSectionHeader(String label) {
             .getPanel();
     }
 
+    private Boolean getSelected() {
+        return ((ComboItem) this.solutionRunOnSaveComboBox.getSelectedItem()).value;
+    }
+
     @Override
     public boolean isModified() {
         return (
-            CSharpierSettings.getInstance(this.project).getRunOnSave() !=
-                this.runOnSaveCheckBox.isSelected() ||
+            CSharpierSettings.getInstance(this.project).getRunOnSave() != this.getSelected() ||
             CSharpierSettings.getInstance(this.project).getCustomPath() !=
             this.customPathTextField.getText() ||
             CSharpierSettings.getInstance(this.project).getUseCustomPath() !=
@@ -100,18 +117,40 @@ public boolean isModified() {
     public void apply() {
         var settings = CSharpierSettings.getInstance(this.project);
 
-        settings.setRunOnSave(this.runOnSaveCheckBox.isSelected());
+        settings.setRunOnSave(this.getSelected());
         settings.setCustomPath(this.customPathTextField.getText());
         settings.setDisableCSharpierServer(this.disableCSharpierServerCheckBox.isSelected());
         settings.setUseCustomPath(this.useCustomPath.isSelected());
+
+        CSharpierGlobalSettings.getInstance()
+            .setRunOnSave(this.globalRunOnSaveCheckBox.isSelected());
     }
 
     @Override
     public void reset() {
         var settings = CSharpierSettings.getInstance(this.project);
-        this.runOnSaveCheckBox.setSelected(settings.getRunOnSave());
+
+        var index = -1;
+        for (var i = 0; i < runOnSaveItems.length; i++) {
+            if (runOnSaveItems[i].value == settings.getRunOnSave()) {
+                index = i;
+                break;
+            }
+        }
+
+        this.solutionRunOnSaveComboBox.setSelectedIndex(index);
+        this.globalRunOnSaveCheckBox.setSelected(
+                CSharpierGlobalSettings.getInstance().getRunOnSave()
+            );
         this.useCustomPath.setSelected(settings.getUseCustomPath());
         this.customPathTextField.setText(settings.getCustomPath());
         this.disableCSharpierServerCheckBox.setSelected(settings.getDisableCSharpierServer());
     }
+
+    public record ComboItem(Boolean value, String label) {
+        @Override
+        public String toString() {
+            return label;
+        }
+    }
 }
diff --git a/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/ReformatWithCSharpierOnSaveListener.java b/Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/ReformatWithCSharpierOnSaveListener.java
@@ -20,7 +20,11 @@ public void beforeDocumentSaving(@NotNull Document document) {
         }
 
         var cSharpierSettings = CSharpierSettings.getInstance(project);
-        if (!cSharpierSettings.getRunOnSave()) {
+        var shouldRunOnSave =
+            Boolean.TRUE.equals(cSharpierSettings.getRunOnSave()) ||
+            (cSharpierSettings.getRunOnSave() == null &&
+                CSharpierGlobalSettings.getInstance().getRunOnSave());
+        if (!shouldRunOnSave) {
             return;
         }
 
diff --git a/Src/CSharpier.Rider/src/main/resources/META-INF/plugin.xml b/Src/CSharpier.Rider/src/main/resources/META-INF/plugin.xml
@@ -5,6 +5,7 @@
   <vendor>belav</vendor>
   <depends>com.intellij.modules.rider</depends>
   <extensions defaultExtensionNs="com.intellij">
+    <applicationService serviceImplementation="com.intellij.csharpier.CSharpierGlobalSettings" />
     <projectService serviceImplementation="com.intellij.csharpier.CSharpierProcessProvider" />
     <projectService serviceImplementation="com.intellij.csharpier.DotNetProvider" />
     <projectService serviceImplementation="com.intellij.csharpier.FormattingService" />

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-pluginVersion = 2.2.4`
	`1`	`+pluginVersion = 2.3.0`
`2`	`2`
`3`	`3`	`# See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html`
`4`	`4`	`pluginSinceBuild = 222`
Original file line number	Diff line number	Diff line change
`@@ -15,13 +15,13 @@ static CSharpierSettings getInstance(@NotNull Project project) {`
`15`	`15`	`return project.getService(CSharpierSettings.class);`
`16`	`16`	`}`
`17`	`17`
`18`		`- private boolean runOnSave;`
	`18`	`+ private Boolean runOnSave;`
`19`	`19`
`20`		`- public boolean getRunOnSave() {`
	`20`	`+ public Boolean getRunOnSave() {`
`21`	`21`	`return this.runOnSave;`
`22`	`22`	`}`
`23`	`23`
`24`		`- public void setRunOnSave(boolean value) {`
	`24`	`+ public void setRunOnSave(Boolean value) {`
`25`	`25`	`this.runOnSave = value;`
`26`	`26`	`}`
`27`	`27`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,11 @@ public void beforeDocumentSaving(@NotNull Document document) {`
`20`	`20`	`}`
`21`	`21`
`22`	`22`	`var cSharpierSettings = CSharpierSettings.getInstance(project);`
`23`		`- if (!cSharpierSettings.getRunOnSave()) {`
	`23`	`+ var shouldRunOnSave =`
	`24`	`+ Boolean.TRUE.equals(cSharpierSettings.getRunOnSave()) \|\|`
	`25`	`+ (cSharpierSettings.getRunOnSave() == null &&`
	`26`	`+ CSharpierGlobalSettings.getInstance().getRunOnSave());`
	`27`	`+ if (!shouldRunOnSave) {`
`24`	`28`	`return;`
`25`	`29`	`}`
`26`	`30`