archaven 1.0.0

A small Rust dependency rule checker for modular architectures.
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

//! Archaven checks dependency rules over Rust module paths.
//!
//! The crate exposes a small policy language:
//!
//! ```rust,no_run
//! use archaven::{Access, Archaven, Rule};
//!
//! let violations = Archaven::new()
//!     .rule(
//!         Rule::between("app::*")
//!             .named("bounded contexts")
//!             .deny_all()
//!             .allow(
//!                 Access::from("*::infrastructure::adapter::**")
//!                     .to("*::application::command::**"),
//!             ),
//!     )
//!     .check("./src")?;
//!
//! assert!(violations.is_empty(), "{violations}");
//! # Ok::<(), archaven::ArchavenError>(())
//! ```

mod error;
mod graph;
mod path;
mod rule;
mod scanner;
mod violation;

pub use crate::error::ArchavenError;
pub use crate::graph::{Dependency, DependencyGraph, Location, SourceDirectory};
pub use crate::path::{ModulePath, PathPattern, PrefixMatch};
pub use crate::rule::{Access, Rule, RuleSet};
pub use crate::violation::{Violation, Violations};

use std::path::Path;

/// Entry point for scanning Rust source files and checking dependency rules.
#[derive(Default)]
pub struct Archaven {
    rules: Vec<Box<dyn RuleSet>>,
}

impl Archaven {
    /// Creates an empty checker.
    #[must_use]
    pub fn new() -> Self {
        Self::default()
    }

    /// Adds a rule set to the checker.
    #[must_use]
    pub fn rule<R>(mut self, rule: R) -> Self
    where
        R: RuleSet + 'static,
    {
        self.rules.push(Box::new(rule));
        self
    }

    /// Scans a source directory and returns all dependency violations.
    ///
    /// # Errors
    ///
    /// Returns an error when the directory cannot be walked, a Rust file cannot
    /// be read or parsed, or a configured rule contains an invalid pattern.
    pub fn check(&self, root: impl AsRef<Path>) -> Result<Violations, ArchavenError> {
        let graph = scanner::scan(root.as_ref())?;
        let mut violations = Violations::new();

        for rule in &self.rules {
            violations.extend(rule.check(&graph)?);
        }

        Ok(violations)
    }
}