Module B0_show_url

Action and unit execution to show URLs after builds.

This module provides the .show-url action which allows to reload URLs in your browser when you build static websites or web servers.

URLs

type url = [
  1. | `Url of B0_std.Net.Url.t
    (*

    The URL.

    *)
  2. | `In of B0_env.dir * B0_std.Fpath.t
    (*

    The path in given directory.

    *)
  3. | `Fun of string * (B0_env.t -> B0_unit.t -> (B0_std.Net.Url.t, string) Stdlib.result)
]

The type for dermining the URL to show.

val url : url B0_meta.key

url defines the default URL to show when .show-url is used on a unit without specifying a path.

val get_url : B0_env.t -> B0_unit.t -> (B0_std.Net.Url.t, string) Stdlib.result

get_url env u performs the logic to get the url for unit u in environment env.

Server keys

val listen_args : (authority:string -> B0_std.Cmd.t) B0_meta.key

listen_args defines the arguments to specify for how to make the server listen on authority for connections. These arguments are added at the end of the server tool invocation or before a -- token if there is one.

val timeout_s : int B0_meta.key

timeout_s defines the maximal number of seconds to wait for the server to be connectable before reloading the URL. Defaults to 1s.

Unit action

val action : B0_unit.Action.t

action is a unit action that invokes the show-url tool on the unit's url. If no command line arguments are specified on invocation --prefix is added.

.show-url unit

val unit : B0_unit.t

unit is the .show-url unit.

See b0 -- .show-url --help for more information.