Implement global setting for run on save (#1798)

closes #1739

Author: belav

.github/workflows/ValidatePullRequest.yml

@@ -36,6 +36,14 @@ jobs:
           rm -r -f ./Tests/CSharpier.MsBuild.Test
           dotnet tool restore
           dotnet csharpier check .
+          cd ./Src/CSharpier.Rider
+          npm install
+          npm run prettier:check
+          cd ..
+          cd ./CSharpier.Playground/ClientApp
+          npm install
+          npm run prettier:check
+          
   check_todos:
     runs-on: ubuntu-latest
     name: Check TODOs

Src/CSharpier.Playground/ClientApp/package.json

@@ -27,6 +27,7 @@
     "scripts": {
         "build": "tsc && vite build",
         "prettier": "prettier --parser typescript ./src/**/*.{ts,tsx} --write",
+        "prettier:check": "prettier --parser typescript ./src/**/*.{ts,tsx} --check",
         "start": "echo Starting the development server && vite"
     },
     "browserslist": {

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
 

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

Src/CSharpier.Rider/package.json

@@ -1,9 +1,10 @@
 {
-  "scripts": {
-    "prettier": "prettier ./**/*.java --write"
-  },
-  "devDependencies": {
-    "prettier": "^3.4.2",
-    "prettier-plugin-java": "^2.6.4"
-  }
+    "scripts": {
+        "prettier": "prettier ./**/*.java --write",
+        "prettier:check": "prettier ./**/*.java --check"
+    },
+    "devDependencies": {
+        "prettier": "^3.4.2",
+        "prettier-plugin-java": "^2.6.4"
+    }
 }

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);
+    }
+}

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) {

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(() -> {

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;
     }
 

Src/CSharpier.Rider/src/main/java/com/intellij/csharpier/CSharpierSettingsComponent.java

@@ -2,6 +2,7 @@
 
 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;
@@ -14,8 +15,14 @@
 
 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 +73,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 +95,15 @@ private JComponent createSectionHeader(String label) {
             .getPanel();
     }
 
+    private Boolean getSelectedSolutionRunOnSave() {
+        return ((ComboItem) this.solutionRunOnSaveComboBox.getSelectedItem()).value;
+    }
+
     @Override
     public boolean isModified() {
         return (
             CSharpierSettings.getInstance(this.project).getRunOnSave() !=
-                this.runOnSaveCheckBox.isSelected() ||
+                this.getSelectedSolutionRunOnSave() ||
             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.getSelectedSolutionRunOnSave());
         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;
+        }
+    }
 }