gleedoc - v0.4.0

gleedoc

Types

GleedocConfig

</>

Configuration for a gleedoc run.

pub type GleedocConfig {
  GleedocConfig(output_dir: String, source_dir: String)
}

Constructors 

  • GleedocConfig(output_dir: String, source_dir: String)

    Arguments

    output_dir

    Directory to write generated tests to, typically “test”

    source_dir

    Directory to read source files from, typically “src”

Values

main

</> 
pub fn main() -> Nil

CLI entry point. Reads gleam.toml to infer module/package names.

run

</> 
pub fn run(config: GleedocConfig) -> Result(Nil, snag.Snag)

Run gleedoc on a project, extracting doc tests from source files and generating test files in the output directory.

✨ Search Document