#3 Add setup window which is open on first run of the app

Author: introfog

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to GitWave
 
-We welcome contributions to GitWave and are grateful for every pull request or issue submitted. 
+I welcome contributions to GitWave and are grateful for every pull request or issue submitted. 
 Below are the guidelines for contributing to our project.
 
 ## Reporting Issues
@@ -21,7 +21,7 @@ If you've identified a problem with the app, please follow these steps to report
 
 ### After Submitting an Issue
 Once you've submitted an issue, the maintainers will review it and respond accordingly. 
-We may ask for further information or clarification if needed. We appreciate your patience
+I may ask for further information or clarification if needed. I appreciate your patience
 and cooperation during this process.
 
 ## Pull Requests

README.md

@@ -10,7 +10,8 @@ It’s a powerful companion for any developer looking to save time and effort wh
 ### 1. Multi-Repository Command Execution
 Execute bash commands in multiple repositories with a single command, making it easier to manage complex workflows.
 ### 2. Command Management
-Save your most used or tricky commands with notes, so you never have to remember the syntax again.
+Save your most used or tricky commands with notes, so you never have to remember the syntax again. 
+Specify `{parameters}` for the command, to quickly run different scenarios.
 ### 3. Standalone Application
 GitWave is a standalone application that doesn't leave any footprint on your PC. It respects your 
 system's cleanliness by ensuring that no unnecessary files or configurations are left behind, 
@@ -43,7 +44,7 @@ Explore, contribute, and customize the application according to your preferences
 GitWave is licensed under the [Apache license](LICENSE.md), providing you with the freedom to use, modify, and distribute the software.
 
 ## Contributions
-We welcome contributions to my project. If you're interested in helping, please read 
+I welcome contributions to my project. If you're interested in helping, please read 
 [CONTRIBUTING.md](CONTRIBUTING.md) file for more information on how to get started.
 
 

src/main/java/com/github/introfog/gitwave/GitWaveLauncher.java

