|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to this project will be documented in this file. |
| 4 | + |
| 5 | +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), |
| 6 | +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
| 7 | + |
| 8 | +## [Unreleased] |
| 9 | + |
| 10 | +## [0.1.0] - 2025-01-07 |
| 11 | + |
| 12 | +### Added |
| 13 | +- Initial release of JsonRemedy |
| 14 | +- Binary pattern matching JSON parser with repair capabilities |
| 15 | +- Support for repairing common JSON malformations: |
| 16 | + - Missing quotes around keys and values |
| 17 | + - Single quotes instead of double quotes |
| 18 | + - Trailing commas in arrays and objects |
| 19 | + - Missing commas between elements |
| 20 | + - Incomplete objects and arrays |
| 21 | + - Boolean variants (True/False/TRUE/FALSE) |
| 22 | + - Null variants (None/NULL/Null) |
| 23 | + - Code fence removal (```json blocks) |
| 24 | + - Comment stripping (// and /* */) |
| 25 | +- Core API functions: |
| 26 | + - `JsonRemedy.repair/2` - Parse and repair JSON to Elixir terms |
| 27 | + - `JsonRemedy.repair_to_string/2` - Repair and return JSON string |
| 28 | + - `JsonRemedy.from_file/2` - Repair JSON from file |
| 29 | +- Optional repair logging with detailed action tracking |
| 30 | +- Multiple parsing strategies (binary patterns, combinators, streaming) |
| 31 | +- Comprehensive test suite with 10 doctests and 25 unit tests |
| 32 | +- Performance benchmarking suite |
| 33 | +- CLI tool with escript support |
| 34 | +- Complete documentation with examples |
| 35 | +- MIT license |
| 36 | + |
| 37 | +### Performance |
| 38 | +- 4.32M operations/sec for valid JSON parsing |
| 39 | +- 90,000+ operations/sec for malformed JSON repair |
| 40 | +- Sub-microsecond parsing for small valid JSON |
| 41 | +- Minimal memory overhead (< 8KB for repairs) |
| 42 | +- All operations pass performance thresholds |
| 43 | + |
| 44 | +[Unreleased]: https://github.com/nshkrdotcom/json_remedy/compare/v0.1.0...HEAD |
| 45 | +[0.1.0]: https://github.com/nshkrdotcom/json_remedy/releases/tag/v0.1.0 |
0 commit comments