toml-scaffold 0.4.0

Generate commented TOML scaffolds from Rust structs and values
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
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

# toml-scaffold

[![Crates.io](https://img.shields.io/crates/v/toml-scaffold)](https://crates.io/crates/toml-scaffold)
[![License](https://img.shields.io/github/license/DiscreteTom/toml-scaffold)](https://github.com/DiscreteTom/toml-scaffold/blob/main/LICENSE)
[![codecov](https://codecov.io/gh/DiscreteTom/toml-scaffold/branch/main/graph/badge.svg)](https://codecov.io/gh/DiscreteTom/toml-scaffold)

Generate commented TOML configuration scaffold files from Rust structs and values.

## Features

- Preserve doc comments as TOML comments
- Preserve field order in generated TOML
- Support for common types: primitives, `Option`, `HashMap`, `Vec`, nested structs and `serde_json::Value`
- Customizable formatting with `#[format]` attribute

## Installation

Add the following dependencies to your `Cargo.toml`:

```toml
[dependencies]
serde = { version = "1", features = ["derive"] }
schemars = "1"
toml-scaffold = "0.4"
```

## Usage

### Basic Example

```rust
use schemars::JsonSchema;
use serde::Serialize;
use toml_scaffold::TomlScaffold;

/// Server configuration
#[derive(Serialize, JsonSchema, TomlScaffold)]
struct Config {
    /// Server host address
    host: String,
    /// Server port
    port: u16,
}

fn main() {
    let config = Config {
        host: "localhost".to_string(),
        port: 8080,
    };
    let scaffold = config.to_scaffold().unwrap();
    println!("{}", scaffold);
}
```

Output:

```toml
# Server configuration

# Server host address
host = "localhost"
# Server port
port = 8080
```

### Custom Formatting

Use `#[format = "..."]` to control how fields are rendered:

```rust
use schemars::JsonSchema;
use serde::Serialize;
use toml_scaffold::TomlScaffold;

#[derive(Serialize, JsonSchema, TomlScaffold)]
struct Database {
    host: String,
    port: u16,
}

#[derive(Serialize, JsonSchema, TomlScaffold)]
struct Config {
    name: String,
    
    /// Inline table format
    #[format = "inline"]
    database: Database,
    
    /// Dotted keys format
    #[format = "dotted"]
    server: Database,
    
    /// Child dotted format - keep [section], flatten children
    #[format = "*dotted"]
    settings: serde_json::Value,
}
```

Output:

```toml
name = "myapp"
database = { host = "localhost", port = 5432 }
server.host = "0.0.0.0"
server.port = 8080

[settings]
key1 = 123
nested.key2 = 456
```

**Format Options:**

- `"inline"` - Inline table: `{ key = value }`
- `"dotted"` - Flatten one level: `field.key = value`
- `"dotted-nested"` - Recursively flatten: `field.key.subkey = value`
- `"*dotted"` - Keep `[field]` section, flatten children
- `"*dotted-nested"` - Keep `[field]` section, recursively flatten children
- `"multiline"` - Force multiline array format

## [More Examples](./crates/toml-scaffold/tests/)

## [CHANGELOG](./CHANGELOG.md)