Merge pull request #69 from puzzmo-com/nested-tags

Adds nested tag support and small caps support

Author: orta

CHANGELOG.md

@@ -1,5 +1,14 @@
 This isn't a comprehensive doc because to our knowledge there are no OSS consumers of this lib, but for posterities sake here are the breaking changes:
 
+### 13.0.0
+
+- All formatting types (bold, italics, strike, underscore, subscript, superscript, link, color) now have a required `children` field containing parsed inner components. This enables nested markup like `{*{/bold italic/}*}` or `{*bold {/and italic/} text*}`.
+
+- The `text` field (index 1) still contains the raw content string for backwards compatibility. It has been marked as deprecated though.
+
+- The markup has switched from some regexes to a real parser.
+
+
 ### 12.3.0
 
 - Adds a CLI, see the README for examples of usage

CLAUDE.md

@@ -69,27 +69,51 @@ yarn dev  # Starts on http://localhost:5173
 
 ## XD Format Syntax
 
-Basic structure:
+Real example from `tests/output/alpha-bits.xd` (trimmed):
 
 ```
-Title: Example Puzzle
-Author: Jane Doe
+## Metadata
 
-[grid definition with letters/blanks]
+title: Alpha-Bits
+author: Drew Hodson
+copyright: © 2021
+description: N/A
 
-Across
-1. First clue
-2. Second clue
+## Grid
 
-Down
-1. First down clue
+AHAB..CUD.SERIF
+MADAM.ANY.ABODE
+PLANE.DIE.NOTON
+....TODO.EGO...
+
+## Clues
+
+A1. Captain of the Pequod ~ AHAB
+A5. Food for second chance chewing ~ CUD
+A8. Font feature ~ SERIF
+...
+D1. Pc. of concert gear ~ AMP
+D2. Conceal ~ HIDE
+D3. AAA's counterpart across the pond ~ RAC
+...
+
+## Notes
+
+## Design
+
+<style>O { background: circle }</style>
+
+O..O##O.O#.O..O
+.....#...#.....
+...
 ```
 
+Sections are separated by `## Headers`. Grid uses `.` for black squares, letters for fills. Clues use `A`/`D` prefixes with `~` separating clue from answer.
+
 Special features:
 
-- Rebus: `(OK)` in grid
-- Markup: `{/italic/}`, `{*bold*}`, `{&link|url&}`, `{!image|alt!}`
-- Metadata in curly braces: `{Notes: Some notes}`
+- Markup: `{/italic/}`, `{*bold*}`, `{&link|url&}`, `{!image|alt!}` and more
+
 
 ## Development Tips
 
@@ -98,3 +122,4 @@ Special features:
 - The website automatically rebuilds when packages change in dev mode
 - Check existing test fixtures in `tests/` directories for format examples
 - When writing tests prefer using fixtures instead of writing objects yourself which conform to the interface shapes
+- **Round-trip fidelity is a hard problem in this project.** The pipeline xd → AST → xd must produce the same document. New features should always include a full pipeline round-trip test to verify the output matches the original input

README.md

@@ -4441,7 +4441,9 @@ The key is that a line has to start with `<!--` and eventually the same or anoth
 
 #### Markup in Clues
 
-The [xd spec](https://github.com/century-arcade/xd/blob/master/doc/xd-format.md#clues-section-3) defines markup inside a clue as roughly being "markdown sigil's wrapped in `{` and `}`". We support this format, and will always fill out a key of `markup` which is an array of components. We also add support for links via this syntax: `{@text|url@}`.
+The [xd spec](https://github.com/century-arcade/xd/blob/master/doc/xd-format.md#clues-section-3) defines markup inside a clue as roughly being "markdown sigil's wrapped in `{` and `}`".
+
+We support this format, and will always fill out a key of `markup` which is an array of components. We also support nested tags.
 
 <!-- prettier-ignore -->
 ```md
@@ -4478,8 +4480,9 @@ Which will add the optional `"bodyMD"` to the clue:
 - Inline colours: `{#`<kbd>text</kbd>`|`<kbd>hex colour light</kbd>|<kbd>hex colour dark</kbd>`#}`
 - Subscript `{~`<kbd>words</kbd>`~}`
 - Superscript `{^`<kbd>words</kbd>`^}`
+- Small caps: `{=`<kbd>words</kbd>`=}`
 
-There is an exported `xdMarkupProcessor` which you can use to do your own markup processing if needed.
+There is an exported `xdMarkupProcessor` and `xdMarkupSerializer` which you can use to do your own markup processing if needed.
 
 #### Split character
 
@@ -4503,7 +4506,7 @@ We want to highlight that 'Comments', 'Split Characters', 'Schrödinger clues' a
 
 ### Aesthetics
 
-The xd spec is built for isplaying a large corpus of finished Crosswords, we use it for creation of new ones. This means we have a few extensions to the format to make it easier to write puzzles.
+The xd spec is built for displaying a large corpus of finished Crosswords, we use it for creation of new ones. This means we have a few extensions to the format to make it easier to write puzzles.
 
 - `## Design`