cargo-stern4rust 0.7.0

Cargo subcommand that fails the build when a Rust workspace breaks a house coding rule, such as AAA test structure or one struct per file
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

// Copyright 2025 Umberto Gotti <umberto.gotti@umbertogotti.dev>
// Licensed under the MIT License
// SPDX-License-Identifier: MIT

// The four groups and the order they appear in. The ordering is derived rather
// than written out, so what is worth pinning is that the derivation says what
// the rule needs it to say: imports first, tests last.

use stern4rust::finding::section::Section;

#[test]
fn blank_lines_between_entries_of_every_other_section_is_one() {
    // Arrange & Act & Assert
    assert_eq!(Section::Constants.blank_lines_between_entries(), 1);
    assert_eq!(Section::Helpers.blank_lines_between_entries(), 1);
    assert_eq!(Section::Tests.blank_lines_between_entries(), 1);
}

// Imports are the one group written without gaps.
#[test]
fn blank_lines_between_entries_of_imports_is_none() {
    // Arrange & Act
    let expected = Section::Imports.blank_lines_between_entries();

    // Assert
    assert_eq!(expected, 0);
}

// The label reads as the thing itself, so an offence says "a constant follows a
// helper" rather than naming an enum variant at the reader.
#[test]
fn label_reads_as_the_thing_itself() {
    // Arrange & Act & Assert
    assert_eq!(Section::Imports.label(), "import");
    assert_eq!(Section::Constants.label(), "constant");
    assert_eq!(Section::Helpers.label(), "helper");
    assert_eq!(Section::Tests.label(), "test");
}

#[test]
fn ordering_places_constants_before_helpers() {
    // Arrange & Act
    let constants = Section::Constants;

    // Assert
    assert!(constants < Section::Helpers);
}

#[test]
fn ordering_places_imports_before_every_other_section() {
    // Arrange & Act
    let imports = Section::Imports;

    // Assert
    assert!(imports < Section::Constants);
    assert!(imports < Section::Helpers);
    assert!(imports < Section::Tests);
}

#[test]
fn ordering_places_tests_after_every_other_section() {
    // Arrange & Act
    let tests = Section::Tests;

    // Assert
    assert!(tests > Section::Imports);
    assert!(tests > Section::Constants);
    assert!(tests > Section::Helpers);
}