crabenv 0.0.2

The simplest, opinionated way to keep .env files, schemas, and examples aligned.
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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140

use anyhow::{Context, Result};
use std::collections::{BTreeMap, BTreeSet};
use std::path::PathBuf;

use crate::adapters;
use crate::discovery::app_workspaces;
use crate::models::{EnvRecord, EnvSurface, Project, Scope, SourceKind, VarSource};
use crate::sinks::collect_sink_surface_sources;
use crate::util::display_path;

pub type EnvGraph = BTreeMap<(PathBuf, String), EnvRecord>;

pub fn build_graph(project: &Project) -> Result<EnvGraph> {
    let sources = collect_sources(project)?;
    let mut graph = EnvGraph::new();
    let root_local_names = sources
        .iter()
        .filter(|source| {
            project.is_monorepo
                && matches!(source.kind, SourceKind::EnvLocal)
                && source.owner == PathBuf::from(".")
        })
        .map(|source| source.name.clone())
        .collect::<BTreeSet<_>>();

    for source in sources {
        let key = (source.owner.clone(), source.name.clone());
        let record = graph.entry(key).or_insert_with(|| EnvRecord {
            name: source.name.clone(),
            owner: source.owner.clone(),
            scope: Scope::Unknown,
            value_type: None,
            enum_values: None,
            required: None,
            default_value: None,
            description: None,
            example_value: None,
            local_present: false,
            surfaces: BTreeSet::new(),
            surface_sources: BTreeMap::new(),
            sources: BTreeSet::new(),
        });

        if source.scope != Scope::Unknown {
            record.scope = source.scope.clone();
        }
        if source.value_type.is_some() {
            record.value_type = source.value_type.clone();
        }
        if source.enum_values.is_some() {
            record.enum_values = source.enum_values.clone();
        }
        if source.required.is_some() {
            record.required = source.required;
        }
        if source.default_value.is_some() {
            record.default_value = source.default_value.clone();
        }
        if source.description.is_some() {
            record.description = source.description.clone();
        }
        if matches!(source.kind, SourceKind::EnvExample) {
            record.example_value = source.value.clone();
        }
        if matches!(source.kind, SourceKind::EnvLocal) {
            record.local_present = true;
        }
        let surface = source.kind.surface();
        let source_location = format!("{}:{}", display_path(&source.path), source.line);
        record.surfaces.insert(surface);
        record
            .surface_sources
            .entry(surface)
            .or_default()
            .insert(source_location.clone());
        record.sources.insert(source_location);
    }

    if project.is_monorepo {
        let local = project.root.join(".env");
        if !root_local_names.is_empty() {
            for record in graph.values_mut() {
                if root_local_names.contains(&record.name) {
                    record.local_present = true;
                    let surface = SourceKind::EnvLocal.surface();
                    let source_location = format!("{}:local", display_path(&local));
                    record.surfaces.insert(surface);
                    record
                        .surface_sources
                        .entry(surface)
                        .or_default()
                        .insert(source_location.clone());
                    record.sources.insert(source_location);
                }
            }
        }
    }

    for sink_source in collect_sink_surface_sources(project, &graph)? {
        let key = (sink_source.owner.clone(), sink_source.name.clone());
        if let Some(record) = graph.get_mut(&key) {
            record.surfaces.insert(EnvSurface::Sinks);
            record
                .surface_sources
                .entry(EnvSurface::Sinks)
                .or_default()
                .insert(sink_source.location.clone());
            record.sources.insert(sink_source.location);
        }
    }

    Ok(graph)
}

pub fn collect_sources(project: &Project) -> Result<Vec<VarSource>> {
    let mut sources = Vec::new();
    let workspace_adapters = adapters::workspace_adapters();
    let project_adapters = adapters::project_adapters();

    for workspace in app_workspaces(project) {
        for adapter in &workspace_adapters {
            sources.extend(adapter.collect(project, workspace).with_context(|| {
                format!(
                    "{} adapter failed for {}",
                    adapter.name(),
                    crate::util::display_rel(&workspace.rel)
                )
            })?);
        }
    }

    for adapter in &project_adapters {
        sources.extend(
            adapter
                .collect(project)
                .with_context(|| format!("{} adapter failed", adapter.name()))?,
        );
    }
    Ok(sources)
}