dotenv-schema 0.1.1

A crate to validate .env files against schemas
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

# Dotenv-schema

[ci-badge]: https://github.com/dotenv-linter/dotenv-linter/workflows/CI/badge.svg
[ci-url]: https://github.com/dotenv-linter/dotenv-linter/actions
[crates-badge]: https://img.shields.io/crates/v/dotenv-schema
[crates-url]: https://crates.io/crates/dotenv-schema
[docs-badge]: https://img.shields.io/docsrs/dotenv-schema
[docs-url]: https://docs.rs/dotenv-schema
[codecov-url]: https://codecov.io/gh/mgrachev/dotenv-schema
[downloads-badge]: https://img.shields.io/crates/d/dotenv-schema
[MIT]: https://choosealicense.com/licenses/mit

[![CI][ci-badge]][ci-url]
[![Version][crates-badge]][crates-url]
[![Docs.rs][docs-badge]][docs-url]
[![Downloads][downloads-badge]][crates-url]

A crate to validate `.env` files against schemas.

## Usage

Add `dotenv-schema` to `Cargo.toml`:

```toml
[dependencies]
dotenv-schema = "0.1"
```

## To validate `.env` file against schema

```rust
use dotenv_schema::{DotEnvSchema, ValidateResult};

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let dotenv_schema = r#"{
            "version": "1.0.0",
            "entries": {
                "NAME": {
                    "type": "String"
                },
                "PORT": {
                    "type": "Integer"
                },
                "PRICE": {
                    "type": "Float"
                },
                "URL": {
                    "type": "Url"
                },
                "EMAIL":{
                    "type": "Email"
                },
                "FLAG":{
                    "type": "Boolean"
                }
            }
        }"#;
    let dotenv_schema_filename = ".dotenv_schema.json";

    std::fs::write(dotenv_schema_filename, dotenv_schema)?;

    let schema = match DotEnvSchema::load(dotenv_schema_filename) {
        Ok(schema) => Some(schema),
        Err(err) => {
            println!("Error loading schema: {err}");
            std::process::exit(1);
        }
    };

    let Some(schema) = schema else {
        return Err("Error loading .dotenv_schema.json".into());
    };

    let Some(port) = schema.entries.get("PORT") else {
        return Err("Error getting key PORT".into());
    };

    match port.is_valid("ABCD") {
        ValidateResult::Valid => {
            println!("PORT is valid");
        }
        ValidateResult::Invalid(_) => {
            println!("PORT is invalid");
        }
    }

    Ok(())
}
```

## MSRV

Minimum Supported Rust Version: 1.56.1

## License

[MIT]