bylaw 0.1.0

Architecture enforcement test framework for Rust
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

# Cargo Bylaw

Cargo Bylaw is an architecture enforcement framework for Rust. It provides a
Rust test API and a `cargo bylaw` command backed by the same semantic dependency
graph and rule engine.

Rules can constrain dependencies between modules, workspace crates, and external
crates, define allowed layer directions, and reject dependency cycles.

```toml
version = 1

[selectors.domain]
modules = ["shop::domain::**"]

[selectors.persistence]
modules = ["shop::persistence::**"]

[[rule]]
id = "domain-is-internal"
kind = "forbid-dependencies"
from = "domain"
to = "persistence"
scope = "actual"
```

```console
cargo bylaw check
```

The same rule model is available from normal Rust tests:

```rust
use bylaw::prelude::*;

#[test]
fn architecture_is_valid() -> Result<(), Box<dyn std::error::Error>> {
    let graph = bylaw::analyzer::analyze_workspace(&Default::default())?;
    rules()
        .forbid_dependencies(
            "domain-is-internal",
            modules(["shop::domain::**"]),
            modules(["shop::persistence::**"]),
        )
        .actual_dependencies()
        .check(&graph)?
        .assert();
    Ok(())
}
```

See [`examples/model-boundaries`](examples/model-boundaries) for a complete
domain, persistence, contract, API, and composition-root example.

## Documentation site

The guide is an mdBook deployed through GitHub Pages. Build it locally with:

```console
cargo install mdbook --version 0.5.4 --locked
mdbook serve --open
```

## Documentation

- [Architecture](docs/architecture.md)
- [Configuration](docs/configuration.md)
- [Custom rules](docs/extensions.md)
- [Semantic analysis](docs/analysis.md)
- [Upgrading rust-analyzer](docs/upgrading-rust-analyzer.md)
- [Releasing](docs/releasing.md)

## License

Licensed under either of:

- [Apache License, Version 2.0](https://github.com/danielgerlag/cargo-bylaw/blob/main/LICENSE-APACHE)
- [MIT License](https://github.com/danielgerlag/cargo-bylaw/blob/main/LICENSE-MIT)

at your option.