Skip to content

Commit 18ec6b8

Browse files
committed
Rename package to @ason-format/ason and update links
1 parent 854bce8 commit 18ec6b8

File tree

12 files changed

+101
-109
lines changed

12 files changed

+101
-109
lines changed

CHANGELOG.md

Lines changed: 38 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -5,84 +5,76 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and 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

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Enhancement suggestions are tracked as GitHub issues. When creating an enhanceme
4545

4646
```bash
4747
# Clone the repository
48-
git clone https://github.com/SeanLuis/ason.git
48+
git clone https://github.com/ason-format/ason.git
4949
cd ason
5050

5151
# Install dependencies for Node.js version
@@ -229,7 +229,7 @@ Add test cases for:
229229
## Questions?
230230

231231
* Check the [documentation](./docs/docs.html)
232-
* Review [existing issues](https://github.com/SeanLuis/ason/issues)
232+
* Review [existing issues](https://github.com/ason-format/ason/issues)
233233
* Open a new issue for discussion
234234

235235
## Recognition

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
# ASON - Aliased Serialization Object Notation
22

3-
[![npm version](https://badge.fury.io/js/%40seanluis47%2Fason.svg)](https://www.npmjs.com/package/@seanluis47/ason)
3+
[![npm version](https://badge.fury.io/js/%40ason-format%2Fason.svg)](https://www.npmjs.com/package/@ason-format/ason)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55
[![Node.js](https://img.shields.io/badge/Node.js-v16+-green.svg)](https://nodejs.org/)
66
[![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
77

88
> **Token-optimized JSON compression for Large Language Models.** Outperforms Toon with **33.26% average reduction** vs Toon's 32.96%.
99
10-
![ASON Overview](https://raw.githubusercontent.com/SeanLuis/ason/main/preview.png)
10+
![ASON Overview](https://raw.githubusercontent.com/ason-format/ason/main/preview.png)
1111

1212
## 🚀 Quick Start
1313

1414
### Installation
1515

1616
```bash
17-
npm install @seanluis47/ason
17+
npm install @ason-format/ason
1818
```
1919

2020
### Basic Usage
2121

2222
```javascript
23-
import { SmartCompressor } from '@seanluis47/ason';
23+
import { SmartCompressor } from '@ason-format/ason';
2424

2525
const compressor = new SmartCompressor({ indent: 0 });
2626

@@ -151,7 +151,7 @@ Tested on 5 real-world datasets:
151151
### 1. Reduce LLM API Costs
152152

153153
```javascript
154-
import { SmartCompressor } from '@seanluis47/ason';
154+
import { SmartCompressor } from '@ason-format/ason';
155155
import OpenAI from 'openai';
156156

157157
const compressor = new SmartCompressor({ indent: 0 });
@@ -199,7 +199,7 @@ app.get('/api/data/compact', (req, res) => {
199199

200200
```bash
201201
# Clone repository
202-
git clone https://github.com/SeanLuis/ason.git
202+
git clone https://github.com/ason-format/ason.git
203203
cd ason
204204

205205
# Install dependencies

RELEASE.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ Edit `nodejs-compressor/package.json`:
4040
Add a new section at the top:
4141

4242
```markdown
43-
## [1.1.0] - 2025-01-15
43+
## [1.0.0] - 2025-01-15
4444

4545
### Added
4646
- New feature X
@@ -57,39 +57,39 @@ Add a new section at the top:
5757

5858
```bash
5959
git add nodejs-compressor/package.json CHANGELOG.md
60-
git commit -m "Release v1.1.0"
60+
git commit -m "Release v1.0.0"
6161
git push origin main
6262
```
6363

6464
### 4. Create Git Tag
6565

6666
```bash
6767
# Create annotated tag
68-
git tag -a v1.1.0 -m "Release v1.1.0
68+
git tag -a v1.0.0 -m "Release v1.0.0
6969
7070
- New feature X
7171
- New feature Y
7272
- Bug fix Z"
7373

7474
# Push tag to GitHub
75-
git push origin v1.1.0
75+
git push origin v1.0.0
7676
```
7777

7878
### 5. Create GitHub Release
7979

8080
**Option A: Using GitHub UI**
8181

82-
1. Go to: https://github.com/SeanLuis/ason/releases/new
83-
2. Choose tag: `v1.1.0`
84-
3. Release title: `v1.1.0`
82+
1. Go to: https://github.com/ason-format/ason/releases/new
83+
2. Choose tag: `v1.0.0`
84+
3. Release title: `v1.0.0`
8585
4. Description: Copy from CHANGELOG.md
8686
5. Click "Publish release"
8787

8888
**Option B: Using GitHub CLI**
8989

9090
```bash
91-
gh release create v1.1.0 \
92-
--title "v1.1.0" \
91+
gh release create v1.0.0 \
92+
--title "v1.0.0" \
9393
--notes-file - <<EOF
9494
## What's New
9595
@@ -100,12 +100,12 @@ gh release create v1.1.0 \
100100
## Installation
101101
102102
\`\`\`bash
103-
npm install ason
103+
npm install @ason-format/ason
104104
\`\`\`
105105
106106
## Full Changelog
107107
108-
See [CHANGELOG.md](https://github.com/SeanLuis/ason/blob/main/CHANGELOG.md)
108+
See [CHANGELOG.md](https://github.com/ason-format/ason/blob/main/CHANGELOG.md)
109109
EOF
110110
```
111111

