Merge pull request #67 from mrboring/main

Added WindowStyle

README.md

@@ -124,6 +124,15 @@ cli {
 |> Command.execute
 ```
 
+For Windows applications it's possible to set their visibility. There are four possible values: `Hidden`, `Maximized`, `Minimized` and `Normal`. The default is `Hidden`.
+```fsharp
+cli {
+        Exec @"C:\Windows\regedit.exe"
+        WindowStyle Normal
+}
+|> Command.execute
+```
+
 #### `Command.execute`
 `Command.execute` returns record: `type Output = { Id: int; Text: string option; ExitCode: int; Error: string option }`
 which has getter methods to get only one value:
@@ -236,6 +245,7 @@ cli {
 | `Input`                | `string`                   |
 | `Output`               | `Outputs` (see below)      |
 | `WorkingDirectory`     | `string`                   |
+| `WindowStyle`          | `Fli.WindowStyle`          |
 | `EnvironmentVariable`  | `string * string`          |
 | `EnvironmentVariables` | `(string * string) list`   |
 | `Encoding`             | `System.Text.Encoding`     |
@@ -252,6 +262,7 @@ cli {
 | `Username`             | `string`                                                 |
 | `Credentials`          | `string * string * string`                               |
 | `WorkingDirectory`     | `string`                                                 |
+| `WindowStyle`          | `Fli.WindowStyle`                                        |
 | `EnvironmentVariable`  | `string * string`                                        |
 | `EnvironmentVariables` | `(string * string) list`                                 |
 | `Encoding`             | `System.Text.Encoding`                                   |
@@ -270,6 +281,12 @@ Provided `Fli.Outputs`:
 - `StringBuilder of StringBuilder` a StringBuilder which will be filled with the output text.
 - `Custom of Func<string, unit>` a custom function (`string -> unit`) that will be called with the output string (logging, printing etc.).
 
+Provided `Fli.WindowStyle`:
+- `Hidden` (default)
+- `Maximized`
+- `Minimized`
+- `Normal`
+
 ### Do you miss something?
 Open an [issue](https://github.com/CaptnCodr/Fli/issues) or start a [discussion](https://github.com/CaptnCodr/Fli/discussions).
 

src/Fli.Tests/ExecContext/ExecCommandConfigureTests.fs

@@ -28,13 +28,23 @@ let ``Check Arguments in ProcessStartInfo with Arguments`` () =
 [<Test>]
 let ``Check WorkingDirectory in ProcessStartInfo with WorkingDirectory`` () =
     cli {
-        Exec "cnd.exe"
+        Exec "cmd.exe"
         WorkingDirectory @"C:\Users"
     }
     |> Command.buildProcess
     |> _.WorkingDirectory
     |> should equal @"C:\Users"
 
+[<Test>]
+let ``Check WindowStyle in ProcessStartInfo with WorkingDirectory`` () =
+    cli {
+        Exec "cmd.exe"
+        WindowStyle Normal
+    }
+    |> Command.buildProcess
+    |> _.WindowStyle
+    |> should equal Diagnostics.ProcessWindowStyle.Normal
+
 [<Test>]
 let ``Check Verb in ProcessStartInfo with Verb`` () =
     if OperatingSystem.IsWindows() then
@@ -123,6 +133,7 @@ let ``Check all possible values in ProcessStartInfo for windows`` () =
                 EnvironmentVariable("Fli", "test")
                 EnvironmentVariables [ ("Fli.Test", "test") ]
                 Encoding Encoding.UTF8
+                WindowStyle Normal
             }
             |> Command.buildProcess
 
@@ -137,6 +148,7 @@ let ``Check all possible values in ProcessStartInfo for windows`` () =
         config.Environment.Contains(KeyValuePair("Fli.Test", "test")) |> should be True
         config.StandardOutputEncoding |> should equal Encoding.UTF8
         config.StandardErrorEncoding |> should equal Encoding.UTF8
+        config.WindowStyle |> should equal Diagnostics.ProcessWindowStyle.Normal
     else
         let config =
             cli {

src/Fli.Tests/ExecContext/ExecConfigTests.fs

@@ -54,6 +54,14 @@ let ``Check working directory config for executing program`` () =
     |> _.config.WorkingDirectory
     |> should equal (Some @"C:\Users")
 
+[<Test>]
+let ``Check windowstyle config for executing program`` () =
+    cli {
+        Exec "cmd.exe"
+        WindowStyle Normal }
+    |> _.config.WindowStyle
+    |> should equal (Some Normal)
+
 [<Test>]
 let ``Check Verb config for executing program`` () =
     cli {

src/Fli/CE.fs

@@ -56,6 +56,12 @@ module CE =
         member _.WorkingDirectory(context: ICommandContext<ShellContext>, workingDirectory) =
             Cli.workingDirectory workingDirectory context.Context
 
+        /// The `WindowStyle` for newly created windows.
+        /// Hint: Hidden, Maximized, Minimized or Normal.
+        [<CustomOperation("WindowStyle")>]
+        member _.WindowStyle(context: ICommandContext<ShellContext>, windowStyle) =
+            Cli.windowStyle windowStyle context.Context
+
         /// One tupled `EnvironmentVariable`.
         [<CustomOperation("EnvironmentVariable")>]
         member _.EnvironmentVariable(context: ICommandContext<ShellContext>, environmentVariable) =
@@ -118,6 +124,12 @@ module CE =
         member _.WorkingDirectory(context: ICommandContext<ExecContext>, workingDirectory) =
             Program.workingDirectory workingDirectory context.Context
 
+        /// The `WindowStyle` for newly created windows.
+        /// Hint: Hidden, Maximized, Minimized or Normal.
+        [<CustomOperation("WindowStyle")>]
+        member _.WindowStyle(context: ICommandContext<ExecContext>, windowStyle) =
+            Program.windowStyle windowStyle context.Context
+
         /// `Verb` keyword that can be used to start the executable.
         [<CustomOperation("Verb")>]
         member _.Verb(context: ICommandContext<ExecContext>, verb) = Program.verb verb context.Context

src/Fli/Command.fs

@@ -32,7 +32,6 @@ module Command =
         ProcessStartInfo(
             FileName = executable,
             Arguments = argumentString,
-            WindowStyle = ProcessWindowStyle.Hidden,
             CreateNoWindow = true,
             UseShellExecute = openDefault,
             RedirectStandardInput = not (openDefault),
@@ -205,6 +204,13 @@ module Command =
         | Shells.BASH -> context.config.Command |> Option.defaultValue "" |> (fun s -> $"\"{s}\"")
         | _ -> context.config.Command |> Option.defaultValue ""
 
+    let private getProcessWindowStyle (windowStyle: WindowStyle) =
+        match windowStyle with
+        | Hidden -> ProcessWindowStyle.Hidden
+        | Maximized -> ProcessWindowStyle.Maximized
+        | Minimized -> ProcessWindowStyle.Minimized
+        | Normal -> ProcessWindowStyle.Normal
+
     type Command =
         static member internal buildProcess(context: ShellContext) =
             let (proc, flag) = (context.config.Shell, context.config.Input) ||> shellToProcess
@@ -214,6 +220,7 @@ module Command =
                 .With(WorkingDirectory = (context.config.WorkingDirectory |> Option.defaultValue ""))
                 .With(StandardOutputEncoding = (context.config.Encoding |> Option.defaultValue null))
                 .With(StandardErrorEncoding = (context.config.Encoding |> Option.defaultValue null))
+                .With(WindowStyle = getProcessWindowStyle (context.config.WindowStyle |> Option.defaultValue Hidden))
             |> addEnvironmentVariables context.config.EnvironmentVariables
 
         static member internal buildProcess(context: ExecContext) =
@@ -233,6 +240,7 @@ module Command =
                 .With(UserName = (context.config.UserName |> Option.defaultValue ""))
                 .With(StandardOutputEncoding = (context.config.Encoding |> Option.defaultValue null))
                 .With(StandardErrorEncoding = (context.config.Encoding |> Option.defaultValue null))
+                .With(WindowStyle = getProcessWindowStyle (context.config.WindowStyle |> Option.defaultValue Hidden))
             |> addCredentials context.config.Credentials
             |> addEnvironmentVariables context.config.EnvironmentVariables
 

src/Fli/Domain.fs

@@ -17,7 +17,8 @@ module Domain =
           WorkingDirectory: string option
           EnvironmentVariables: (string * string) list option
           Encoding: Encoding option
-          CancelAfter: int option }
+          CancelAfter: int option
+          WindowStyle: WindowStyle option }
 
     and Shells =
         | CMD
@@ -32,6 +33,12 @@ module Domain =
         | StringBuilder of StringBuilder
         | Custom of Func<string, unit>
 
+    and WindowStyle =
+        | Hidden
+        | Maximized
+        | Minimized
+        | Normal
+
     type ExecConfig =
         { Program: string
           Arguments: string option
@@ -43,7 +50,8 @@ module Domain =
           Credentials: Credentials option
           EnvironmentVariables: (string * string) list option
           Encoding: Encoding option
-          CancelAfter: int option }
+          CancelAfter: int option
+          WindowStyle: WindowStyle option }
 
     and Credentials = Credentials of Domain: string * UserName: string * Password: string
 
@@ -72,7 +80,8 @@ module Domain =
               WorkingDirectory = None
               EnvironmentVariables = None
               Encoding = None
-              CancelAfter = None }
+              CancelAfter = None
+              WindowStyle = None }
           ExecConfig =
             { Program = ""
               Arguments = None
@@ -84,7 +93,8 @@ module Domain =
               Credentials = None
               EnvironmentVariables = None
               Encoding = None
-              CancelAfter = None } }
+              CancelAfter = None
+              WindowStyle = None } }
 
     type Output =
         { Id: int

src/Fli/Dsl.fs

@@ -25,6 +25,10 @@ module Cli =
         { context with
             config.WorkingDirectory = Some workingDirectory }
 
+    let windowStyle (windowStyle: WindowStyle) (context: ShellContext) =
+        { context with
+            config.WindowStyle = Some windowStyle }
+
     let environmentVariables (variables: (string * string) list) (context: ShellContext) =
         let vars =
             match context.config.EnvironmentVariables with
@@ -65,6 +69,10 @@ module Program =
         { context with
             config.WorkingDirectory = Some workingDirectory }
 
+    let windowStyle (windowStyle: WindowStyle) (context: ExecContext) =
+        { context with
+            config.WindowStyle = Some windowStyle }
+
     let verb (verb: string) (context: ExecContext) =
         { context with config.Verb = Some verb }