@voodocs/cli 2.3.0 → 2.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/CHANGELOG.md +37 -0
  2. package/README.md +86 -0
  3. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,42 @@
1
1
  # CHANGELOG
2
2
 
3
+ ## [2.4.0] - 2025-12-24
4
+
5
+ ### Added
6
+ - **VooDocs Lite Format** - Ultra-compact symbolic notation with 27-30% token reduction
7
+ - New `voodocs convert` command to convert between Standard and Lite formats
8
+ - Single-character symbols (`>`, `@`, `!`, `<`, `=`, `~`, `#`) instead of Unicode
9
+ - Aggressive abbreviation dictionary (70+ common terms)
10
+ - Article removal and symbol replacements for maximum compression
11
+ - Bidirectional conversion (Standard ↔ Lite) with zero semantic loss
12
+ - Support for `@darkarts-lite` annotation format
13
+ - **VooDocs Lite Parser** module (`lib/darkarts/voodocs_lite_parser.py`)
14
+ - `parse_lite()` - Parse Lite format annotations
15
+ - `parse_standard()` - Parse Standard format annotations
16
+ - `lite_to_standard()` - Convert Lite to Standard with expansion
17
+ - `standard_to_lite()` - Convert Standard to Lite with compression
18
+ - `detect_format()` - Auto-detect annotation format
19
+ - **Ultra-Aggressive Compression** (`lib/darkarts/voodocs_lite_dict_v2.py`)
20
+ - `ultra_compress()` - Maximum compression with article removal
21
+ - `ultra_expand()` - Expand compressed text to full form
22
+ - 70+ abbreviations for common terms
23
+ - Symbol replacements (and→&, or→|, >=, <=, etc.)
24
+ - **Comprehensive Test Suite** - 24 unit tests for VooDocs Lite functionality
25
+
26
+ ### Improved
27
+ - Token efficiency for AI context (+27-30% reduction)
28
+ - Scannability with single-character symbols
29
+ - Format flexibility (choose Standard or Lite based on needs)
30
+ - Backward compatibility (both formats supported)
31
+
32
+ ### Documentation
33
+ - Added VooDocs Lite section to README.md
34
+ - Added convert command documentation
35
+ - Added format comparison examples
36
+ - Added symbol mapping table
37
+
38
+ ---
39
+
3
40
  ## [2.3.0] - 2025-12-24
4
41
 
5
42
  ### Added
package/README.md CHANGED
@@ -91,6 +91,80 @@ def authenticate_user(user_id: str, password: str) -> Optional[str]:
91
91
 
92
92
  ---
93
93
 
94
+ ## VooDocs Lite: Ultra-Compact Format
95
+
96
+ **NEW in v2.4.0!** VooDocs Lite is an ultra-compact symbolic notation that reduces token count by **~30%** while maintaining all semantic information.
97
+
98
+ ### Why VooDocs Lite?
99
+
100
+ - **Token Efficient**: 27-30% fewer tokens for AI context
101
+ - **More Scannable**: Single-character symbols easier to read
102
+ - **Same Information**: Zero semantic loss
103
+ - **Bidirectional**: Convert between Standard and Lite freely
104
+
105
+ ### Format Comparison
106
+
107
+ **Standard VooDocs:**
108
+ ```typescript
109
+ /**@darkarts
110
+ ⊢{User authentication service with JWT token generation}
111
+ ∂{bcrypt, jsonwebtoken, database}
112
+ ⚠{Users must be stored in database}
113
+ ⊳{userId must be a valid UUID, password must be ≥8 characters}
114
+ ⊲{Returns JWT token ∨ null}
115
+ ⊨{Does ¬ modify database, Password is ¬ logged}
116
+ ⚡{O(1)}
117
+ 🔒{Password hashed with bcrypt, Token signed with secret}
118
+ */
119
+ ```
120
+ **114 tokens**
121
+
122
+ **VooDocs Lite:**
123
+ ```typescript
124
+ /**@darkarts-lite
125
+ >u auth svc w/ JWT tok gen
126
+ @bcrypt,jsonwebtoken,database
127
+ !us stored in db
128
+ <id valid UUID, pw>=8 characters
129
+ >ret JWT tok|N
130
+ =!mod db, pw !logged
131
+ ~O(1)
132
+ #pw hashed w/ bcrypt, tok signed w/ secret
133
+ */
134
+ ```
135
+ **83 tokens** (27% reduction)
136
+
137
+ ### Symbol Mapping
138
+
139
+ | Standard | Lite | Meaning |
140
+ |----------|------|----------|
141
+ | `⊢{}` | `>` | Purpose |
142
+ | `∂{}` | `@` | Dependencies |
143
+ | `⚠{}` | `!` | Assumptions |
144
+ | `⊳{}` | `<` | Preconditions |
145
+ | `⊲{}` | `>` | Postconditions |
146
+ | `⊨{}` | `=` | Invariants |
147
+ | `⚡{}` | `~` | Complexity |
148
+ | `🔒{}` | `#` | Security |
149
+
150
+ ### Convert Between Formats
151
+
152
+ ```bash
153
+ # Convert Standard to Lite
154
+ voodocs convert src/ --to lite -r
155
+
156
+ # Convert Lite to Standard
157
+ voodocs convert src/ --to standard -r
158
+
159
+ # Preview conversion
160
+ voodocs convert src/ --to lite --dry-run
161
+
162
+ # Modify files in-place
163
+ voodocs convert src/ --to lite --in-place
164
+ ```
165
+
166
+ ---
167
+
94
168
  ## Companion Files for Compiled Languages
95
169
 
96
170
  **NEW in v2.3.0!** For compiled languages like Solidity, Rust, or C++ where inline annotations may interfere with compilation, VooDocs supports **companion documentation files**.
@@ -262,6 +336,18 @@ voodocs companion contracts/ --dry-run # Preview changes
262
336
  voodocs companion contracts/ --force # Overwrite existing
263
337
  ```
264
338
 
339
+ ### `voodocs convert`
340
+
341
+ Convert between Standard and Lite VooDocs formats:
342
+
343
+ ```bash
344
+ voodocs convert src/ --to lite # Convert to Lite format
345
+ voodocs convert src/ --to standard # Convert to Standard format
346
+ voodocs convert src/ --to lite -r # Recursive conversion
347
+ voodocs convert src/ --to lite --dry-run # Preview changes
348
+ voodocs convert src/ --to lite --in-place # Modify files in-place
349
+ ```
350
+
265
351
  ### `voodocs generate`
266
352
 
267
353
  Generate documentation from annotations:
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@voodocs/cli",
3
- "version": "2.3.0",
3
+ "version": "2.4.0",
4
4
  "description": "AI-Native Symbolic Documentation System - The world's first documentation tool using mathematical notation with semantic validation",
5
5
  "main": "voodocs_cli.py",
6
6
  "bin": {