settings_loader 1.0.0

Opinionated configuration settings load mechanism for Rust applications
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

# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [1.0.0] - 2026-01-06

### Added
- **New Feature**: `LayerBuilder::with_path_in_dir(dir, basename)` method for automatic format discovery
  - Searches directory for configuration files with supported extensions
  - Supports yaml, yml, toml, json, ron, hjson, json5 formats
  - Provides clear error messages when files not found
- **Documentation**: Comprehensive README refinement for 1.0.0 release
  - Added file extension precedence documentation (YAML > TOML > JSON > JSON5 > HJSON > RON)
  - Listed all 7 available `LayerBuilder` source types with descriptions
  - Added File Discovery section explaining basename search pattern
  - Clarified that extension precedence applies independently per layer
  - Clarified TOML-only comment preservation in editor feature
- **Documentation**: Created `ref/FUTURE_ENHANCEMENTS.md` with 10 potential enhancements
- **Tests**: Added 7 comprehensive tests for `with_path_in_dir` feature
  - Format discovery (YAML, TOML, JSON)
  - Format precedence when multiple files exist
  - Error handling when no files found
  - Relative path support
  - Layer composition

### Changed
- **Breaking**: Converted `LayerResult` from tuple to `LayerResolution` struct for better code clarity
  - Struct has named fields: `metadata`, `config_source`, `provenance_source`
  - Improves code readability and maintainability
- **Documentation**: Renamed "Spark-Turtle" pattern to generic "Desktop/CLI Application" pattern
- **Documentation**: Generalized example environment variable prefixes (TURTLE → APP)
- **Documentation**: Updated all examples to demonstrate new `with_path_in_dir` feature

### Fixed
- Improved error messages for missing configuration files

## [0.15.0] - Previous Release

### Added
- Multi-scope configuration support
- Configuration editing with format preservation
- Metadata and introspection capabilities
- Validation framework
- Provenance tracking

---

## Migration Guide (0.15.0 → 1.0.0)

### LayerResult Type Change

If you were using the internal `LayerResult` type (unlikely for most users), it has changed from a tuple to a struct:

**Before (0.15.0)**:
```rust
let (metadata, config_source, provenance_source) = resolve_layer(...)?;
```

**After (1.0.0)**:
```rust
let resolution = resolve_layer(...)?;
let metadata = resolution.metadata;
let config_source = resolution.config_source;
let provenance_source = resolution.provenance_source;
```

### New Feature: with_path_in_dir

You can now discover configuration files by directory and basename:

```rust
let builder = LayerBuilder::new()
    .with_path_in_dir("config", "application");  // Finds config/application.{yaml,toml,json,...}
```

This is more convenient than specifying the full path with extension.

---

[Unreleased]: https://github.com/dmrolfs/settings-loader-rs/compare/v1.0.0-rc.1...HEAD
[1.0.0-rc.1]: https://github.com/dmrolfs/settings-loader-rs/compare/v0.15.0...v1.0.0-rc.1
[0.15.0]: https://github.com/dmrolfs/settings-loader-rs/releases/tag/v0.15.0