okf 0.2.5

The Open Knowledge Format (OKF) v0.2 in pure Rust: the `okf` CLI (validate, lint, inspect, index, graph, format, diff) plus the full okf-core and okf-validator library APIs re-exported.
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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

//! Integration tests for `--fix` on validate and lint, and clippy-style fixable diagnostics.

mod common;

use common::TempDir;
use std::process::Command;

fn okf() -> Command {
    Command::new(env!("CARGO_BIN_EXE_okf"))
}

#[test]
fn cli_validate_and_lint_show_fixable_count() {
    let tmp = TempDir::new();
    tmp.write("index.md", "---\nokf_version: \"0.2\"\n---\n\n# Test\n");
    // Missing title, missing generated, no top heading -> fixable
    tmp.write(
        "metrics/revenue.md",
        "---\ntype: Metric\n---\nRevenue is money.\n",
    );

    let output = okf()
        .args(["lint", tmp.path().to_str().unwrap()])
        .output()
        .unwrap();
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("fixable with `--fix`"), "Output: {stdout}");

    let val_output = okf()
        .args(["validate", tmp.path().to_str().unwrap()])
        .output()
        .unwrap();
    let val_stdout = String::from_utf8(val_output.stdout).unwrap();
    assert!(
        val_stdout.contains("fixable with `--fix`"),
        "Output: {val_stdout}"
    );
}

#[test]
fn validate_fix_only_fixes_validation_issues_not_lint() {
    let tmp = TempDir::new();
    tmp.write("index.md", "---\nokf_version: \"0.2\"\n---\n\n# Test\n");
    // Missing title & generated (validation) + no top `#` heading (lint L8)
    let original_body = "Revenue is money.\n";
    tmp.write(
        "metrics/revenue.md",
        &format!("---\ntype: Metric\n---\n{original_body}"),
    );

    // Run validate --fix
    let output = okf()
        .args(["validate", tmp.path().to_str().unwrap(), "--fix"])
        .output()
        .unwrap();
    assert!(output.status.success());

    let content = tmp.read("metrics/revenue.md");
    // Validation issues were fixed
    assert!(content.contains("title: Revenue"));
    assert!(content.contains("generated:"));
    // Lint-only issue (no top `#` heading) was NOT fixed by validate --fix
    assert!(content.contains(original_body));
    assert!(!content.contains("# Revenue\n\nRevenue is money."));

    // Now run lint --fix
    let lint_output = okf()
        .args(["lint", tmp.path().to_str().unwrap(), "--fix"])
        .output()
        .unwrap();
    let lint_stdout = String::from_utf8(lint_output.stdout).unwrap();
    assert!(lint_stdout.contains("Applied"));

    let content_after_lint = tmp.read("metrics/revenue.md");
    // Lint issue (no top `#` heading) IS now fixed by lint --fix
    assert!(content_after_lint.contains("# Revenue\n\nRevenue is money."));
}

#[test]
fn cli_lint_with_fix_flag_remediates_and_rechecks() {
    let tmp = TempDir::new();
    tmp.write(
        "overview.md",
        "---\ntype: Concept\ntitle: Overview\ndescription: Overview of the bundle.\ngenerated:\n  by: human:alice\n  at: 2026-01-01T00:00:00Z\n---\n\n# Overview\n\nSee [revenue](metrics/revenue.md).\n",
    );
    tmp.write(
        "metrics/revenue.md",
        "---\ntype: Metric\ntitle: Revenue\ndescription: Revenue tracking.\ntimestamp: 2026-01-01T00:00:00Z\n---\n\nRevenue is money.\n",
    );
    // Index will be regenerated by fix
    tmp.write(
        "index.md",
        "---\nokf_version: \"0.2\"\n---\n\n# Concepts\n\n* [Overview](overview.md)\n* [Revenue](metrics/revenue.md)\n",
    );

    let output = okf()
        .args(["lint", tmp.path().to_str().unwrap(), "--fix"])
        .output()
        .unwrap();
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("Applied"), "Output: {stdout}");

    // The file should now have generated block and top heading
    let content = tmp.read("metrics/revenue.md");
    assert!(!content.contains("timestamp:"));
    assert!(content.contains("generated:"));
    assert!(content.contains("# Revenue"));
}

#[test]
fn cli_validate_with_fix_flag_remediates_and_validates() {
    let tmp = TempDir::new();
    tmp.write("index.md", "---\nokf_version: \"0.2\"\n---\n\n# Test\n");
    tmp.write(
        "metrics/revenue.md",
        "---\ntype: Metric\ntimestamp: 2026-01-01T00:00:00Z\n---\n\n# Revenue\n\nRevenue is money.\n",
    );

    let output = okf()
        .args(["validate", tmp.path().to_str().unwrap(), "--fix"])
        .output()
        .unwrap();
    assert!(output.status.success());
    let stdout = String::from_utf8(output.stdout).unwrap();
    assert!(stdout.contains("Applied"), "Output: {stdout}");
    assert!(
        stdout.contains("conformant with OKF v0.2"),
        "Output: {stdout}"
    );
}