glcov/project

Types

Project

pub type Project {
  Project(root: String, name: String, target: String)
}

Constructors

Project(root: String, name: String, target: String)

Values

app_name

</>

pub fn app_name(
  project: Project,
  override: option.Option(String),
) -> String

build

</>

pub fn build(project: Project) -> Result(Nil, String)

Build the project for the Erlang target. This compiles src, test, dev, and dev dependencies; it deliberately does not run gleam test.

build_target

</>

pub fn build_target(
  project: Project,
  target: String,
) -> Result(Nil, String)

check_toolchain

</>

pub fn check_toolchain(project: Project) -> Result(Nil, String)

Check that the tools needed to build and analyse the project exist.

default_target_is_javascript

</>

pub fn default_target_is_javascript(project: Project) -> Bool

Is the project configured for a target other than Erlang by default? The CLI can still be invoked with gleam run --target erlang; this is only used for a helpful diagnostic.

ebin

</>

pub fn ebin(project: Project, app: String) -> String

is_absolute_path

</>

pub fn is_absolute_path(path: String) -> Bool

javascript_source_maps

</>

pub fn javascript_source_maps(
  project: Project,
) -> Result(Bool, String)

js_build_dir

</>

pub fn js_build_dir(project: Project) -> String

locate

</>

pub fn locate(
  root_override: option.Option(String),
) -> Result(Project, String)

path_dependencies

</>

pub fn path_dependencies(
  project: Project,
) -> Result(List(toml.PathDependency), String)

resolve_path

</>

pub fn resolve_path(project: Project, path: String) -> String

Resolve a project-relative path against the project root.