papagaio 0.2.3 → 0.2.7

package/README.md

@@ -13,10 +13,15 @@ const result = p.process(input);
 ## Configuration
 
 ```javascript
-p.open = "{";           // opening delimiter
-p.close = "}";          // closing delimiter
-p.sigil = "$";          // variable marker
-p.maxRecursion = 512;   // iteration limit
+p.symbols = {
+  pattern: "pattern",      // pattern keyword
+  context: "context",      // context keyword
+  open: "{",               // opening delimiter
+  close: "}",              // closing delimiter
+  sigil: "$"               // variable marker
+};
+p.recursion_limit = 512;   // iteration limit
+p.unique_id = 0;           // unique ID counter
 ```
 
 ---
@@ -52,17 +57,6 @@ Output: `hello & world` (both)
 
 `$$` = zero or more spaces/tabs/newlines.
 
-### 4. Literal Output (`$$`)
-
-```
-Price: $$50
-```
-Output: `Price: $50`
-
-Use `$$` for literal `$` output.
-
----
-
 ## Blocks
 
 Capture content between delimiters.
@@ -76,8 +70,8 @@ $block name {open}{close}
 ### Example
 
 ```
-pattern {$block content {(}{)}} {[$content]}
-data ( hello world )
+pattern {$name $block content {(}{)}} {[$content]}
+data (hello world)
 ```
 Output: `[hello world]`
 
@@ -152,15 +146,21 @@ Output:
 ## Special Keywords
 
 ### $unique
-Generate unique incremental IDs.
+Generate unique incremental IDs for each pattern call. All occurrences of `$unique` within the same pattern replacement share the same ID.
 
 ```
-pattern {item} {item_$unique}
+pattern {item} {[$unique]item_$unique}
 item
 item
 item
 ```
-Output: `item_u0`, `item_u1`, `item_u2`
+Output: `[0]item_0`, `[1]item_1`, `[2]item_2`
+
+```
+pattern {a} {$unique $unique}
+a
+```
+Output: `0 0` (same ID for both occurrences)
 
 ### $match
 Return the full match.
@@ -175,10 +175,9 @@ Output: `FOUND: [data]`
 Text before and after the match.
 
 ```
-pattern {$x} {BEFORE:$prefix | AFTER:$suffix}
-hello world test
+pattern {world} {$prefix$suffix}hello world test
 ```
-Output: `BEFORE: | AFTER: world test`
+Output: `hello hello  test test`
 
 ### $clear
 Remove everything before the match.
@@ -206,8 +205,8 @@ Output: `10`
 
 ```
 context {
-  pattern {# $t} {<h1>$t</h1>}
   pattern {## $t} {<h2>$t</h2>}
+  pattern {# $t} {<h1>$t</h1>}
   pattern {**$t**} {<strong>$t</strong>}
   pattern {*$t*} {<em>$t</em>}
   pattern {- $i} {<li>$i</li>}
@@ -281,6 +280,9 @@ Output:
 - Reuse: `$x` appears multiple times in replace
 - Undefined: becomes empty string
 
+### Sigil
+- You cannot match words containing the sigil character.
+
 ---
 
 ## Troubleshooting
@@ -290,29 +292,23 @@ Output:
 | Pattern doesn't match | Use `$$` between elements for flexible whitespace |
 | Variable not captured | Check space between variables |
 | Block not working | Verify balanced delimiters `{` `}` |
-| Infinite recursion | Use `$clear` or reduce `maxRecursion` |
+| Infinite recursion | Use `$clear` or reduce `recursion_limit` |
 | $eval not working | Errors return empty string, use try-catch |
 
----
-
-## Performance
+## Known Bugs
 
-- Simple patterns > complex patterns
-- Blocks have minor overhead
-- Avoid unlimited recursion
-- For large inputs, use multiple contexts
+- Multi-character block delimiters that contains double quotes doesnt match properly.
 
 ---
 
 ## Syntax Reference
 
 ```
-pattern {$x $y} {$y, $x}              # basic pattern
-pattern {$x$$y} {$x-$y}               # flexible whitespace
-pattern {$block n {o}{c}} {$n}        # block
+pattern {$x $y} {$y, $x}               # basic pattern
+pattern {$x$$y} {$x-$y}                # flexible whitespace
+pattern {$block n {o}{c}} {$n}         # block
 context { ... }                        # recursive scope
-$$literal                              # output literal $
-$unique                                # unique ID
+$unique                                # unique ID per pattern
 $match                                 # full match
 $prefix / $suffix                      # before/after
 $clear                                 # clear before
@@ -327,7 +323,6 @@ $eval{code}                            # execute JS
 context {
   # Markdown headers
   pattern {# $title} {<h1>$title</h1>}
-  pattern {## $title} {<h2>$title</h2>}
   
   # Lists
   pattern {- $item} {<li>$item</li>}
@@ -338,7 +333,7 @@ context {
   
   # Process content
   # Welcome
-  ## Getting Started
+  # Getting Started
   This is **important** and *italic*
   - First item
   - Second item

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "papagaio",
-  "version": "0.2.3",
+  "version": "0.2.7",
   "description": "easy yet powerful preprocessor",
   "main": "src/papagaio.js",
   "type": "module",