@@ -27,6 +27,10 @@ public class GitWaveLauncher extends Application {
     public void start(Stage stage) {
         StageFactory.createPrimaryExecuteWindow(stage).getStage().show();
         AppConfig.getInstance().setHostServices(getHostServices());
+        final String pathToGitBashExe = AppConfig.getInstance().getPathToGitBashExe();
+        if (pathToGitBashExe == null || pathToGitBashExe.isEmpty()) {
+            StageFactory.createModalSetupWindow().getStage().showAndWait();
+        }
     }
 
     public static void main(String[] args) {

src/main/java/com/github/introfog/gitwave/controller/SettingsController.java

@@ -57,7 +57,9 @@ public void initialize(FxmlStageHolder fxmlStageHolder) {
             pathToBashExe.setText(pathToGitBashExeStr);
         }
         save.requestFocus();
-        done.setVisible(false);
+        if (done != null) {
+            done.setVisible(false);
+        }
     }
 
     @FXML
@@ -66,6 +68,7 @@ protected void save() {
         if (bashExeFile.exists() && bashExeFile.getAbsolutePath().endsWith(".exe")) {
             final String absolutePath = bashExeFile.getAbsolutePath();
             AppConfig.getInstance().setPathToGitBashExe(absolutePath);
+            // TODO MINOR add check that path is specified to GitBash.exe not for any other .exe
             LOGGER.info("Path to GitBash.exe registered to '{}'", absolutePath);
             closeStage();
         } else {

src/main/java/com/github/introfog/gitwave/controller/main/MainController.java

@@ -122,6 +122,7 @@ protected void runCommand() {
             AppConfig.getInstance().setLastRunFolder(directoryToRunIn.getAbsolutePath());
 
             new Thread(() -> {
+                // TODO MINOR rewrite using javafx.concurrent.Task, because it is a native JavaFx way to do smth in background
                 switchRunButton(true);
                 final File scriptFile = CommandExecutor.searchGitRepositoriesAndCreateScriptFile(directoryToRunIn,
                         commandTabController.getCommandWithParameters());

src/main/java/com/github/introfog/gitwave/controller/main/MenuController.java

@@ -33,7 +33,7 @@ public MenuController(FxmlStageHolder fxmlStageHolder, Menu menu, MenuItem updat
     public boolean isValid() {
         final String pathToGitBashExe = AppConfig.getInstance().getPathToGitBashExe();
         if (pathToGitBashExe == null || pathToGitBashExe.isEmpty()) {
-            StageFactory.createModalSettingsWindow().getStage().showAndWait();
+            DialogFactory.createErrorAlert("GitBash path hasn't been specified", "Specify path to GitBash in Menu->Settings.");
             return false;
         } if (!(new File(pathToGitBashExe)).exists()) {
             LOGGER.error("Specified GitBash.exe path '{}' points to not-existent file, running git command was skipped.", pathToGitBashExe);
@@ -63,7 +63,7 @@ protected Boolean call() {
                 return UpdateChecker.isNewReleaseAvailable();
             }
         };
-        checkForUpdate.setOnSucceeded((e) -> {
+        checkForUpdate.setOnSucceeded(e -> {
             boolean isNewReleaseAvailable = checkForUpdate.getValue();
             if (isNewReleaseAvailable) {
                 this.menu.setText("Menu*");

src/main/java/com/github/introfog/gitwave/model/StageFactory.java

@@ -49,6 +49,13 @@ public static FxmlStageHolder createModalSettingsWindow() {
         return holder;
     }
 
+    public static FxmlStageHolder createModalSetupWindow() {
+        FxmlStageHolder holder = StageFactory.createModalStage("view/setup.fxml", "Setup");
+        holder.getStage().setMinWidth(520);
+        holder.getStage().setMinHeight(280);
+        return holder;
+    }
+
     public static FxmlStageHolder createModalAboutWindow() {
         FxmlStageHolder holder = StageFactory.createModalStage("view/about.fxml", "About");
         holder.getStage().setResizable(false);

src/main/resources/com/github/introfog/gitwave/view/setup.fxml

@@ -0,0 +1,54 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<?import javafx.geometry.Insets?>
+<?import javafx.scene.control.Button?>
+<?import javafx.scene.control.Label?>
+<?import javafx.scene.control.Separator?>
+<?import javafx.scene.control.TextField?>
+<?import javafx.scene.layout.AnchorPane?>
+<?import javafx.scene.layout.ColumnConstraints?>
+<?import javafx.scene.layout.GridPane?>
+<?import javafx.scene.layout.RowConstraints?>
+<?import javafx.scene.text.Font?>
+<AnchorPane prefHeight="240.0" prefWidth="550.0" style="-fx-font-family: verdana; -fx-font-size: 12;" xmlns="http://javafx.com/javafx/17.0.2-ea" xmlns:fx="http://javafx.com/fxml/1" fx:controller="com.github.introfog.gitwave.controller.SettingsController">
+   <children>
+      <GridPane layoutX="106.0" layoutY="48.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
+        <columnConstraints>
+          <ColumnConstraints hgrow="SOMETIMES" minWidth="10.0" prefWidth="100.0" />
+        </columnConstraints>
+        <rowConstraints>
+          <RowConstraints maxHeight="70.0" minHeight="70.0" prefHeight="70.0" vgrow="NEVER" />
+          <RowConstraints maxHeight="90.0" minHeight="90.0" prefHeight="90.0" vgrow="NEVER" />
+          <RowConstraints minHeight="10.0" prefHeight="30.0" vgrow="SOMETIMES" />
+        </rowConstraints>
+         <children>
+            <AnchorPane prefHeight="200.0" prefWidth="200.0">
+               <children>
+                  <Label alignment="TOP_CENTER" style="-fx-font-size: 14;" text="Welcome to GitWave - Multi-Repository Bash Command Runner!" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="0.0">
+                     <font>
+                        <Font size="14.0" />
+                     </font></Label>
+                  <Label text="Please fill mandatory fields, which are required for app working." AnchorPane.topAnchor="40.0" />
+                  <Separator prefWidth="200.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" />
+               </children>
+            </AnchorPane>
+            <AnchorPane prefHeight="200.0" prefWidth="200.0" GridPane.rowIndex="1">
+               <children>
+                  <Label text="Path to bash.exe on your PC (usually &quot;PATH_TO_GIT/bin/bash.exe&quot;)." AnchorPane.leftAnchor="0.0" AnchorPane.topAnchor="20.0" />
+                  <TextField fx:id="pathToBashExe" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="80.0" AnchorPane.topAnchor="50.0" />
+                  <Button mnemonicParsing="false" onAction="#browseGitBashExe" text="Browse" AnchorPane.rightAnchor="0.0" AnchorPane.topAnchor="50.0" />
+                  <Separator prefWidth="200.0" AnchorPane.bottomAnchor="0.0" AnchorPane.leftAnchor="0.0" AnchorPane.rightAnchor="0.0" />
+               </children>
+            </AnchorPane>
+            <AnchorPane prefHeight="200.0" prefWidth="200.0" GridPane.rowIndex="2">
+               <children>
+                  <Button fx:id="save" mnemonicParsing="false" onAction="#save" text="Save" AnchorPane.bottomAnchor="0.0" AnchorPane.rightAnchor="0.0" />
+               </children>
+            </AnchorPane>
+         </children>
+      </GridPane>
+   </children>
+   <padding>
+      <Insets bottom="20.0" left="20.0" right="20.0" top="20.0" />
+   </padding>
+</AnchorPane>