rulewright 0.1.1

Executable engineering standards for Rust workspaces
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

use ra_ap_syntax::{
    AstNode,
    ast::{self, HasName},
    syntax_editor::SyntaxEditor,
};

use super::support::item_lists;
use crate::{AstCtx, Example, Violation};

#[rustfmt::skip]
const EXAMPLES: &[Example] = &[
    Example {
        label: "sorted declarations",
        code: "mod alpha;\npub mod beta;\nmod gamma;",
        pass: true,
    },
    Example {
        label: "visibility does not affect ordering",
        code: "pub mod zebra;\nmod alpha;",
        pass: false,
    },
    Example {
        label: "separate declaration blocks",
        code: "mod zebra;\nfn boundary() {}\nmod alpha;",
        pass: true,
    },
    Example {
        label: "inline modules are boundaries",
        code: "mod zebra {}\nmod alpha;",
        pass: true,
    },
    Example {
        label: "raw identifiers sort by their semantic name",
        code: "mod parser;\nmod r#trait;\nmod writer;",
        pass: true,
    },
];

crate::ast_tree_rule!(
    mod_order,
    "Require contiguous module-declaration blocks to be alphabetically sorted.",
    "Stable module ordering makes module inventories predictable without grouping by visibility.",
    Low,
    fix_mod_order,
);

fn check_mod_order(ctx: &AstCtx<'_>) -> Vec<Violation> {
    item_lists(ctx.root)
        .flat_map(module_blocks)
        .filter_map(|block| {
            let names: Vec<String> = block.iter().filter_map(module_sort_key).collect();

            (!names.is_sorted()).then(|| {
                ctx.violation(
                    &block[0],
                    "module declarations are not alphabetically sorted",
                )
            })
        })
        .collect()
}

fn module_blocks(items: Vec<ast::Item>) -> impl Iterator<Item = Vec<ast::Module>> {
    let mut blocks = Vec::new();
    let mut current = Vec::new();

    for item in items {
        if let ast::Item::Module(module) = item
            && module.item_list().is_none()
        {
            current.push(module);
        } else if !current.is_empty() {
            blocks.push(std::mem::take(&mut current));
        }
    }

    if !current.is_empty() {
        blocks.push(current);
    }

    blocks.into_iter().filter(|block| block.len() > 1)
}

// #rw(fn: rust_clone_in_loop) syntax-editor sorting requires detached copies of source items
fn fix_mod_order(ctx: &AstCtx<'_>, _violations: &[Violation]) -> Option<String> {
    let (editor, root) = SyntaxEditor::with_ast_node(ctx.root);
    let mut changed = false;

    for block in item_lists(&root).flat_map(module_blocks) {
        let mut target = block.clone();

        target.sort_by_key(module_sort_key);

        if block == target {
            continue;
        }

        for (old, new) in block.iter().zip(&target) {
            editor.replace(old.syntax().clone(), new.syntax().clone_subtree());
        }

        changed = true;
    }

    changed.then(|| editor.finish().new_root().to_string())
}

fn module_sort_key(module: &ast::Module) -> Option<String> {
    module
        .name()
        .map(|name| name.text().trim_start_matches("r#").to_owned())
}

crate::rulewright_ast_test!(check_mod_order, {
    crate::example_tests!(EXAMPLES, check_mod_order);
    crate::fix_tests!(ast_tree, check_mod_order, fix_mod_order);
});