An open API service indexing awesome lists of open source software.

https://github.com/dinuka-kasun-medis/yaml-alignment-validator

A Rust-based web application that validates the line alignments of YAML files. It features a user-friendly web interface to upload and check YAML files for alignment issues, ensuring proper formatting and reducing syntax errors. Built for speed and reliability using Rust.
https://github.com/dinuka-kasun-medis/yaml-alignment-validator

rust validator yaml

Last synced: 10 days ago
JSON representation

A Rust-based web application that validates the line alignments of YAML files. It features a user-friendly web interface to upload and check YAML files for alignment issues, ensuring proper formatting and reducing syntax errors. Built for speed and reliability using Rust.

Awesome Lists containing this project

README

          

# YAML Alignment Validator Tool

## Overview

The **YAML Alignment Validator Tool** is a Rust-based application that provides a simple and intuitive web browser UI to validate the line alignments of YAML files. This tool ensures that your YAML files are properly aligned, reducing the risk of syntax errors and improving readability.

## Project Structure

```text
yaml_alignment_validator/
├── src/
│ ├── main.rs # Entry point of the application
│ ├── handlers.rs # Contains HTTP request handlers
│ ├── models.rs # Defines data models used in the application
│ ├── validator.rs # Core logic for YAML alignment validation
│ └── util/ # Utility functions and helpers
│ └── UI.png # Screenshot or assets for the web UI
├── templates/
│ └── index.html # HTML template for the web interface
├── config.toml # Configuration file for the application
├── Cargo.toml # Rust project configuration file
├── Cargo.lock # Dependency lock file
├── README.md # Project documentation
```

## Features

- **Web Browser UI**: User-friendly interface for validating YAML files.
![alt text](src/util/UI.png)
- **Alignment Validation**: Detects and highlights misaligned lines in YAML files.
- **Fast and Lightweight**: Built with Rust for high performance and low resource usage.

## Installation

1. Clone the repository:

```bash
git clone https://github.com/dinuka-kasun-medis/yaml-alignment-validator.git
cd yaml-alignment-validator
```

2. Build the project:

```bash
cargo build
```

3. Run the application:

```bash
cargo run
```

## Usage

1. Open your web browser and navigate to the provided local URL (e.g., `http://localhost:8080`).
2. Upload your YAML file using the interface.
3. Review the validation results and fix any alignment issues.

## Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your changes.

## Acknowledgments

- Built with Rust for performance and reliability.
- Inspired by the need for better YAML validation tools.