harn-stdlib 0.10.46

Embedded Harn standard library source catalog
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

/** Common fields guaranteed by normalized command results. */
pub type CommandResult = {
  success: bool,
  ok: bool,
  status: string,
  exit_code: int?,
  cwd: string,
  stdout: string,
  stderr: string,
  ...rest,
}

/**
 * Build a normalized successful command-result dict for tests and harness adapters.
 *
 * @effects: []
 * @errors: []
 */
pub fn command_result_ok(stdout: string = "", extra = nil) -> CommandResult {
  const base = extra ?? {}
  return base
    + {
    success: true,
    ok: true,
    status: "completed",
    exit_code: 0,
    cwd: base?.cwd ?? "",
    stdout: stdout,
    stderr: "",
  }
}

/**
 * Build a normalized failed command-result dict for tests and harness adapters.
 *
 * @effects: []
 * @errors: []
 */
pub fn command_result_fail(exit_code: int = 1, stderr: string = "", extra = nil) -> CommandResult {
  const base = extra ?? {}
  return base
    + {
    success: false,
    ok: false,
    status: "failed",
    exit_code: exit_code,
    cwd: base?.cwd ?? "",
    stdout: base?.stdout ?? "",
    stderr: stderr,
  }
}