package vcaml

  1. Overview
  2. Docs
package vcaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
val neovim_path : string
val with_client : ?args:string list -> ?env:([> `Tmpdir of string ] -> Core_unix.env) -> ?links:(string * [ `In_path_as | `In_temp_as ] * string) list -> ?time_source:Async.Time_source.t -> ?on_error:[ `Raise | `Call of Vcaml.Vcaml_error.t -> unit ] -> ?before_connecting:([ `not_connected ] Vcaml.Client.t -> unit) -> ([ `connected ] Vcaml.Client.t -> 'a Async.Deferred.Or_error.t) -> 'a Async.Deferred.t
val print_s : ?mach:unit -> Async.Sexp.t -> unit
module Test_ui : sig ... end
val get_screen_contents : Core.Source_code_position.t -> Test_ui.t -> string Async.Deferred.Or_error.t
val wait_until_text : ?timeout:Core.Time_ns.Span.t -> Core.Source_code_position.t -> Test_ui.t -> f:(string -> bool) -> string Async.Deferred.Or_error.t
val with_ui_client : ?width:int -> ?height:int -> ?time_source:Async.Time_source.t -> ?on_error:[ `Raise | `Call of Vcaml.Vcaml_error.t -> unit ] -> ?before_connecting:([ `not_connected ] Vcaml.Client.t -> unit) -> ([ `connected ] Vcaml.Client.t -> Test_ui.t -> 'a Async.Deferred.Or_error.t) -> 'a Async.Deferred.t
val socket_client : ?time_source:Async.Time_source.t -> ?on_error:[ `Raise | `Call of Vcaml.Vcaml_error.t -> unit ] -> ?before_connecting:([ `not_connected ] Vcaml.Client.t -> unit) -> string -> [ `connected ] Vcaml.Client.t Async.Deferred.Or_error.t
module For_debugging : sig ... end

If a test is behaving in a way that is especially surprising, use this module to attach it to an Neovim instance you are running so you can observe the effect. Note that the client detaching at the end of the test may be too rapid for you to view the effects - you may want to add a delay before returning.