Vexy JSON Documentation¶

A forgiving JSON parser that handles real-world JSON with comments, trailing commas, unquoted keys, and more.

🚀 Quick Start¶

Try It Now¶

Interactive Demo - Test Vexy JSON in your browser with WASM
Legacy Tool - Previous version of the web tool

Installation¶

# Rust
cargo add vexy-json

# Python
pip install vexy-json

# CLI
cargo install vexy-json

Quick Start (Rust)¶

use vexy_json::parse;

fn main() {
    let data = r#"{ key: 1, /* comment */ arr: [1,2,3,], hex: 0x10 }"#;
    let value = parse(data).unwrap();
    println!("{:?}", value);
}

📚 Documentation¶

For Users¶

📖 User Documentation - Complete user guide including: - Installation and getting started - API documentation for all languages - How-to guides and examples - Troubleshooting and reference

For Developers¶

🔧 Developer Documentation - For contributors and extension developers: - Contributing guidelines and setup - Architecture and internals - Plugin development - Build, test, and release processes

✨ Key Features¶

💬 Comments Support¶

{
    // Single-line comments
    "name": "example",
    /* Multi-line
       comments */ 
    "value": 42
}

🏷️ Unquoted Keys¶

{
    name: "No quotes needed",
    version: 1.0,
    active: true
}

➕ Trailing Commas¶

{
    "items": [
        "first",
        "second",  // <- This comma is OK
    ],
    "done": true,  // <- And this one too
}

🔧 Error Recovery¶

{
    "broken": "json,
    "gets": "fixed automatically"
}

🎯 Use Cases¶

Configuration Files - More readable config with comments
API Development - Forgiving parsing for client-side JSON
Data Migration - Repair malformed JSON data
Developer Tools - Build JSON editors and validators
Log Processing - Handle JSON logs with comments

🌟 Performance¶

Vexy JSON is designed for both correctness and speed:

⚡ Fast parsing - Competitive with standard JSON parsers
🧠 Smart recovery - Fixes common JSON errors automatically
🌐 Multi-platform - Rust, Python, WebAssembly, and C/C++ bindings
🔒 Memory safe - Built in Rust with comprehensive error handling

🔗 Links¶

GitHub Repository - Source code and issues
Crates.io - Rust package
PyPI - Python package
NPM - WebAssembly package

📄 License¶

Licensed under either of: - Apache License, Version 2.0 - MIT License

at your option.