Added support for global options.

Author: JordanMarr

src/FSharp.SystemCommandLine/CommandBuilders.fs

@@ -17,10 +17,20 @@ let private parseInput<'V> (handlerInputs: HandlerInput list) (ctx: IC) (idx: in
     | ParsedArgument a -> ctx.ParseResult.GetValueForArgument<'V>(a :?> Argument<'V>)
     | Context -> ctx |> unbox<'V>
 
+let private addGlobalOptionsToParser (globalInputs: HandlerInput list) (parser: Parser) =
+    globalInputs
+    |> List.iter (fun gi ->
+        match gi.Source with
+        | ParsedOption o -> parser.Configuration.RootCommand.AddGlobalOption(o)
+        | _ -> ()
+    )
+    parser
+
 type CommandSpec<'Inputs, 'Output> = 
     {
         Description: string
         Inputs: HandlerInput list
+        GlobalInputs: HandlerInput list
         Handler: 'Inputs -> 'Output
         Aliases: string list
         SubCommands: System.CommandLine.Command list
@@ -31,6 +41,7 @@ type CommandSpec<'Inputs, 'Output> =
         { 
             Description = "My Command"
             Inputs = []
+            GlobalInputs = []
             Aliases = []
             ExtraInputs = []
             Handler = def<unit -> 'Output> // Support unit -> 'Output handler by default
@@ -44,6 +55,7 @@ type BaseCommandBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>() =
         {
             Description = spec.Description
             Inputs = spec.Inputs
+            GlobalInputs = spec.GlobalInputs
             Aliases = spec.Aliases
             ExtraInputs = spec.ExtraInputs
             Handler = handler
@@ -108,6 +120,14 @@ type BaseCommandBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>() =
     member this.SetHandler (spec: CommandSpec<'Inputs, 'Output>, handler: 'Inputs -> 'Output) =
         newHandler handler spec
 
+    [<CustomOperation("addGlobalOption")>]
+    member this.AddGlobalOption (spec: CommandSpec<'Inputs, 'Output>, globalInput: HandlerInput) =
+        { spec with GlobalInputs = spec.GlobalInputs @ [ globalInput ] }
+
+    [<CustomOperation("addGlobalOptions")>]
+    member this.AddGlobalOptions (spec: CommandSpec<'Inputs, 'Output>, globalInputs: HandlerInput seq) =
+        { spec with GlobalInputs = spec.GlobalInputs @ (globalInputs |> List.ofSeq) }
+
     [<Obsolete("'setCommand' has been deprecated in favor of 'addCommand' or 'addCommands'.")>]
     [<CustomOperation("setCommand")>] 
     member this.SetCommand (spec: CommandSpec<'Inputs, 'Output>, subCommand: System.CommandLine.Command) =
@@ -401,6 +421,7 @@ type RootCommandParserBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>() =
         |> this.SetHandlerUnit spec
         |> ignore
         this.CommandLineBuilder.Build()
+        |> addGlobalOptionsToParser spec.GlobalInputs
 
     /// Executes a Command with a handler that returns int.
     member this.Run (spec: CommandSpec<'Inputs, int>) =
@@ -409,6 +430,7 @@ type RootCommandParserBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>() =
         |> this.SetHandlerInt spec
         |> ignore
         this.CommandLineBuilder.Build()
+        |> addGlobalOptionsToParser spec.GlobalInputs
 
     /// Executes a Command with a handler that returns a Task<unit> or Task<int>.
     member this.Run (spec: CommandSpec<'Inputs, Task<'ReturnValue>>) =
@@ -417,6 +439,7 @@ type RootCommandParserBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>() =
         |> this.SetHandlerTask spec
         |> ignore
         this.CommandLineBuilder.Build()
+        |> addGlobalOptionsToParser spec.GlobalInputs
 
 
 /// Builds and executes a `System.CommandLine.RootCommand`.
@@ -439,46 +462,73 @@ type RootCommandBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>(args: string ar
         |> this.SetGeneralProperties spec
         |> this.SetHandlerUnit spec
         |> ignore
-        this.CommandLineBuilder.Build().Parse(args).Invoke()
+        
+        let parser = 
+            this.CommandLineBuilder.Build()
+            |> addGlobalOptionsToParser spec.GlobalInputs
+
+        parser.Parse(args).Invoke()
 
     /// Executes a Command with a handler that returns int.
     member this.Run (spec: CommandSpec<'Inputs, int>) =
         this.CommandLineBuilder.Command
         |> this.SetGeneralProperties spec
         |> this.SetHandlerInt spec
         |> ignore
-        this.CommandLineBuilder.Build().Parse(args).Invoke()
+        
+        let parser = 
+            this.CommandLineBuilder.Build()
+            |> addGlobalOptionsToParser spec.GlobalInputs
+
+        parser.Parse(args).Invoke()
 
     /// Executes a Command with a handler that returns a Task<unit> or Task<int>.
     member this.Run (spec: CommandSpec<'Inputs, Task<'ReturnValue>>) =
         this.CommandLineBuilder.Command
         |> this.SetGeneralProperties spec
         |> this.SetHandlerTask spec
         |> ignore
-        this.CommandLineBuilder.Build().Parse(args).InvokeAsync()
+        
+        let parser = 
+            this.CommandLineBuilder.Build()
+            |> addGlobalOptionsToParser spec.GlobalInputs
+
+        parser.Parse(args).InvokeAsync()
 
 
 /// Builds a `System.CommandLine.Command`.
 type CommandBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>(name: string) = 
     inherit BaseCommandBuilder<'A, 'B, 'C, 'D, 'E, 'F, 'G, 'H, 'Output>()
 
+    let addGlobalOptionsToCommand (globalOptions: HandlerInput list) (cmd: Command) =
+        globalOptions
+        |> List.iter (fun g ->
+            match g.Source with
+            | ParsedOption o -> cmd.AddGlobalOption(o)
+            | _ -> ()
+        )
+        cmd
+
     /// Returns a Command with a handler that returns unit.
     member this.Run (spec: CommandSpec<'Inputs, unit>) = 
         Command(name)
         |> this.SetGeneralProperties spec
         |> this.SetHandlerUnit spec
+        |> addGlobalOptionsToCommand spec.GlobalInputs
 
     /// Executes a Command with a handler that returns int.
     member this.Run (spec: CommandSpec<'Inputs, int>) =
         Command(name)
         |> this.SetGeneralProperties spec
         |> this.SetHandlerInt spec
+        |> addGlobalOptionsToCommand spec.GlobalInputs
 
     /// Executes a Command with a handler that returns a Task<unit> or Task<int>.
     member this.Run (spec: CommandSpec<'Inputs, Task<'ReturnValue>>) =
         Command(name)
         |> this.SetGeneralProperties spec
         |> this.SetHandlerTask spec
+        |> addGlobalOptionsToCommand spec.GlobalInputs
 
 
 /// Builds a `System.CommandLine.RootCommand` using computation expression syntax.

src/TestConsole/ProgramNestedSubCommands.fs

@@ -2,9 +2,26 @@
 
 open System.IO
 open FSharp.SystemCommandLine
+open System.CommandLine.Invocation
+
+module Global = 
+    let enableLogging = Input.Option<bool>("--enable-logging", false)
+    let logFile = Input.Option<FileInfo>("--log-file", FileInfo @"c:\temp\default.log")
+
+    type Options = { EnableLogging: bool; LogFile: FileInfo }
+
+    let options: HandlerInput seq = [ enableLogging; logFile ] 
+
+    let bind (ctx: InvocationContext) = 
+        { EnableLogging = enableLogging.GetValue ctx
+          LogFile = logFile.GetValue ctx }
 
 let listCmd =
-    let handler (dir: DirectoryInfo) =
+    let handler (ctx: InvocationContext, dir: DirectoryInfo) =
+        let options = Global.bind ctx
+        if options.EnableLogging then 
+            printfn $"Logging enabled to {options.LogFile.FullName}"
+
         if dir.Exists then
             dir.EnumerateFiles()
             |> Seq.iter (fun f -> printfn "%s" f.FullName)
@@ -15,13 +32,17 @@ let listCmd =
 
     command "list" {
         description "lists contents of a directory"
-        inputs dir
+        inputs (Input.Context(), dir)
         setHandler handler
         addAlias "ls"
     }
 
 let deleteCmd =
-    let handler (dir: DirectoryInfo, recursive: bool) =
+    let handler (ctx: InvocationContext, dir: DirectoryInfo, recursive: bool) =
+        let options = Global.bind ctx
+        if options.EnableLogging then 
+            printfn $"Logging enabled to {options.LogFile.FullName}"
+        
         if dir.Exists then
             if recursive then
                 printfn $"Recursively deleting {dir.FullName}"
@@ -35,7 +56,7 @@ let deleteCmd =
 
     command "delete" {
         description "deletes a directory"
-        inputs (dir, recursive)
+        inputs (Input.Context(), dir, recursive)
         setHandler handler
         addAlias "del"
     }
@@ -47,11 +68,11 @@ let ioCmd =
         addCommands [ deleteCmd; listCmd ]
     }
 
-
-// [<EntryPoint>]
+//[<EntryPoint>]
 let main argv =
     rootCommand argv {
         description "Sample app for System.CommandLine"
         setHandler id
+        addGlobalOptions Global.options
         addCommand ioCmd
     }

src/TestConsole/Properties/launchSettings.json

@@ -14,7 +14,7 @@
     },
     "IO Nested SubCommands": {
       "commandName": "Project",
-      "commandLineArgs": "io list c:/data/"
-    },
+      "commandLineArgs": "io list c:/data/ --enable-logging true"
+    }
   }
 }