sofie-check 0.3.0

Structure checks (comment density, god types) and the `sofie check` rules over the app model.
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

use sofie_model::{App, AreaClient};

use super::manifest::{declaration_line, manifest_text};
use super::{Finding, Rule};

const FRAMEWORK_PACKAGE: &str = "sofie-framework";
const CLIENTS_FEATURE: &str = "clients";

/// The wiring hands each client area its bundle through sofie's `clients` feature, so without
/// it the app fails to compile on a name the error does not explain.
#[must_use]
pub fn check_client_feature(app: &App, framework_features: &[String]) -> Vec<Finding> {
    if framework_features
        .iter()
        .any(|feature| feature == CLIENTS_FEATURE)
    {
        return Vec::new();
    }
    let areas = app.areas();
    let Some(area) = areas.iter().find(|area| {
        area.definition
            .is_some_and(|definition| definition.client != AreaClient::Html)
    }) else {
        return Vec::new();
    };
    let (manifest, text) = manifest_text(&app.app);
    let line = app
        .app
        .dependencies
        .iter()
        .find(|dependency| dependency.package == FRAMEWORK_PACKAGE)
        .map_or(1, |dependency| {
            declaration_line(&text, &dependency.crate_name)
        });
    vec![Finding {
        rule: Rule::ClientFeature,
        file: manifest,
        line,
        message: format!(
            "area `{}` names a client, but the app does not enable sofie's `{CLIENTS_FEATURE}` \
             feature, which serves client areas",
            area.name
        ),
        fix: format!(
            "add \"{CLIENTS_FEATURE}\" to the `features` of the app's `sofie` dependency in \
             app/Cargo.toml"
        ),
    }]
}