@@ -5,84 +5,76 @@ All notable changes to this project will be documented in this file.
55The format is based on [ Keep a Changelog] ( https://keepachangelog.com/en/1.0.0/ ) ,
66and this project adheres to [ Semantic Versioning] ( https://semver.org/spec/v2.0.0.html ) .
77
8- ## [ 1.1 .0] - 2025-01-10
8+ ## [ 1.0 .0] - 2025-01-10
99
1010### Added
11+ - ** Initial Release** - ASON (Aliased Serialization Object Notation)
12+ - Complete Node.js implementation with SmartCompressor
13+ - Automatic pattern detection (zero configuration required)
14+ - Object references for repeated structures (` &obj0 ` , ` &obj1 ` , etc.)
15+ - Inline-first value dictionary optimized for LLM readability (` #0 ` , ` #1 ` , etc.)
16+ - Uniform array compression with ` @keys ` notation
17+ - Path flattening for nested single-property objects
18+ - Configurable indentation (0, 1, or 2 spaces)
19+ - Lossless compression with perfect round-trip fidelity
20+
1121- ** CLI Tool** - Command-line interface for JSON ↔ ASON conversion
1222 - Auto-detection of format from file extension or content
1323 - ` --stats ` flag for visual token count comparison with ASCII table
1424 - ` --delimiter ` option for comma/tab/pipe separators
1525 - Stdin/stdout support for piping workflows (e.g., ` cat data.json | npx ason ` )
1626 - Comprehensive help documentation with ` -h/--help `
1727 - Support for ` --no-references ` and ` --no-dictionary ` flags
28+
1829- ** TypeScript Support** - Full type definitions included
1930 - ` .d.ts ` files for ESM (48.2 KB)
2031 - ` .d.cts ` files for CommonJS (48.2 KB)
2132 - Full IntelliSense and autocomplete support in VSCode and other IDEs
2233 - Proper type exports for both ` import ` and ` require `
34+
2335- ** Build System** - Integrated tsup for optimized bundling
2436 - Minified ESM build (14.5 KB) - 70% smaller than source
2537 - Minified CJS build (14.5 KB) for Node.js legacy compatibility
2638 - Tree-shaking enabled for smaller bundle sizes
2739 - Dual package exports for seamless ESM/CJS interop
2840
29- ### Changed
30- - Package now ships with built/minified code instead of source files
31- - ` package.json ` configured with proper ` exports ` field for ESM/CJS resolution
32- - Updated ` files ` field to include only dist/, src/cli.js, and README.md
33- - Repository URL format corrected to use ` git+ ` prefix (eliminates npm publish warning)
41+ - ** Testing & Quality**
42+ - Complete test suite with Jest
43+ - 33 passing tests across 3 test suites
44+ - Full coverage of compression/decompression cycles
3445
35- ### Improved
36- - ** README** - Premium documentation matching Toon's quality
37- - Head-to-head comparison table: ASON vs Toon showing ASON superiority
46+ - ** Documentation & Community**
47+ - Interactive web visualizer with compress/decompress modes at ` /docs/index.html `
48+ - Complete API documentation at ` /docs/docs.html `
49+ - Interactive benchmarks at ` /docs/benchmarks.html `
50+ - Premium README with head-to-head ASON vs Toon comparison
3851 - ASCII bar charts for visual benchmark comparison
3952 - Complete API reference with TypeScript examples
4053 - CLI usage guide with real-world examples
4154 - Professional badges (npm, TypeScript, License, Node.js)
4255 - Detailed table of contents with deep anchor links
4356 - "When to use" guide comparing ASON, Toon, JSON, and CSV
44- - ** Package Distribution** - Optimized for production
45- - Tarball size: 37.8 KB (includes types, CLI, and docs)
46- - Unpacked size: 148 KB
47- - Only 7 files published (down from previous bloat)
57+ - Examples in ` /nodejs-compressor/examples/ `
58+ - Community files: CODE_OF_CONDUCT, CONTRIBUTING, SECURITY
59+ - MIT License
4860
4961### Performance
50- - Benchmarks updated showing ASON achieves ** +4.94% average token reduction**
62+ - Achieves ** 33.26% token reduction** on real-world data (28KB JSON)
63+ - Benchmarks show ASON achieves ** +4.94% average token reduction**
64+ - Beats Toon format by 8 tokens (1,808 vs 1,816)
5165- Toon shows ** -6.75% average** (worse than JSON in some cases)
5266- ASON wins on ** 3 out of 4** tested real-world datasets
53- - CLI ` --stats ` flag provides instant compression metrics
54-
55- ## [ 1.0.0] - 2025-01-10
56-
57- ### Added
58- - Initial release of ASON (Aliased Serialization Object Notation)
59- - Complete Node.js implementation with SmartCompressor
60- - Automatic pattern detection (zero configuration required)
61- - Object references for repeated structures (` &obj0 ` , ` &obj1 ` , etc.)
62- - Inline-first value dictionary optimized for LLM readability (` #0 ` , ` #1 ` , etc.)
63- - Uniform array compression with ` @keys ` notation
64- - Path flattening for nested single-property objects
65- - Configurable indentation (0, 1, or 2 spaces)
66- - Lossless compression with perfect round-trip fidelity
67- - Interactive web visualizer with compress/decompress modes
68- - Comprehensive documentation site
69- - Benchmark suite comparing against Toon and JSON
70- - Complete test suite with Jest
71- - Community files: CODE_OF_CONDUCT, CONTRIBUTING, SECURITY
72- - MIT License
73-
74- ### Performance
75- - Achieves 33.26% token reduction on real-world data (28KB JSON)
76- - Beats Toon format by 8 tokens (1,808 vs 1,816)
7767- Processes ~ 35ms for compression + decompression cycle
7868- Memory efficient: ~ 10MB for large datasets
69+ - CLI ` --stats ` flag provides instant compression metrics
7970
80- ### Documentation
81- - Web visualizer at ` /docs/index.html `
82- - Complete API documentation at ` /docs/docs.html `
83- - Interactive benchmarks at ` /docs/benchmarks.html `
84- - README with quick start guide
85- - Examples in ` /nodejs-compressor/examples/ `
71+ ### Package Distribution
72+ - Tarball size: 37.8 KB (includes types, CLI, and docs)
73+ - Unpacked size: 148 KB
74+ - Only 7 files published (optimized for production)
75+ - Package ships with built/minified code instead of source files
76+ - ` package.json ` configured with proper ` exports ` field for ESM/CJS resolution
77+ - Updated ` files ` field to include only dist/, src/cli.js, and README.md
78+ - Repository URL format corrected to use ` git+ ` prefix (eliminates npm publish warning)
8679
87- [ 1.1.0 ] : https://github.com/SeanLuis/ason/releases/tag/v1.1.0
88- [ 1.0.0 ] : https://github.com/SeanLuis/ason/releases/tag/v1.0.0
80+ [ 1.0.0 ] : https://github.com/ason-format/ason/releases/tag/v1.0.0
0 commit comments