@k-l-lambda/lilylet 0.1.35 → 0.1.37

package/README.md

@@ -1,7 +1,37 @@
 # Lilylet
 
+![](./docs/live-demo.gif)
+
 Lilylet is a LilyPond-like music notation language designed for Markdown rendering and symbolic music representation in AIGC applications.
 
+## Hello World
+
+```lyl
+\key c \major \time 4/4 \clef "treble" c1 \bar "|."
+```
+![](./docs/hello-world.svg)
+
+
+## A Comprehensive Example
+
+```lyl
+[title "Jesu, meine Freude"]
+[subtitle "BWV 610"]
+[composer "J.S. Bach"]
+
+\staff "1" \key c \minor \time 4/4 \clef "treble" \stemUp g'4 g f ef \\
+\staff "1" \stemDown ef16[ d ef8]~ ef16[ f ef d] c8[ d]~ d[ c] \\
+\staff "2" \clef "bass" c16[ b c8]~ c16[ b c g] a8[ g]~ g16[ g af ef] \\
+\staff "3" \clef "bass" r8 c,16[ d] ef[ d ef8]~ ef16[ a, b g] c[ b c8] | % 1
+
+\staff "1" \stemUp d2 c\fermata \\
+\staff "1" \stemDown c8[ c4 b8] c8.[ \staff "2" \stemUp g16] \staff "1" c[ b c d] \\
+\staff "2" f,16[ ef f d] g[ af g f] ef[ d ef8]~ ef16[ f ef d] \\
+\staff "3" r16 g,[ af f] g[ f g8] c,2 | % 2
+```
+![](./docs/BWV610.svg)
+
+
 ## Try It Online
 
 - [Live Editor](https://k-l-lambda.github.io/lilylet-live-editor/) - Interactive editor with real-time music notation rendering
@@ -33,28 +63,3 @@ LilyPond is powerful but overly flexible—the same music can be written in mult
 - **Shorter context description**: Removes redundant information, allowing LLMs to process more music content within limited context windows
 - **Formatted layout**: Fixed syntax structure facilitates model learning and generation
 - **Markdown-embeddable**: Music snippets can be directly embedded in documents
-
-### Basic Syntax
-
-| Element | Syntax | Description |
-|---------|--------|-------------|
-| Staff | `\staff "1"` | Specifies which staff the current voice belongs to |
-| Key | `\key c \major` | C major |
-| Time | `\time 4/4` | 4/4 time signature |
-| Clef | `\clef "treble"` | Treble clef |
-| Notes | `c4 d8 e16` | C quarter note, D eighth note, E sixteenth note |
-| Accidentals | `cs` `cf` `css` `cff` | C sharp, C flat, C double-sharp, C double-flat |
-| Octave | `c'` `c,` | One octave higher, one octave lower |
-| Chord | `<c e g>4` | C major triad, quarter note |
-| Voice separator | `\\` | Separates multiple voices within the same staff |
-| Part separator | `\\\` | Separates different instrument tracks (parts) in a score |
-| Bar line | `\|` | Separates measures |
-
-## Syntax Example
-
-```lilylet
-\staff "1" \key e \major \time 2/4 \clef "treble" \stemUp e8 [ ds16 e16 ] fs4 ~ \\
-\staff "1" s4 \stemDown ds4 ~ \\
-\staff "2" \key e \major \clef "bass" \stemUp e,,4 b4 \\
-\staff "2" \stemDown e,,16 [ b'8 -> b16 ] b,16 [ b'8 -> b16 ] |
-```

package/lib/grammar.jison.js

@@ -150,7 +150,7 @@ case 25:
  this.$ = $$[$0-3].concat([part($$[$0])]); 
 break;
 case 26:
- currentStaff = 1; 
+ currentStaff = 1; currentOttava = 0; 
 break;
 case 27:
  this.$ = [voice(currentStaff, $$[$0])]; 
@@ -174,7 +174,16 @@ case 43:
 this.$ = markupEvent($$[$0].slice(1, -1));
 break;
 case 44:
-this.$ = ({ type: 'pitchReset' });
+
+		// On newline, reset ottava to 0 if it's non-zero (like pitch base resets)
+		if (currentOttava !== 0) {
+			const ottavaReset = contextChange({ ottava: 0 });
+			currentOttava = 0;
+			this.$ = [ottavaReset, { type: 'pitchReset' }];
+		} else {
+			this.$ = { type: 'pitchReset' };
+		}
+	
 break;
 case 45: case 46:
  currentDuration = $$[$0-1]; this.$ = noteEvent($$[$0-2], $$[$0-1], $$[$0]); 
@@ -299,13 +308,13 @@ case 85:
  currentStaff = Number($$[$0].slice(1, -1)); this.$ = currentStaff; 
 break;
 case 86:
-this.$ = Number($$[$0]);
+ currentOttava = Number($$[$0]); this.$ = currentOttava; 
 break;
 case 87:
-this.$ = -Number($$[$0]);
+ currentOttava = -Number($$[$0]); this.$ = currentOttava; 
 break;
 case 88:
-this.$ = 0;
+ currentOttava = 0; this.$ = 0; 
 break;
 case 89:
 this.$ = 'up';
@@ -737,6 +746,7 @@ parse: function parse(input) {
 	let currentTimeSig = null;
 	let currentDuration = { division: 4, dots: 0 }; // default quarter note
 	let numericTimeSignature = false; // When true, 4/4 and 2/2 use numeric display instead of C/C|
+	let currentOttava = 0; // Current ottava level, resets on newline
 
 	// Reset parser state - call before each parse
 	const resetParserState = () => {
@@ -745,6 +755,7 @@ parse: function parse(input) {
 		currentTimeSig = null;
 		currentDuration = { division: 4, dots: 0 };
 		numericTimeSignature = false;
+		currentOttava = 0;
 	};
 
 	// Export reset function

package/lib/index.d.ts

@@ -3,4 +3,5 @@ export * from "./parser";
 export * from "./serializer";
 import * as meiEncoder from "./meiEncoder";
 import * as musicXmlDecoder from "./musicXmlDecoder";
-export { meiEncoder, musicXmlDecoder, };
+import * as lilypondEncoder from "./lilypondEncoder";
+export { meiEncoder, musicXmlDecoder, lilypondEncoder, };

package/lib/index.js

@@ -3,4 +3,5 @@ export * from "./parser.js";
 export * from "./serializer.js";
 import * as meiEncoder from "./meiEncoder.js";
 import * as musicXmlDecoder from "./musicXmlDecoder.js";
-export { meiEncoder, musicXmlDecoder, };
+import * as lilypondEncoder from "./lilypondEncoder.js";
+export { meiEncoder, musicXmlDecoder, lilypondEncoder, };

package/lib/lilypondEncoder.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Lilylet to LilyPond Encoder
+ *
+ * Converts LilyletDoc to LilyPond (.ly) format.
+ * Uses relative pitch mode matching LilyPond's default behavior.
+ */
+import { LilyletDoc } from "./types";
+interface RenderOptions {
+    paper?: {
+        width?: number | string;
+        height?: number | string;
+    };
+    fontSize?: number;
+    withMIDI?: boolean;
+    autoBeaming?: boolean;
+}
+/**
+ * Encode a complete LilyletDoc to LilyPond format
+ */
+export declare const encode: (doc: LilyletDoc, options?: RenderOptions) => string;
+/**
+ * Encode LilyletDoc to minimal LilyPond (music content only, no headers)
+ */
+export declare const encodeMinimal: (doc: LilyletDoc) => string;
+declare const _default: {
+    encode: (doc: LilyletDoc, options?: RenderOptions) => string;
+    encodeMinimal: (doc: LilyletDoc) => string;
+};
+export default _default;