@k-l-lambda/lilylet 0.1.60 → 0.1.63

package/lib/lilylet/serializer.js

@@ -301,6 +301,10 @@ const serializeContextChange = (event) => {
     if (event.time) {
         parts.push('\\time ' + event.time.numerator + '/' + event.time.denominator);
     }
+    // Partial (pickup measure duration check)
+    if (event.partial) {
+        parts.push('\\partial ' + event.partial.division + '.'.repeat(event.partial.dots || 0));
+    }
     // Ottava
     if (event.ottava !== undefined) {
         if (event.ottava === 0) {
@@ -343,8 +347,11 @@ const serializeTempo = (tempo) => {
 const serializeTupletEvent = (event, env) => {
     const parts = [];
     let currentEnv = env;
-    // \times numerator/denominator { ... }
-    parts.push('\\times ' + event.ratio.numerator + '/' + event.ratio.denominator + ' {');
+    // \tuplet denominator/numerator { ... } for tuplet type, \times numerator/denominator for times type
+    const keyword = event.type === 'times'
+        ? '\\times ' + event.ratio.numerator + '/' + event.ratio.denominator
+        : '\\tuplet ' + event.ratio.denominator + '/' + event.ratio.numerator;
+    parts.push(keyword + ' {');
     let prevDuration;
     for (const e of event.events) {
         if (e.type === 'note') {
@@ -359,6 +366,20 @@ const serializeTupletEvent = (event, env) => {
             currentEnv = newEnv;
             prevDuration = e.duration;
         }
+        else if (e.type === 'context') {
+            const ctx = e;
+            if (ctx.staff != null) {
+                parts.push(' \\staff "' + ctx.staff + '"');
+            }
+            else if (ctx.stemDirection != null) {
+                if (ctx.stemDirection === StemDirection.up)
+                    parts.push(' \\stemUp');
+                else if (ctx.stemDirection === StemDirection.down)
+                    parts.push(' \\stemDown');
+                else if (ctx.stemDirection === StemDirection.auto)
+                    parts.push(' \\stemNeutral');
+            }
+        }
     }
     parts.push(' }');
     return { str: parts.join(''), newEnv: currentEnv };
@@ -428,6 +449,7 @@ const serializeEvent = (event, env, prevDuration) => {
         case 'context':
             return { str: serializeContextChange(event), newEnv: env };
         case 'tuplet':
+        case 'times':
             return serializeTupletEvent(event, env);
         case 'tremolo':
             return serializeTremoloEvent(event, env);
@@ -468,7 +490,7 @@ const serializeVoice = (voice, currentStaff, isGrandStaff = false, measureContex
     // before any music collapse to the last one (earlier ones are no-ops).
     // leadStaffScanEnd is the index of the first event that ends this scan —
     // context{staff} events before this index are skipped in the main loop.
-    const MUSICAL_TYPES = new Set(['note', 'rest', 'tuplet', 'tremolo']);
+    const MUSICAL_TYPES = new Set(['note', 'rest', 'tuplet', 'times', 'tremolo']);
     let effectiveInitialStaff = voice.staff;
     let leadStaffScanEnd = 0;
     for (let i = 0; i < voice.events.length; i++) {
@@ -607,6 +629,13 @@ const serializeVoice = (voice, currentStaff, isGrandStaff = false, measureContex
         else if (event.type === 'rest') {
             prevDuration = event.duration;
         }
+        else if (event.type === 'tuplet' || event.type === 'times') {
+            // After a tuplet/times block the LilyPond parser's "current duration" is the
+            // last note duration inside the tuplet, not the duration before the tuplet.
+            // Reset prevDuration so the first note after the block always emits its
+            // duration explicitly, avoiding wrong inheritance from inside the tuplet.
+            prevDuration = undefined;
+        }
         else if (event.type === 'context' && event.clef && emittedClefs) {
             const ctx = event;
             emittedClefs[ctx.staff || activeStaff] = ctx.clef;
@@ -667,7 +696,7 @@ const serializeMeasure = (measure, _isFirst, currentStaff, isGrandStaff = false,
             }
             staff = newStaff;
         }
-        parts.push(partStrs.join(' \\\\\\\\\n'));
+        parts.push(partStrs.join(' \\\\\\\n'));
     }
     return { str: parts.join(' '), newStaff: staff };
 };

package/lib/lilylet/types.d.ts

@@ -181,6 +181,7 @@ export interface ContextChange {
     type: 'context';
     key?: KeySignature;
     time?: Fraction;
+    partial?: Duration;
     clef?: Clef;
     ottava?: number;
     stemDirection?: StemDirection;
@@ -197,7 +198,12 @@ export interface TremoloEvent {
 export interface TupletEvent {
     type: 'tuplet';
     ratio: Fraction;
-    events: (NoteEvent | RestEvent)[];
+    events: (NoteEvent | RestEvent | ContextChange)[];
+}
+export interface TimesEvent {
+    type: 'times';
+    ratio: Fraction;
+    events: (NoteEvent | RestEvent | ContextChange)[];
 }
 export interface PitchResetEvent {
     type: 'pitchReset';
@@ -215,7 +221,7 @@ export interface MarkupEvent {
     content: string;
     placement?: Placement;
 }
-export type Event = NoteEvent | RestEvent | ContextChange | TremoloEvent | TupletEvent | PitchResetEvent | BarlineEvent | HarmonyEvent | MarkupEvent;
+export type Event = NoteEvent | RestEvent | ContextChange | TremoloEvent | TupletEvent | TimesEvent | PitchResetEvent | BarlineEvent | HarmonyEvent | MarkupEvent;
 export interface Voice {
     staff: number;
     events: Event[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@k-l-lambda/lilylet",
-  "version": "0.1.60",
+  "version": "0.1.63",
   "description": "Lilylet is a lilyopnd-like sheet music language designed for Markdown rendering and symbolic music representation in AIGC applications.",
   "type": "module",
   "main": "lib/index.js",
@@ -27,12 +27,18 @@
     "build": "tsc -p tsconfig.build.json && node tools/convertGrammarToESM.cjs && node tools/fixEsmExtensions.cjs",
     "build:grammar": "npx tsx ./tools/buildJisonParser.ts && node tools/convertGrammarToESM.cjs",
     "prepublishOnly": "npm run build:grammar && npm run build",
-    "test": "npx tsx ./tests/parser.ts",
-    "test:mei": "npx tsx ./tests/mei.ts",
-    "test:unit": "npx tsx ./tests/unit/encodePitch.test.ts",
-    "test:decoder": "npx tsx ./tests/lilypondDecoder.ts",
-    "test:abc": "npx tsx ./tests/abc-decoder.ts",
-    "ts": "npx tsx"
+    "test": "tsx ./tests/parser.ts",
+    "test:mei": "tsx ./tests/mei.ts",
+    "test:mei-hashes": "tsx ./tests/computeMeiHashes.ts",
+    "test:unit": "tsx ./tests/unit/encodePitch.test.ts",
+    "test:partial": "tsx ./tests/unit/partialWarning.test.ts",
+    "test:decoder": "tsx ./tests/lilypondDecoder.ts",
+    "test:abc": "tsx ./tests/abc-decoder.ts",
+    "test:roundtrip": "tsx ./tests/lilypond-roundtrip.ts",
+    "test:abc-svg": "tsx ./tests/abc-abcjs-svg.ts",
+    "build:tests": "tsc -p tsconfig.tests.json; cp source/lilylet/grammar.jison.js lib-tests/source/lilylet/ && cp source/abc/grammar.jison.js lib-tests/source/abc/ && node tools/fixEsmExtensions.cjs lib-tests && ln -sfn ../../tests/assets lib-tests/tests/assets",
+    "test:roundtrip:compiled": "node lib-tests/tests/lilypond-roundtrip.js",
+    "ts": "tsx"
   },
   "repository": {
     "type": "git",
@@ -47,13 +53,15 @@
   "devDependencies": {
     "@types/node": "^20.11.20",
     "@types/yargs": "^17.0.32",
+    "abcjs": "^6.6.2",
     "formidable": "^3.5.4",
     "jison": "^0.4.18",
+    "jsdom": "^29.0.2",
     "sha1": "^1.1.1",
     "ts-node": "^10.9.2",
+    "tsx": "^4.21.0",
     "typescript": "^5.3.3",
     "verovio": "^5.7.0",
-    "xmldom": "^0.6.0",
     "yargs": "^17.7.2"
   },
   "dependencies": {

package/source/abc/TODO.md

@@ -0,0 +1,97 @@
+# ABC Grammar TODO
+
+Issues found by comparing `abc.jison` against the abcjs parser implementation.
+
+---
+
+## High Priority
+
+### 1. Church modes in key signatures
+
+`key_mode` only distinguishes `major` / `minor`. The `NAME` fallback does a naive
+`startsWith("ma")` check, which mis-classifies all church modes:
+
+- Dorian (`Dor`, `dorian`)
+- Phrygian (`Phr`, `phrygian`)
+- Lydian (`Lyd`, `lydian`)
+- Mixolydian (`Mix`, `mixolydian`)
+- Aeolian (`Aeo`, `aeolian`)
+- Locrian (`Loc`, `locrian`)
+- Scottish bagpipe: `HP`, `Hp`
+
+These should be recognized as distinct modes rather than silently falling back to
+major or minor. The `abcDecoder.ts` key-mapping logic will also need updating to
+handle these modes.
+
+### 2. Bare-number Q: tempo (`Q:120`)
+
+`numeric_tempo` only matches `frac '=' number` (e.g. `Q:1/4=120`). Two common
+forms are not parsed:
+
+- `Q:120` — plain BPM number (unit inferred from the current meter/L: value)
+- `Q:"Allegro"` — text-only tempo marking
+- `Q:"Allegro" 1/4=120` — combined text + numeric form
+
+`Q:120` is the most frequently seen form in real-world ABC files.
+
+---
+
+## Medium Priority
+
+### 3. Missing rest type: `y` (spacer)
+
+The `rest_phonet` rule covers `z`, `Z`, `x` but not `y` (an invisible spacer rest
+used for spacing/layout). Files containing `y` currently cause a parse error.
+
+### 4. Volta ending bracket (`endEnding`)
+
+The `bar` rule appends the ending number directly to the bar token string
+(`'|' + N → "|1"`). There is no representation of the *closing* bracket of a
+first-ending, so `[1 ... [2` style repeat structures cannot be round-tripped.
+abcjs tracks `startEnding` / `endEnding` flags on bar elements; consider a
+similar approach.
+
+---
+
+## Low Priority
+
+### 5. `~` maps to `mordent` instead of `irishroll`
+
+`abc.jison` line 507: `'~' → articulation("mordent")`.  
+The standard ABC specification defines `~` as an *Irish roll* ornament, not a
+mordent. abcjs uses the name `irishroll`. The mordent is correctly represented by
+`M`. This is a semantic mismatch that may affect downstream rendering/export.
+
+### 6. Microtonal accidentals (`^/`, `_/`)
+
+The `accidentals` rule does not cover quarter-tone accidentals:
+
+- `^/` → quarter sharp
+- `_/` → quarter flat
+
+These are recognised by abcjs. Files using microtonal notation will silently drop
+the accidental.
+
+### 7. Short trill decoration `t`
+
+The single-letter `t` (half/short trill, `trillh` in abcjs) is not handled. The
+current `P`/`PP` lexer patterns only match uppercase ornament letters
+(`HJLMOPRSTuv`), so lowercase `t` falls through as an unknown token.
+
+### 8. Overlay voices (`&`)
+
+The `&` operator (alternative voice within a single bar, same staff) is not
+supported. abcjs resolves overlays into separate voices via `resolveOverlays()`.
+This is a moderately common pattern in two-voice piano or lute transcriptions.
+
+---
+
+## Out of Scope (noted for awareness)
+
+- **Lyrics** (`w:` / `W:` fields): not handled at the ABC grammar level; notes
+  have no `lyric` property. Would require grammar additions and decoder support.
+- **Extended clef types**: only `treble`, `bass`, `tenor` are recognised. abcjs
+  also handles `alto`, `baritone`, `mezzo`, `soprano`, `tab`, `perc`, etc.
+- **Decoration name aliases**: abcjs normalises `tr`→`trill`, `emphasis`→`accent`,
+  `marcato`→`umarcato`, `<`/`>`→`accent`. The lilylet grammar passes `NAME`
+  through as-is; the decoder would need to handle the aliases explicitly.

package/source/abc/abc.jison

@@ -82,18 +82,24 @@
 		const {patches} = body;
 		const measures = [];
 		let measure = null;
-		let lastVoice = 1;
+		const seenVoices = new Set();
+
 		patches.forEach(patch => {
 			const voice = patch.control.V || 1;
-			if (voice <= lastVoice) {
+			if (seenVoices.has(voice)) {
 				if (measure)
 					measures.push(measure);
 				measure = {voices: []};
+				seenVoices.clear();
 			}
+			if (!measure)
+				measure = {voices: []};
+			seenVoices.add(voice);
 			measure.voices.push(patch);
 		});
 
-		measures.push(measure);
+		if (measure)
+			measures.push(measure);
 
 		measures.forEach((measure, index) => measure.index = index + 1);
 
@@ -151,6 +157,21 @@
 
 
 	const octaveShift = shift => ({octaveShift: shift});
+
+
+	const parseMode = (name) => {
+		const n = name.toLowerCase();
+		if (n.startsWith("ma")) return "major";
+		if (n === "m" || n.startsWith("mi")) return "minor";
+		if (n.startsWith("dor")) return "dorian";
+		if (n.startsWith("phr")) return "phrygian";
+		if (n.startsWith("lyd")) return "lydian";
+		if (n.startsWith("mix")) return "mixolydian";
+		if (n.startsWith("aeo")) return "aeolian";
+		if (n.startsWith("loc")) return "locrian";
+		if (n === "hp") return "highland";
+		return n;
+	};
 %}
 
 
@@ -160,24 +181,27 @@
 
 %x string
 %x comment
+%x spec_comment_name
 %x spec_comment
+%x spec_comment_skip
 %x title_string
 %x key_signature
+%x voice_header
 %x exclamation_exp
 
-
 H									\b[A-Z](?=\:[^|])
-A									\b[A-G](?=[\W\d\sA-Ga-g_zHJLMOPRSTuv]*\b)
+A									\b[A-G](?=[\W\d\sA-Ga-g_yzHJLMOPRSTuv]*\b)
 Am									\b[A-G](?=[m][a][j]|[m][i][n]\b)
-a									\b[a-g](?=[\W\d\sA-Ga-g_zHJLMOPRSTuv]*\b)
+a									\b[a-g](?=[\W\d\sA-Ga-g_yzHJLMOPRSTuv]*\b)
 z									\b[z]
 Z									\b[Z]
 x									\b[x](?=[\W\d\s])
+y									\b[y]
 N									[0-9]
 P									\b[HJLMOPRSTuv](?=[A-Ga-g][A-Ga-g0-9]*\b)
 PP									\b[HJLMOPRSTuv](?=[xz!\[^_=\s"])
 
-SPECIAL								[:!^_,'/<>={}()\[\]|.\-+~]
+SPECIAL								[:!^_,'/<>={}()\[\]|.\-+~&]
 
 
 %%
@@ -193,10 +217,30 @@ SPECIAL								[:!^_,'/<>={}()\[\]|.\-+~]
 <title_string>[^\n]+				return 'STR_CONTENT'
 
 ^[K][:][\s]*						{ this.pushState('key_signature'); return 'K:'; }
+^[V][:][ \t]*						{ this.pushState('voice_header'); return 'V:'; }
+<voice_header>\"					{ this.pushState('string'); return 'STR_START'; }
+<voice_header>[a-zA-Z][a-zA-Z0-9,]*	return 'NAME';
+<voice_header>[0-9]+				return 'N';
+<voice_header>[=]					return '=';
+<voice_header>[+\-]					return yytext;
+<voice_header>[ \t]+				{}
+<voice_header>\n					{ this.popState(); }
+<voice_header>\]					{ this.popState(); return ']'; }
 <key_signature>"treble"				return 'TREBLE';
 <key_signature>"bass"				return 'BASS';
 <key_signature>"tenor"				return 'TENOR';
+<key_signature>"none"				return 'NAME';
+<key_signature>"Dor"				return 'NAME';
+<key_signature>"Phr"				return 'NAME';
+<key_signature>"Lyd"				return 'NAME';
+<key_signature>"Mix"				return 'NAME';
+<key_signature>"Aeo"				return 'NAME';
+<key_signature>"Loc"				return 'NAME';
+<key_signature>"HP"					return 'NAME';
+<key_signature>"Hp"					return 'NAME';
+<key_signature>[a-z]+[ \t]*=[^\n\]]*	{}
 <key_signature>[A-G]				return 'A';
+<key_signature>[A-Z][a-z]+			return 'NAME';
 <key_signature>[b]					return 'FLAT';
 <key_signature>[#]					return 'SHARP';
 <key_signature>[m][a-z]*			return 'NAME';
@@ -208,14 +252,20 @@ SPECIAL								[:!^_,'/<>={}()\[\]|.\-+~]
 <key_signature>\]					{ this.popState(); return ']'; }
 
 ^[%]								{ this.pushState('comment'); }
-<comment>[%]						{ this.pushState('spec_comment'); }
+<comment>[%]						{ this.pushState('spec_comment_name'); }
 <comment>[^\n]+						{ return 'COMMENT'; }
-<spec_comment>\n					{ this.popState(); this.popState(); }
 <comment>\n							{ this.popState(); }
-<spec_comment>\s					{}
-<spec_comment>"score"				return 'SCORE'
-<spec_comment>[\w]+					return 'NN'
+<spec_comment_name>[ \t]+			{}
+<spec_comment_name>"score"			{ this.popState(); this.pushState('spec_comment'); return 'SCORE'; }
+<spec_comment_name>"staves"			{ this.popState(); this.pushState('spec_comment'); return 'SCORE'; }
+<spec_comment_name>[\w]+			{ this.popState(); this.pushState('spec_comment_skip'); }
+<spec_comment_name>\n				{ this.popState(); this.popState(); }
+<spec_comment>[ \t]+				{}
 <spec_comment>[(){}\[\]|]			return yytext
+<spec_comment>[\w]+					return 'NN'
+<spec_comment>\n					{ this.popState(); this.popState(); return 'LAYOUT_END'; }
+<spec_comment_skip>[^\n]+			{}
+<spec_comment_skip>\n				{ this.popState(); this.popState(); }
 
 [!]									{ this.pushState('exclamation_exp'); return '!'; }
 <exclamation_exp>[!]				{ this.popState(); return '!'; }
@@ -231,6 +281,7 @@ SPECIAL								[:!^_,'/<>={}()\[\]|.\-+~]
 <exclamation_exp>{N}				return 'N'
 <exclamation_exp>[a-zA-Z][\w-]*		return 'NAME'
 
+\\\n								{}
 \s+									{}
 
 {SPECIAL}							return yytext
@@ -250,6 +301,7 @@ SPECIAL								[:!^_,'/<>={}()\[\]|.\-+~]
 "staff"								return 'STAFF'
 "maj"								return 'MAJ'
 "min"								return 'MIN'
+{y}									return 'y'
 [a-zA-Z][\w-]*						return 'NAME'
 
 <<EOF>>								return 'EOF'
@@ -284,6 +336,7 @@ head_lines
 	| head_lines head_line				-> [...$1, $2]
 	| head_lines comment				-> [...$1, $2]
 	| head_lines staff_layout_statement	-> [...$1, $2]
+	| head_lines 'LAYOUT_END'			-> $1
 	| head_lines ']'					-> $1
 	| head_lines '}'					-> $1
 	| head_lines ')'					-> $1
@@ -294,7 +347,7 @@ comment
 	;
 
 staff_layout_statement
-	: 'SCORE' staff_layout				-> $2
+	: 'SCORE' staff_layout 'LAYOUT_END'	-> $2
 	;
 
 staff_layout
@@ -320,6 +373,7 @@ head_line
 	: 'T:' string_content				-> header('T', $2)
 	| 'C:' string_content				-> header('C', $2)
 	| 'K:' key_signature				-> header('K', $2)
+	| 'V:' header_value					-> header('V', $2)
 	| H ':' header_value				-> header($1, $3)
 	;
 
@@ -328,6 +382,7 @@ header_value
 	| number
 	| frac
 	| numeric_tempo
+	| string frac '=' number			-> ({text: $1, note: $2, bpm: $4})
 	| upper_phonet
 	| voice_exp
 	| staff_shift
@@ -342,6 +397,11 @@ staff_shift
 	;
 
 key_signature
+	: key_root							-> $1
+	| NAME								-> key(null, $1)
+	;
+
+key_root
 	: A									-> key($1, null)
 	| A sharp_or_flat					-> key($1 + $2, null)
 	| A key_mode						-> key($1, $2)
@@ -362,7 +422,7 @@ sharp_or_flat
 key_mode
 	: MAJ								-> 'major'
 	| MIN								-> 'minor'
-	| NAME								-> $1.startsWith("ma") ? "major" : "minor"
+	| NAME								-> parseMode($1)
 	;
 
 plus_minus_number
@@ -402,6 +462,10 @@ voice_exp
 	| number NAME assigns				-> voice($1, $2, $3)
 	| NAME								-> voice(1, $1)
 	| NAME assigns						-> voice(1, $1, $2)
+	| upper_phonet number				-> voice(1, $1 + String($2))
+	| upper_phonet number assigns		-> voice(1, $1 + String($2), $3)
+	| upper_phonet number NAME			-> voice(1, $1 + String($2))
+	| upper_phonet number NAME assigns	-> voice(1, $1 + String($2), $4)
 	;
 
 assigns
@@ -418,6 +482,7 @@ assign_value
 	| number
 	| plus_minus_number
 	| NAME
+	| upper_phonet
 	;
 
 upper_phonet
@@ -437,6 +502,9 @@ patches
 	| patches tailless_patch			-> [...$1, $2]
 	| patches ']'						-> $1
 	| patches '}'						-> $1
+	| patches head_line					-> $1
+	| patches 'LAYOUT_END'				-> $1
+	| patches '&' patch					-> $1
 	;
 
 patch
@@ -459,10 +527,11 @@ bar
 	| ':' '|' ']'						-> ':|]'
 	| '|' N								-> '|' + $2
 	| ':' '|' N							-> ':|' + $2
+	| '&'								-> '&'
 	;
 
 music
-	: %empty
+	: %empty							-> []
 	| music expressive_mark				-> $1 ? [...$1, $2] : [$2]
 	| music text						-> $1 ? [...$1, $2] : [$2]
 	| music event						-> $1 ? [...$1, $2] : [$2]
@@ -474,11 +543,13 @@ music
 	| music NAME						-> $1
 	| music '^' NAME					-> $1
 	| music '^'							-> $1
+	| music '[' N						-> $1
 	;
 
 control
 	: '[' H ':' header_value ']'		-> ({control: header($2, $4)})
 	| '[' 'K:' header_value ']'			-> ({control: header("K", $3)})
+	| '[' 'V:' header_value ']'			-> ({control: header("V", $3)})
 	| '[' NAME ':' header_value ']'		-> ({control: header($2, $4)})
 	;
 
@@ -510,6 +581,7 @@ articulation
 articulation_content
 	: scope_articulation				-> articulation($1)
 	| scope_articulation parenthese		-> articulation($1, $2)
+	| scope_articulation '=' assign_value	-> articulation($1 + '=' + String($3))
 	| DYNAMIC							-> articulation($1)
 	| a									-> articulation($1)
 	| "^"								-> articulation($1)
@@ -613,6 +685,8 @@ accidentals
 	| '^' '^'							-> 2
 	| '_' '_'							-> -2
 	| '=' '='							-> 0
+	| '^' '/'							-> 0.5
+	| '_' '/'							-> -0.5
 	;
 
 pitch
@@ -637,6 +711,7 @@ rest_phonet
 	: z
 	| Z
 	| x
+	| y
 	;
 
 event