@@ -116,16 +116,16 @@ Once you create the GitHub release:
116116
1. GitHub Actions will automatically trigger
117117
2. Tests will run on Node 16.x, 18.x, 20.x
118118
3. If tests pass, package publishes to NPM
119-
4. Check workflow: https://github.com/SeanLuis/ason/actions
119+
4. Check workflow: https://github.com/ason-format/ason/actions
120120

121121
### 7. Verify Publication
122122

123123
```bash
124124
# Check NPM
125-
npm view ason
125+
npm view @ason-format/ason
126126

127127
# Install and test
128-
npm install ason@latest
128+
npm install @ason-format/ason@latest
129129
```
130130

131131
## Quick Release Checklist
@@ -137,33 +137,33 @@ npm install ason@latest
137137
- [ ] Create GitHub release
138138
- [ ] Verify GitHub Actions workflow passes
139139
- [ ] Verify package published to NPM
140-
- [ ] Test installation: `npm install ason@latest`
140+
- [ ] Test installation: `npm install @ason-format/ason@latest`
141141

142142
## Release Example
143143

144144
```bash
145145
# 1. Update files (package.json, CHANGELOG.md)
146146
# 2. Commit
147147
git add -A
148-
git commit -m "Release v1.1.0"
148+
git commit -m "Release v1.0.0"
149149
git push origin main
150150

151151
# 3. Tag
152-
git tag -a v1.1.0 -m "Release v1.1.0"
153-
git push origin v1.1.0
152+
git tag -a v1.0.0 -m "Release v1.0.0"
153+
git push origin v1.0.0
154154

155155
# 4. Create release on GitHub
156156
# → GitHub Actions automatically publishes to NPM
157157

158158
# 5. Verify
159-
npm view ason
159+
npm view @ason-format/ason
160160
```
161161

162162
## Troubleshooting
163163

164164
### GitHub Action Fails
165165

166-
1. Check workflow logs: https://github.com/SeanLuis/ason/actions
166+
1. Check workflow logs: https://github.com/ason-format/ason/actions
167167
2. Common issues:
168168
- `NPM_TOKEN` not set in secrets
169169
- Tests failing
@@ -210,15 +210,15 @@ For beta versions:
210210
# package.json: "1.1.0-beta.1"
211211

212212
# Tag as pre-release
213-
git tag -a v1.1.0-beta.1 -m "Beta release"
214-
git push origin v1.1.0-beta.1
213+
git tag -a v1.0.0-beta.1 -m "Beta release"
214+
git push origin v1.0.0-beta.1
215215

216216
# On GitHub, mark as "pre-release"
217217
```
218218

219219
Install beta:
220220
```bash
221-
npm install ason@beta
221+
npm install @ason-format/ason@beta
222222
```
223223

224224
## References

docs/.DS_Store

0 Bytes
Binary file not shown.

docs/benchmarks.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<header class="border-b pb-4 mb-6">
1313
<h1 class="text-xl font-semibold mb-1">Benchmarks</h1>
1414
<p class="text-sm text-gray-600">ASON vs Toon vs JSON</p>
15-
<nav class="mt-3 flex gap-2">
15+
<nav class="mt-3 flex flex-wrap gap-2">
1616
<a
1717
href="index.html"
1818
class="inline-flex items-center gap-1.5 px-3 py-1.5 text-sm border rounded-md hover:bg-gray-50"
@@ -30,7 +30,7 @@ <h1 class="text-xl font-semibold mb-1">Benchmarks</h1>
3030
</nav>
3131
</header>
3232

33-
<div class="grid grid-cols-3 gap-4 mb-6">
33+
<div class="grid grid-cols-1 sm:grid-cols-3 gap-4 mb-6">
3434
<div class="border rounded-lg p-3">
3535
<div class="text-xs text-gray-600 mb-1">Victories</div>
3636
<div class="text-2xl font-semibold" id="victoriesText">

docs/docs.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ <h1 class="text-xl font-semibold mb-1">
4545
<p class="text-sm text-gray-600">
4646
Token-optimized JSON compression format for LLMs
4747
</p>
48-
<nav class="mt-3 flex gap-2">
48+
<nav class="mt-3 flex flex-wrap gap-2">
4949
<a
5050
href="index.html"
5151
class="inline-flex items-center gap-1.5 px-3 py-1.5 text-sm border rounded-md hover:bg-gray-50"
@@ -63,9 +63,9 @@ <h1 class="text-xl font-semibold mb-1">
6363
</nav>
6464
</header>
6565

66-
<div class="flex gap-8">
66+
<div class="flex flex-col md:flex-row gap-8">
6767
<!-- Sidebar Navigation -->
68-
<aside class="w-56 flex-shrink-0">
68+
<aside class="hidden md:block md:w-56 md:flex-shrink-0">
6969
<nav class="sticky top-6 space-y-1">
7070
<a
7171
href="#introduction"
@@ -527,7 +527,7 @@ <h2 class="text-2xl font-semibold mb-4">
527527
When to Use ASON
528528
</h2>
529529

530-
<div class="grid grid-cols-2 gap-6">
530+
<div class="grid grid-cols-1 md:grid-cols-2 gap-6">
531531
<div>
532532
<h3 class="font-semibold mb-3 text-sm">
533533
Ideal Cases

0 commit comments

Comments
 (0)