feature: add --port as a synonym to --socket (#1076)

Signed-off-by: Rudi Grinberg <[email protected]>

Author: rgrinberg

CHANGES.md

@@ -23,6 +23,8 @@
 
 - Accept the `--clientProcessId` command line argument. (#1074)
 
+- Accept `--port` as a synonym for `--socket`. (#1075)
+
 ## Features
 - Add "Remove type annotation" code action. (#1039)
 

lsp/src/cli.ml

@@ -14,6 +14,15 @@ module Arg = struct
     ; mutable clientProcessId : int option
     }
 
+  let port t ~name ~description =
+    ( name
+    , Arg.Int
+        (fun p ->
+          match t.port with
+          | Some _ -> raise @@ Arg.Bad "port is already set once"
+          | None -> t.port <- Some p)
+    , description )
+
   let create () =
     let t =
       { pipe = None
@@ -25,7 +34,8 @@ module Arg = struct
     in
     let spec =
       [ ("--pipe", Arg.String (fun p -> t.pipe <- Some p), "set pipe path")
-      ; ("--socket", Arg.Int (fun p -> t.port <- Some p), "set port")
+      ; port t ~name:"--socket" ~description:"set the port"
+      ; port t ~name:"--port" ~description:"synonym for --socket"
       ; ("--stdio", Arg.Unit (fun () -> t.stdio <- true), "set stdio")
       ; ( "--node-ipc"
         , Arg.Unit (fun () -> raise @@ Arg.Bad "node-ipc isn't supported")
@@ -42,11 +52,23 @@ module Arg = struct
 
   let clientProcessId t = t.clientProcessId
 
-  let read { pipe; port; stdio; spec = _; clientProcessId = _ } :
+  let channel { pipe; port; stdio; spec = _; clientProcessId = _ } :
       (Channel.t, string) result =
     match (pipe, port, stdio) with
     | None, None, _ -> Ok Stdio
     | Some p, None, false -> Ok (Pipe p)
     | None, Some s, false -> Ok (Socket s)
     | _, _, _ -> Error "invalid arguments"
 end
+
+let args ?channel ?clientProcessId () =
+  let args =
+    match clientProcessId with
+    | None -> []
+    | Some pid -> [ "--clientPorcessId"; string_of_int pid ]
+  in
+  match (channel : Channel.t option) with
+  | None -> args
+  | Some Stdio -> "--stdio" :: args
+  | Some (Pipe pipe) -> "--pipe" :: pipe :: args
+  | Some (Socket port) -> "--socket" :: string_of_int port :: args

lsp/src/cli.mli

@@ -1,18 +1,34 @@
+(** Handling of standard lsp server command line arguments *)
+
 module Channel : sig
+  (** The channel the server shold use to listen for connections *)
+
   type t =
     | Stdio
-    | Pipe of string
-    | Socket of int
+    | Pipe of string  (** A path to the unix domain socket or windows pipe *)
+    | Socket of int  (** A tcp connection on localhost with the port number *)
 end
 
 module Arg : sig
+  (** Parsing of the standard commnad line arguments using [Stdlib.Arg] *)
+
   type t
 
+  (** [create ()] create a new record for arguments *)
   val create : unit -> t
 
+  (** [spec t] returns the spec that should be provided to [Stdlib.Arg] to
+      populate [t] using the interpreted cli args *)
   val spec : t -> (string * Arg.spec * string) list
 
-  val read : t -> (Channel.t, string) result
+  (** [channel t] return the channel if correctly supplied. An error if the
+      arguments were provided incorrectly. *)
+  val channel : t -> (Channel.t, string) result
 
+  (** Return the process id of the client used to run the lsp server if it was
+      provided *)
   val clientProcessId : t -> int option
 end
+
+(** generate command line arguments that can be used to spawn an lsp client *)
+val args : ?channel:Channel.t -> ?clientProcessId:int -> unit -> string list

ocaml-lsp-server/bin/main.ml

@@ -16,15 +16,15 @@ let () =
     @ Cli.Arg.spec arg
   in
   let usage =
-    "ocamllsp [ --stdio | --socket SOCKET --port PORT | --pipe PIPE ] [ \
+    "ocamllsp [ --stdio | --socket PORT | --port PORT | --pipe PIPE ] [ \
      --clientProcessId pid ]"
   in
   Arg.parse
     spec
     (fun _ -> raise @@ Arg.Bad "anonymous arguments aren't allowed")
     usage;
   let channel =
-    match Cli.Arg.read arg with
+    match Cli.Arg.channel arg with
     | Ok c -> c
     | Error s ->
       Format.eprintf "%s@.%!" s;