Expand description
§gts-validator
GTS identifier validator for documentation and configuration files.
This crate provides a clean separation between the core validation engine (input-agnostic) and input strategies (starting with filesystem scanning).
§Quick Start
use std::path::PathBuf;
use gts_validator::{validate_fs, FsSourceConfig, ValidationConfig, VendorPolicy};
let mut fs_config = FsSourceConfig::default();
fs_config.paths = vec![PathBuf::from("docs"), PathBuf::from("modules")];
fs_config.exclude = vec!["target/*".to_owned()];
let mut validation_config = ValidationConfig::default();
validation_config.vendor_policy = VendorPolicy::MustMatch("x".to_owned());
let report = validate_fs(&fs_config, &validation_config).unwrap();
println!("Files scanned: {}", report.scanned_files);
println!("Validation errors: {}", report.errors_count());
println!("Scan errors: {}", report.scan_errors.len());
println!("OK: {}", report.ok);Modules§
- output
- Shared output formatting for validation reports.
Structs§
- FsSource
Config - Filesystem-specific source options.
- Scan
Error - A scan-level error: a file that could not be validated at all.
- Validation
Config - Core validation config — applies regardless of input source.
- Validation
Error - A single validation error found in a documentation/config file.
- Validation
Report - Result of a validation run.
Enums§
- Discovery
Mode - Controls how GTS identifier candidates are discovered in markdown files.
- Scan
Error Kind - The kind of scan-level failure that prevented a file from being validated.
- Vendor
Policy - Vendor matching policy for GTS ID validation.
Functions§
- validate_
fs - Validate GTS identifiers in files on disk.