harn-lint 0.8.78

Linter for the Harn programming language
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

//! `missing-stdlib-metadata` (HARN-STD-101) coverage.

use super::*;

#[test]
fn defers_to_missing_harndoc_when_no_block() {
    // No `/** */` block at all → the existing `missing-harndoc` lint
    // (HARN-LNT-024) covers it; HARN-STD-101 stays silent to avoid
    // double-reporting.
    let source = "pub fn foo() {\n  return 1\n}\n";
    let diags = lint_with_stdlib_metadata(source);
    assert!(
        has_rule(&diags, "missing-harndoc"),
        "expected missing-harndoc to fire, got: {diags:?}"
    );
    assert!(
        !has_rule(&diags, "missing-stdlib-metadata"),
        "HARN-STD-101 should defer to missing-harndoc when no block exists: {diags:?}"
    );
}

#[test]
fn warns_when_empty_block_present() {
    let source = "\
/**
 * Just prose.
 */
pub fn foo() {
  return 1
}
";
    let diags = lint_with_stdlib_metadata(source);
    let missing = diags
        .iter()
        .find(|d| d.rule == "missing-stdlib-metadata")
        .expect("should warn");
    assert!(
        missing.message.contains("metadata block"),
        "expected full-block message, got: {}",
        missing.message
    );
}

#[test]
fn warns_when_block_omits_a_field() {
    let source = "\
/**
 * Document.
 *
 * @effects: [fs.read]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 */
pub fn foo() {
  return 1
}
";
    let diags = lint_with_stdlib_metadata(source);
    let missing = diags
        .iter()
        .find(|d| d.rule == "missing-stdlib-metadata")
        .expect("should warn");
    assert!(
        missing.message.contains("example"),
        "expected `example` listed as missing, got: {}",
        missing.message
    );
}

#[test]
fn accepts_complete_block() {
    let source = "\
/**
 * Document.
 *
 * @effects: [fs.read]
 * @allocation: heap
 * @errors: []
 * @api_stability: stable
 * @example: foo()
 */
pub fn foo() {
  return 1
}
";
    let diags = lint_with_stdlib_metadata(source);
    assert!(
        !has_rule(&diags, "missing-stdlib-metadata"),
        "complete metadata should not trip HARN-STD-101: {diags:?}"
    );
}

#[test]
fn does_not_fire_for_private_helpers() {
    let source = "\
fn helper() {
  return 1
}
";
    let diags = lint_with_stdlib_metadata(source);
    assert!(
        !has_rule(&diags, "missing-stdlib-metadata"),
        "private helpers are exempt: {diags:?}"
    );
}

#[test]
fn dormant_outside_stdlib_path() {
    // Without `require_stdlib_metadata: true` (i.e. the default lint
    // invocation user scripts hit), HARN-STD-101 is dormant.
    let source = "pub fn foo() {\n  return 1\n}\n";
    let diags = lint_source(source);
    assert!(
        !has_rule(&diags, "missing-stdlib-metadata"),
        "default lint must not enforce stdlib metadata: {diags:?}"
    );
}